tamaya-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ple...@apache.org
Subject incubator-tamaya git commit: TAMAYA-60 Wrote more JavaDoc.
Date Wed, 11 Mar 2015 05:36:24 GMT
Repository: incubator-tamaya
Updated Branches:
  refs/heads/master 5e598cb96 -> 39e623dac


TAMAYA-60 Wrote more JavaDoc.


Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/39e623da
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/39e623da
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/39e623da

Branch: refs/heads/master
Commit: 39e623dacb0e6b9ac35d63709fa96839ab27c5e2
Parents: 5e598cb
Author: Oliver B. Fischer <plexus@apache.org>
Authored: Wed Mar 11 06:36:10 2015 +0100
Committer: Oliver B. Fischer <plexus@apache.org>
Committed: Wed Mar 11 06:36:10 2015 +0100

----------------------------------------------------------------------
 .../modules/builder/ConfigurationBuilder.java   | 92 ++++++++++++++------
 1 file changed, 66 insertions(+), 26 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/39e623da/modules/builder/src/main/java/org/apache/tamaya/modules/builder/ConfigurationBuilder.java
----------------------------------------------------------------------
diff --git a/modules/builder/src/main/java/org/apache/tamaya/modules/builder/ConfigurationBuilder.java
b/modules/builder/src/main/java/org/apache/tamaya/modules/builder/ConfigurationBuilder.java
index ce26aad..945eb2f 100644
--- a/modules/builder/src/main/java/org/apache/tamaya/modules/builder/ConfigurationBuilder.java
+++ b/modules/builder/src/main/java/org/apache/tamaya/modules/builder/ConfigurationBuilder.java
@@ -45,23 +45,6 @@ import java.util.stream.Stream;
 
 import static java.lang.String.format;
 
-/* TODO LIST FOR TAMAYA-60
- *
- * - configurable loading of provided PropertyConverter DONE
- * - configurable loading of provided PropertySources DONE
- * - configurable loading of provided PropertySourceProviders DONE
- * - configurable loading of provided PropertyFilters DONE
- * - I can not overhand null in varargs
- * - Rethink the default behaviour for SPI loading
- * - Work on all TODOs for TAMAYA-60
- * - Write JavaDoc
- * - adding sources via URL DONE
- *
- *
- *
- *
- */
-
 /**
  * <p>Builder class used for building a configuration manually without relying
  * only on the Service Provider Interface API.</p>
@@ -112,6 +95,11 @@ public class ConfigurationBuilder {
 
     private boolean isLoadProvidedPropertyFilters = false;
 
+    /**
+     * Creates a new builder instance.
+     */
+    public ConfigurationBuilder() {
+    }
 
     /**
      * Allows to set configuration context during unit tests.
@@ -280,15 +268,31 @@ public class ConfigurationBuilder {
     }
 
     /**
+     * Adds one or more property filter instances to the configuration to be build.
+     *
+     * <pre>{@code PropertyFilter quoteReplacingFilter = new QuoteFilter();
+     * PropertyFilter commaRemovingFilter = new CommaFilter();
+     *
+     * builder.addPropertyFilters(commaRemovingFilter, quoteReplacingFilter)};
+     * </pre>
+     *
+     * @param filters list of property filter instances which should be applied
+     *                to the properties of the configuration to be build.
+     *
      * @return the builder instance currently used
+     *
+     * @see org.apache.tamaya.spi.PropertyFilter
+     * @see #disableProvidedPropertyFilters()
+     * @see #enabledProvidedPropertyFilters()
      */
-    public ConfigurationBuilder addPropertyFilters(PropertyFilter... propertyFilters){
-        Objects.requireNonNull(propertyFilters);
+    public ConfigurationBuilder addPropertyFilters(PropertyFilter... filters){
+        Objects.requireNonNull(filters);
 
-        contextBuilder.addPropertyFilters(propertyFilters);
+        contextBuilder.addPropertyFilters(filters);
         return this;
     }
 
+
     /**
      * @return the builder instance currently used
      */
@@ -298,13 +302,29 @@ public class ConfigurationBuilder {
     }
 
     /**
+     * Adds a property converter for the a given type to the configuration to
+     * be build.
+     *
+     * <pre>{@code PropertyConverter<MyType> converter = value -> new MyType(value,
42);
+     *
+     * builder.addPropertyConverter(MyType.class, converter}
+     * </pre>
+     *
+     * @param type the required target type the converter should be applied to
+     * @param converter the converter to be used to convert the string property
+     *                  to the given target type.
+     *
      * @return the builder instance currently used
+     *
+     * @see org.apache.tamaya.PropertyConverter
+     * @see #enableProvidedPropertyConverters()
+     * @see #disableProvidedPropertyConverters()
      */
-    public <T> ConfigurationBuilder addPropertyConverter(Class<T> type, PropertyConverter<T>
propertyConverter) {
+    public <T> ConfigurationBuilder addPropertyConverter(Class<T> type, PropertyConverter<T>
converter) {
         Objects.requireNonNull(type);
-        Objects.requireNonNull(propertyConverter);
+        Objects.requireNonNull(converter);
 
-        return addPropertyConverter(TypeLiteral.of(type), propertyConverter);
+        return addPropertyConverter(TypeLiteral.of(type), converter);
     }
 
     /**
@@ -318,7 +338,18 @@ public class ConfigurationBuilder {
         return this;
     }
 
-
+    /**
+     * Checks if the automatic loading of all {@link org.apache.tamaya.PropertyConverter
+     * PropertyConverter} service providers is enabled or disabled.
+     *
+     * @return {@code true} if the automatic loading is enabled,
+     *         otherwise {@code false}.
+     *
+     * @see #enableProvidedPropertyConverters()
+     * @see #disableProvidedPropertyConverters()
+     * @see #addPropertyConverter(Class, org.apache.tamaya.PropertyConverter)
+     * @see #addPropertyConverter(org.apache.tamaya.TypeLiteral, org.apache.tamaya.PropertyConverter)
+     */
     public boolean isPropertyConverterLoadingEnabled() {
         return loadProvidedPropertyConverters;
     }
@@ -331,6 +362,7 @@ public class ConfigurationBuilder {
      *
      * @see org.apache.tamaya.PropertyConverter
      * @see #disableProvidedPropertyConverters()
+     * @see #enableProvidedPropertyConverters()
      */
     public ConfigurationBuilder enableProvidedPropertyConverters() {
         checkBuilderState();
@@ -348,6 +380,7 @@ public class ConfigurationBuilder {
      *
      * @see org.apache.tamaya.PropertyConverter
      * @see #enableProvidedPropertyConverters()
+     * @see #addPropertyConverter(Class, org.apache.tamaya.PropertyConverter)
      */
     public ConfigurationBuilder disableProvidedPropertyConverters() {
         checkBuilderState();
@@ -392,15 +425,21 @@ public class ConfigurationBuilder {
      * PropertyFilter} service providers is enabled or disabled.
      *
      * @return {@code true} if the automatic loading is enabled,
-     * otherwise {@code false}.
+     *         otherwise {@code false}.
      */
     public boolean isPropertyFilterLoadingEnabled() {
         return isLoadProvidedPropertyFilters;
     }
 
-
     /**
+     * Enables the automatic loading of all {@link org.apache.tamaya.spi.PropertyFilter}
+     * service providers.
+     *
      * @return the builder instance currently used
+     *
+     * @see org.apache.tamaya.spi.PropertyFilter
+     * @see #disableProvidedPropertyFilters()
+     * @see #addPropertyFilters(org.apache.tamaya.spi.PropertyFilter...)
      */
     public ConfigurationBuilder enabledProvidedPropertyFilters() {
         checkBuilderState();
@@ -418,6 +457,7 @@ public class ConfigurationBuilder {
      *
      * @see org.apache.tamaya.spi.PropertyFilter
      * @see #enabledProvidedPropertyFilters()
+     * @see #addPropertyFilters(org.apache.tamaya.spi.PropertyFilter...)
      *
      * @return the builder instance currently used
      */


Mime
View raw message