incubator-tamaya git commit: TAMAYA-60 Wrote more JavaDoc.
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
Authored: Wed Mar 11 06:36:10 2015 +0100
Committer: Oliver B. Fischer
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
- *
- *
- *
- *
- */
-
/**
* Builder class used for building a configuration manually without relying
* only on the Service Provider Interface API.
@@ -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.
+ *
+ * {@code PropertyFilter quoteReplacingFilter = new QuoteFilter();
+ * PropertyFilter commaRemovingFilter = new CommaFilter();
+ *
+ * builder.addPropertyFilters(commaRemovingFilter, quoteReplacingFilter)};
+ *
+ *
+ * @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.
+ *
+ * {@code PropertyConverter converter = value -> new
MyType(value, 42);
+ *
+ * builder.addPropertyConverter(MyType.class, converter}
+ *
+ *
+ * @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 ConfigurationBuilder addPropertyConverter(Class type,
PropertyConverter propertyConverter) {
+public ConfigurationBuilder addPropertyConverter(Class type,
PropertyConverter converter) {
Objects.requireNonNull(type);
-Objects.requireNonNull(propertyConverter);
+Objects.requireNonNull(converter);
-re
incubator-tamaya git commit: TAMAYA-60 JavaDoc..
Repository: incubator-tamaya
Updated Branches:
refs/heads/master afdd6c8c0 -> 5e598cb96
TAMAYA-60 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/5e598cb9
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/5e598cb9
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/5e598cb9
Branch: refs/heads/master
Commit: 5e598cb9677dc9f1f31302512036ec4f678e3830
Parents: afdd6c8
Author: Oliver B. Fischer
Authored: Tue Mar 10 22:57:55 2015 +0100
Committer: Oliver B. Fischer
Committed: Tue Mar 10 22:57:55 2015 +0100
--
.../modules/builder/ConfigurationBuilder.java | 52 ++--
1 file changed, 49 insertions(+), 3 deletions(-)
--
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/5e598cb9/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 173117a..ce26aad 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
@@ -122,7 +122,23 @@ public class ConfigurationBuilder {
}
/**
+ * Adds one resources with properties in an arbitrary format
+ * to the configuration to be build.
+ *
+ * If a specific format is supported depends on the available
+ * {@link org.apache.tamaya.format.ConfigurationFormat}
implementations.
+ *
+ * {@code URL resource = new URL("file:/etc/service/config.json");
+ *
+ * builder.addPropertySources(resource);}
+ *
+ *
+ * @param url resource with properties for the the configuration to be
build.
+ *
* @return the builder instance currently used
+ *
+ * @see org.apache.tamaya.format.ConfigurationFormat
+ * @see org.apache.tamaya.format.ConfigurationFormats#getFormats()
*/
public ConfigurationBuilder addPropertySource(URL url) {
try {
@@ -325,7 +341,7 @@ public class ConfigurationBuilder {
}
/**
- * Disables the loading of all {@link org.apache.tamaya.PropertyConverter}
+ * Disables the automatic loading of all {@link
org.apache.tamaya.PropertyConverter}
* service providers.
*
* @return the builder instance currently used
@@ -343,7 +359,13 @@ public class ConfigurationBuilder {
/**
+ * Enables the automatic loading of all {@link
org.apache.tamaya.spi.PropertySource}
+ * service providers.
+ *
* @return the builder instance currently used
+ *
+ * @see org.apache.tamaya.spi.PropertySource
+ * @see #disableProvidedPropertySources()
*/
public ConfigurationBuilder enableProvidedPropertySources() {
checkBuilderState();
@@ -353,11 +375,25 @@ public class ConfigurationBuilder {
return this;
}
+/**
+ * Checks if the automatic loading of all {@link
org.apache.tamaya.spi.PropertySource
+ * PropertySource} service providers is enabled or disabled.
+ *
+ * @return {@code true} if the automatic loading is enabled,
+ * otherwise {@code false}.
+ */
public boolean isPropertySourcesLoadingEnabled() {
return loadProvidedPropertySources;
}
+/**
+ * Checks if the automatic loading of all {@link
org.apache.tamaya.spi.PropertyFilter
+ * PropertyFilter} service providers is enabled or disabled.
+ *
+ * @return {@code true} if the automatic loading is enabled,
+ * otherwise {@code false}.
+ */
public boolean isPropertyFilterLoadingEnabled() {
return isLoadProvidedPropertyFilters;
}
@@ -375,7 +411,7 @@ public class ConfigurationBuilder {
}
/**
- * Disables the loading of all {@link org.apache.tamaya.spi.PropertyFilter}
+ * Disables the automatic loading of all {@link
org.apache.tamaya.spi.PropertyFilter}
* service providers.
*
* @return the builder instance currently used
@@ -394,7 +430,13 @@ public class ConfigurationBuilder {
}
/**
+ * Disables the automatic loading of all {@link
org.apache.tamaya.spi.PropertySource}
+ * service providers.
+ *
* @return the builder instance currently used
+ *
+ * @see org.apache.tamaya.spi.PropertySource
+ * @see #enableProvidedPropertySources()
*/
public ConfigurationBuilder disableProvidedPropertySources() {
checkBuilderState();
@@ -405,9 +447,13 @@ public class ConfigurationBuilder {
}
/**
- *
+ * Enabl
[1/2] incubator-tamaya git commit: TAMAYA-60 Worked on the JavaDoc...
Repository: incubator-tamaya
Updated Branches:
refs/heads/master 0d83a6fe8 -> afdd6c8c0
TAMAYA-60 Worked on the 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/72e119e7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/72e119e7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/72e119e7
Branch: refs/heads/master
Commit: 72e119e72f1ee230c33517c5467050fd71a14604
Parents: 0d83a6f
Author: Oliver B. Fischer
Authored: Mon Mar 9 07:53:57 2015 +0100
Committer: Oliver B. Fischer
Committed: Mon Mar 9 07:53:57 2015 +0100
--
.../modules/builder/ConfigurationBuilder.java | 51
1 file changed, 51 insertions(+)
--
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/72e119e7/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 01180d0..cd55a27 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
@@ -121,6 +121,9 @@ public class ConfigurationBuilder {
return this;
}
+/**
+ * @return the builder instance currently used
+ */
public ConfigurationBuilder addPropertySource(URL url) {
try {
ConfigurationData data = getConfigurationDataFromURL(url);
@@ -179,6 +182,9 @@ public class ConfigurationBuilder {
return this;
}
+/**
+ * @return the builder instance currently used
+ */
public ConfigurationBuilder addPropertySource(String url, String... urls) {
Stream.of(Collections.singletonList(url), Arrays.asList(urls))
.flatMap(Collection::stream)
@@ -190,6 +196,9 @@ public class ConfigurationBuilder {
return this;
}
+/**
+ * @return the builder instance currently used
+ */
public ConfigurationBuilder addPropertySources(PropertySource... sources){
checkBuilderState();
@@ -203,11 +212,17 @@ public class ConfigurationBuilder {
}
}
+/**
+ * @return the builder instance currently used
+ */
public ConfigurationBuilder
addPropertySourceProviders(PropertySourceProvider... propertySourceProviders){
contextBuilder.addPropertySourceProviders(propertySourceProviders);
return this;
}
+/**
+ * @return the builder instance currently used
+ */
public ConfigurationBuilder addPropertyFilters(PropertyFilter...
propertyFilters){
Objects.requireNonNull(propertyFilters);
@@ -215,11 +230,17 @@ public class ConfigurationBuilder {
return this;
}
+/**
+ * @return the builder instance currently used
+ */
public ConfigurationBuilder
setPropertyValueCombinationPolicy(PropertyValueCombinationPolicy
propertyValueCombinationPolicy){
contextBuilder.setPropertyValueCombinationPolicy(propertyValueCombinationPolicy);
return this;
}
+/**
+ * @return the builder instance currently used
+ */
public ConfigurationBuilder addPropertyConverter(Class type,
PropertyConverter propertyConverter) {
Objects.requireNonNull(type);
Objects.requireNonNull(propertyConverter);
@@ -227,6 +248,9 @@ public class ConfigurationBuilder {
return addPropertyConverter(TypeLiteral.of(type), propertyConverter);
}
+/**
+ * @return the builder instance currently used
+ */
public ConfigurationBuilder addPropertyConverter(TypeLiteral type,
PropertyConverter propertyConverter){
Objects.requireNonNull(type);
Objects.requireNonNull(propertyConverter);
@@ -244,6 +268,8 @@ public class ConfigurationBuilder {
* Enables the loading of all {@link org.apache.tamaya.PropertyConverter}
* service providers.
*
+ * @return the builder instance currently used
+ *
* @see org.apache.tamaya.PropertyConverter
* @see #disableProvidedPropertyConverters()
*/
@@ -259,6 +285,8 @@ public class ConfigurationBuilder {
* Disables the loading of all {@link org.apache.tamaya.PropertyConverter}
* service providers.
*
+ * @return the builder instance currently used
+ *
* @see org.apache.tamaya.PropertyConverter
* @see #enableProvidedPropertyConverters()
*/
@@ -271,6 +299,9 @@ public class ConfigurationBuilder {
}
+/**
+ * @return the builder instance currently used
+ */
pub
[2/2] incubator-tamaya git commit: TAMAYA-60 JavaDoc...
TAMAYA-60 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/afdd6c8c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/afdd6c8c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/afdd6c8c
Branch: refs/heads/master
Commit: afdd6c8c06651e611a9364c4162f84509246a0ba
Parents: 72e119e
Author: Oliver B. Fischer
Authored: Tue Mar 10 22:43:39 2015 +0100
Committer: Oliver B. Fischer
Committed: Tue Mar 10 22:43:39 2015 +0100
--
.../modules/builder/ConfigurationBuilder.java | 63 ++--
1 file changed, 57 insertions(+), 6 deletions(-)
--
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/afdd6c8c/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 cd55a27..173117a 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
@@ -157,16 +157,16 @@ public class ConfigurationBuilder {
* If a specific format is supported depends on the available
* {@link org.apache.tamaya.format.ConfigurationFormat}
implementations.
*
- *
- * URL first = new URL("file:/etc/service/config.json");
- * URL second = new URL(file:/etc/defaults/values.properties");
+ *{@code URL first = new URL("file:/etc/service/config.json");
+ * URL second = new URL("file:/etc/defaults/values.properties");
*
- * builder.addPropertySources(first, second);
+ * builder.addPropertySources(first, second);}
*
*
* @param url first resource with properties for the the configuration to
be build.
* @param urls list additional of resources with properties for the
configuration to be
* build.
+ *
* @return the builder instance currently used
*
* @see org.apache.tamaya.format.ConfigurationFormat
@@ -182,8 +182,26 @@ public class ConfigurationBuilder {
return this;
}
+
/**
+ * Adds one or more resources with properties in an arbitrary format
+ * to the configuration to be build.
+ *
+ * If a specific format is supported depends on the available
+ * {@link org.apache.tamaya.format.ConfigurationFormat}
implementations.
+ *
+ *{@code builder.addPropertySources("file:/etc/service/config.json",
+ *"file:/etc/defaults/values.properties");}
+ *
+ *
+ * @param url first resource with properties for the the configuration to
be build.
+ * @param urls list additional of resources with properties for the
configuration to be
+ * build.
+ *
* @return the builder instance currently used
+ *
+ * @see org.apache.tamaya.format.ConfigurationFormat
+ * @see org.apache.tamaya.format.ConfigurationFormats#getFormats()
*/
public ConfigurationBuilder addPropertySource(String url, String... urls) {
Stream.of(Collections.singletonList(url), Arrays.asList(urls))
@@ -197,7 +215,20 @@ public class ConfigurationBuilder {
}
/**
+ * Adds one or more property source instances to the configuration to be
build.
+ *
+ *{@code PropertySource first = new CustomPropertySource();
+ * PropertySource second = new YetAnotherPropertySource();
+ *
+ * builder.addPropertySources(first, second)};
+ *
+ *
+ * @param sources list of property source instances with properties for the
+ *configuration to be build.
+ *
* @return the builder instance currently used
+ *
+ * @see org.apache.tamaya.spi.PropertySource
*/
public ConfigurationBuilder addPropertySources(PropertySource... sources){
checkBuilderState();
@@ -213,10 +244,22 @@ public class ConfigurationBuilder {
}
/**
+ * Adds one or more property source provider instances to the
configuration to be build.
+ *
+ * {@code PropertySourceProvider jc = new JavaConfigurationProvider();
+ *
+ * builder.addPropertySources(jc)};
+ *
+ *
+ * @param providers list of property source provider instances each
providing a set
+ * of property source instances for the configuration to
be build.
+ *
* @return the builder instance currently used
+ *
+ * @see org.apache.tamaya.spi.PropertySourceProvider
*/
-public ConfigurationBuilder
addPropertySourceProviders(PropertySou
