Repository: incubator-tamaya Updated Branches: refs/heads/configjsr cde3cc8e9 -> c16650180
Fixed javadocs. Signed-off-by: Anatole Tresch <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/c1665018 Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/c1665018 Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/c1665018 Branch: refs/heads/configjsr Commit: c166501804019655946bf87ed08d222cd491e0d3 Parents: cde3cc8 Author: Anatole Tresch <[email protected]> Authored: Thu Apr 19 23:38:47 2018 +0200 Committer: Anatole Tresch <[email protected]> Committed: Thu Apr 19 23:38:47 2018 +0200 ---------------------------------------------------------------------- .../tamaya/base/PriorityServiceComparator.java | 2 +- .../java/org/apache/tamaya/ConfigQuery.java | 4 +- .../apache/tamaya/ConfigurationProvider.java | 4 +- .../apache/tamaya/spi/ConfigurationBuilder.java | 14 +++--- .../java/org/apache/tamaya/spi/TypeLiteral.java | 2 +- .../spisupport/DefaultConfigValueEvaluator.java | 2 +- .../spisupport/DefaultConfigurationBuilder.java | 2 +- .../spisupport/DefaultConfigurationContext.java | 2 +- .../tamaya/spisupport/PropertyFiltering.java | 4 +- .../propertysource/MapPropertySource.java | 4 +- .../java/org/apache/tamaya/ConfigOperator.java | 6 +-- .../java/org/apache/tamaya/Configuration.java | 6 +-- .../apache/tamaya/spi/ConfigurationBuilder.java | 30 ++++++------- .../apache/tamaya/spi/ConfigurationContext.java | 46 ++++++++++---------- .../tamaya/core/internal/CoreConfiguration.java | 2 + .../core/internal/CoreConfigurationBuilder.java | 1 + .../internal/converters/DoubleConverter.java | 4 ++ .../core/internal/converters/FileConverter.java | 2 +- .../internal/converters/FloatConverter.java | 6 ++- .../internal/converters/InstantConverter.java | 5 ++- .../internal/converters/LocalDateConverter.java | 5 ++- .../converters/LocalDateTimeConverter.java | 5 ++- .../internal/converters/LocalTimeConverter.java | 5 ++- .../converters/OffsetDateTimeConverter.java | 5 ++- .../converters/OffsetTimeConverter.java | 5 ++- .../internal/converters/OptionalConverter.java | 5 ++- .../core/internal/converters/PathConverter.java | 4 +- .../internal/converters/SupplierConverter.java | 5 ++- .../core/internal/converters/URLConverter.java | 4 +- .../tamaya/spisupport/ConfigValueEvaluator.java | 2 +- .../tamaya/spisupport/DefaultConfiguration.java | 12 ++--- .../DefaultConfigurationContextBuilder.java | 4 +- .../apache/tamaya/spisupport/EnumConverter.java | 2 +- .../spisupport/PropertyConverterManager.java | 22 +++++----- .../spisupport/PropertyFilterComparator.java | 2 +- .../spisupport/PropertySourceComparator.java | 6 +-- .../propertysource/BasePropertySource.java | 6 +-- .../propertysource/CLIPropertySource.java | 4 +- .../PropertiesResourcePropertySource.java | 3 +- .../propertysource/SimplePropertySource.java | 3 +- 40 files changed, 141 insertions(+), 116 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/base/src/main/java/org/apache/tamaya/base/PriorityServiceComparator.java ---------------------------------------------------------------------- diff --git a/code/base/src/main/java/org/apache/tamaya/base/PriorityServiceComparator.java b/code/base/src/main/java/org/apache/tamaya/base/PriorityServiceComparator.java index 37f5095..ebf0f4f 100644 --- a/code/base/src/main/java/org/apache/tamaya/base/PriorityServiceComparator.java +++ b/code/base/src/main/java/org/apache/tamaya/base/PriorityServiceComparator.java @@ -23,7 +23,7 @@ import java.io.Serializable; import java.util.Comparator; /** - * Comparator implementation for odering services loaded based on their increasing priority values. + * Comparator implementation for ordering services loaded based on their increasing priority values. */ public class PriorityServiceComparator implements Comparator<Object>, Serializable { http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/compat/src/main/java/org/apache/tamaya/ConfigQuery.java ---------------------------------------------------------------------- diff --git a/code/compat/src/main/java/org/apache/tamaya/ConfigQuery.java b/code/compat/src/main/java/org/apache/tamaya/ConfigQuery.java index 28b8b93..25ed2ec 100644 --- a/code/compat/src/main/java/org/apache/tamaya/ConfigQuery.java +++ b/code/compat/src/main/java/org/apache/tamaya/ConfigQuery.java @@ -27,8 +27,8 @@ package org.apache.tamaya; public interface ConfigQuery<T> { /** - * Creates a result based on the given Configuration. Queries basically acts similar to - * operators, whereas they returns any kind of result. + * Creates a result based on the given {@link Configuration}. Queries basically act similar to + * operators, whereas they return any kind of result. * * @param config the input configuration, not {@code null}. * @return the query result. http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/compat/src/main/java/org/apache/tamaya/ConfigurationProvider.java ---------------------------------------------------------------------- diff --git a/code/compat/src/main/java/org/apache/tamaya/ConfigurationProvider.java b/code/compat/src/main/java/org/apache/tamaya/ConfigurationProvider.java index d3bf0d2..d7b62f0 100644 --- a/code/compat/src/main/java/org/apache/tamaya/ConfigurationProvider.java +++ b/code/compat/src/main/java/org/apache/tamaya/ConfigurationProvider.java @@ -74,7 +74,7 @@ public final class ConfigurationProvider { } /** - * This method allows to replace the current {@link org.apache.tamaya.spi.ConfigurationContext} with a new + * This method allows replacement of the current {@link org.apache.tamaya.spi.ConfigurationContext} with a new * instance. This can be used to update the context with a new one, e.g. because some of the configuration * data has changed and should be updated. It is the responsibility of the ConfigurationProvider to trigger * corresponding update events for the current {@link org.apache.tamaya.Configuration}, so observing @@ -91,7 +91,7 @@ public final class ConfigurationProvider { } /** - * This method allows to replace the current default {@link org.apache.tamaya.Configuration} with a new + * This method allows replacement of the current default {@link org.apache.tamaya.Configuration} with a new * instance. It is the responsibility of the ConfigurationProvider to trigger * corresponding update events for the current {@link org.apache.tamaya.Configuration}, so observing * listeners can do whatever is appropriate to react to any given configuration change. http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/compat/src/main/java/org/apache/tamaya/spi/ConfigurationBuilder.java ---------------------------------------------------------------------- diff --git a/code/compat/src/main/java/org/apache/tamaya/spi/ConfigurationBuilder.java b/code/compat/src/main/java/org/apache/tamaya/spi/ConfigurationBuilder.java index d043229..8e38b75 100644 --- a/code/compat/src/main/java/org/apache/tamaya/spi/ConfigurationBuilder.java +++ b/code/compat/src/main/java/org/apache/tamaya/spi/ConfigurationBuilder.java @@ -72,7 +72,7 @@ public interface ConfigurationBuilder { * lowest priority regardless of its current ordinal value. To sort the property * sources based on their ordinals call {@link #sortPropertySources}. * - * @param propertySources the PropertySources to add + * @param propertySources the {@link PropertySource}s to add * @return this builder, for chaining, never null. * @throws IllegalArgumentException If a property source with a given name already * exists. @@ -192,7 +192,7 @@ public interface ConfigurationBuilder { ConfigurationBuilder lowestPriority(PropertySource propertySource); /** - * Adds the given PropertyFilter instances, hereby the instances are added + * Adds the given {@link PropertyFilter} instances, hereby the instances are added * to the end of the list with highest priority. The ordering of existing * property filters remains unchanged. To sort the property * filters call {@link #sortPropertyFilter}. @@ -203,7 +203,7 @@ public interface ConfigurationBuilder { ConfigurationBuilder addPropertyFilters(PropertyFilter... filters); /** - * Adds the given PropertyFilter instances, hereby the instances are added + * Adds the given {@link PropertyFilter} instances, hereby the instances are added * to the end of the list with highest priority. The ordering of existing * property filters remains unchanged. To sort the property * filters call {@link #sortPropertyFilter}. @@ -221,7 +221,7 @@ public interface ConfigurationBuilder { /** - * Removes the given PropertyFilter instances, if existing. The order of the remaining + * Removes the given {@link PropertyFilter} instances, if existing. The order of the remaining * filters is preserved. * * @param filters the filter to remove @@ -230,7 +230,7 @@ public interface ConfigurationBuilder { ConfigurationBuilder removePropertyFilters(PropertyFilter... filters); /** - * Removes the given PropertyFilter instances, if existing. The order of the remaining + * Removes the given {@link PropertyFilter} instances, if existing. The order of the remaining * filters is preserved. * * @param filters the filter to remove @@ -273,7 +273,7 @@ public interface ConfigurationBuilder { ConfigurationBuilder addDefaultPropertyConverters(); /** - * Removes the given PropertyConverter instances for the given type, + * Removes the given {@link PropertyConverter} instances for the given type, * if existing. * * @param typeToConvert the type which the converter is for @@ -285,7 +285,7 @@ public interface ConfigurationBuilder { @SuppressWarnings("unchecked") PropertyConverter<T>... propertyConverters); /** - * Removes the given PropertyConverter instances for the given type, + * Removes the given {@link PropertyConverter} instances for the given type, * if existing. * * @param typeToConvert the type which the converter is for http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/compat/src/main/java/org/apache/tamaya/spi/TypeLiteral.java ---------------------------------------------------------------------- diff --git a/code/compat/src/main/java/org/apache/tamaya/spi/TypeLiteral.java b/code/compat/src/main/java/org/apache/tamaya/spi/TypeLiteral.java index 489b467..a99d6e0 100644 --- a/code/compat/src/main/java/org/apache/tamaya/spi/TypeLiteral.java +++ b/code/compat/src/main/java/org/apache/tamaya/spi/TypeLiteral.java @@ -65,7 +65,7 @@ public class TypeLiteral<T> implements Serializable { /** * Creates a new TypeLiteral based on a given type. * - * @param type the type , not {@code null}. + * @param type the type, not {@code null}. * @param <R> the literal generic type. * @return the corresponding TypeLiteral, never {@code null}. */ http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigValueEvaluator.java ---------------------------------------------------------------------- diff --git a/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigValueEvaluator.java b/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigValueEvaluator.java index d50ed7d..38c6055 100644 --- a/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigValueEvaluator.java +++ b/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigValueEvaluator.java @@ -30,7 +30,7 @@ import java.util.Map; /** * Implementation of the Configuration API. This class uses the current {@link ConfigurationContext} to evaluate the * chain of {@link PropertySource} and {@link PropertyFilter} - * instance to evaluate the current Configuration. + * instances to evaluate the current Configuration. */ public class DefaultConfigValueEvaluator implements ConfigValueEvaluator{ http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationBuilder.java ---------------------------------------------------------------------- diff --git a/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationBuilder.java b/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationBuilder.java index 1b3f1ce..3d4b5be 100644 --- a/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationBuilder.java +++ b/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationBuilder.java @@ -207,7 +207,7 @@ public class DefaultConfigurationBuilder implements ConfigurationBuilder { /** * Builds a new configuration based on the configuration of this builder instance. * - * @return a new {@link org.apache.tamaya.Configuration configuration instance}, + * @return a new {@link org.apache.tamaya.Configuration} configuration instance, * never {@code null}. */ @Override http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationContext.java ---------------------------------------------------------------------- diff --git a/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationContext.java b/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationContext.java index ecb8894..57385be 100644 --- a/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationContext.java +++ b/code/compat/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationContext.java @@ -27,7 +27,7 @@ import java.util.concurrent.locks.ReentrantReadWriteLock; import java.util.logging.Logger; /** - * Default implementation of a simple ConfigurationContext. + * Default implementation of a simple {@link ConfigurationContext}. */ public class DefaultConfigurationContext implements ConfigurationContext { http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/compat/src/main/java/org/apache/tamaya/spisupport/PropertyFiltering.java ---------------------------------------------------------------------- diff --git a/code/compat/src/main/java/org/apache/tamaya/spisupport/PropertyFiltering.java b/code/compat/src/main/java/org/apache/tamaya/spisupport/PropertyFiltering.java index af69899..8747cee 100644 --- a/code/compat/src/main/java/org/apache/tamaya/spisupport/PropertyFiltering.java +++ b/code/compat/src/main/java/org/apache/tamaya/spisupport/PropertyFiltering.java @@ -31,7 +31,7 @@ import java.util.logging.Logger; /** * Implementation of the Configuration API. This class uses the current {@link ConfigurationContext} to evaluate the * chain of {@link org.apache.tamaya.spi.PropertySource} and {@link PropertyFilter} - * instance to evaluate the current Configuration. + * instances to evaluate the current Configuration. */ public final class PropertyFiltering{ /** @@ -63,7 +63,7 @@ public final class PropertyFiltering{ * Filters all properties. * @param rawProperties the unfiltered properties, not {@code null}. * @param context the context - * @return the filtered value, inclusing null. + * @return the filtered value, including {@code null}. */ public static Map<String, PropertyValue> applyFilters(Map<String, PropertyValue> rawProperties, ConfigurationContext context) { Map<String, PropertyValue> result = new HashMap<>(); http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/compat/src/main/java/org/apache/tamaya/spisupport/propertysource/MapPropertySource.java ---------------------------------------------------------------------- diff --git a/code/compat/src/main/java/org/apache/tamaya/spisupport/propertysource/MapPropertySource.java b/code/compat/src/main/java/org/apache/tamaya/spisupport/propertysource/MapPropertySource.java index 0cabb35..7d637bb 100644 --- a/code/compat/src/main/java/org/apache/tamaya/spisupport/propertysource/MapPropertySource.java +++ b/code/compat/src/main/java/org/apache/tamaya/spisupport/propertysource/MapPropertySource.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Properties; /** - * Simple PropertySource implementation that just takes a Map and an (optional) priority. + * Simple {@link org.apache.tamaya.spi.PropertySource} implementation that just takes a Map and an (optional) priority. * Optionally the entries passed can be mapped to a different rootContext. */ public class MapPropertySource extends BasePropertySource { @@ -81,7 +81,7 @@ public class MapPropertySource extends BasePropertySource { } /** - * Simple method to convert Properties into a Map instance. + * Simple method to convert {@link Properties} into a {@link Map} instance. * @param props the properties, not null. * @return the corresponding Map instance. */ http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/api/src/main/java/org/apache/tamaya/ConfigOperator.java ---------------------------------------------------------------------- diff --git a/code/old/api/src/main/java/org/apache/tamaya/ConfigOperator.java b/code/old/api/src/main/java/org/apache/tamaya/ConfigOperator.java index b14c155..52f97c1 100644 --- a/code/old/api/src/main/java/org/apache/tamaya/ConfigOperator.java +++ b/code/old/api/src/main/java/org/apache/tamaya/ConfigOperator.java @@ -20,15 +20,15 @@ package org.apache.tamaya; /** * Models a function that maps a given {@link org.apache.tamaya.Configuration} to another {@link org.apache.tamaya.Configuration}. This can be used - * to modell additional functionality and applying it to a given {@link org.apache.tamaya.Configuration} instance by calling + * to model additional functionality and applying it to a given {@link org.apache.tamaya.Configuration} instance by calling * the {@link org.apache.tamaya.Configuration#with(org.apache.tamaya.ConfigOperator)} method. */ @FunctionalInterface public interface ConfigOperator { /** - * Creates a new {@link org.apache.tamaya.Configuration} based on the given Configuration. Operators basically acts similar to - * decorators, whereas operated instances may have non compatible behaviour, e.g. by applying security constraints + * Creates a new {@link org.apache.tamaya.Configuration} based on the given Configuration. Operators basically act similar to + * decorators, whereas operated instances may have non-compatible behaviour, e.g. by applying security constraints * or view restrictions. * * @param config the input configuration, not {@code null}. http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/api/src/main/java/org/apache/tamaya/Configuration.java ---------------------------------------------------------------------- diff --git a/code/old/api/src/main/java/org/apache/tamaya/Configuration.java b/code/old/api/src/main/java/org/apache/tamaya/Configuration.java index b00eebd..5a8c895 100644 --- a/code/old/api/src/main/java/org/apache/tamaya/Configuration.java +++ b/code/old/api/src/main/java/org/apache/tamaya/Configuration.java @@ -35,7 +35,7 @@ import java.util.Map; * combination and overriding. * </p> * <h3>Implementation Requirements</h3> - * Implementations current this interface must be + * Implementations of this interface must be * <ul> * <li>Thread safe</li> * <li>Immutable</li> @@ -43,7 +43,7 @@ import java.util.Map; * * <p>It is not recommended that implementations also are serializable, since the any configuration can be <i>frozen</i> * by reading out its complete configuration map into a serializable and remotable structure. This helps significantly - * simplifying the development of this interface, e.g. for being backed up by systems and stores that are not part + * by simplifying the development of this interface, e.g. for being backed up by systems and stores that are not part of * this library at all.</p> */ public interface Configuration { @@ -169,7 +169,7 @@ public interface Configuration { ConfigurationContext getContext(); /** - * Create a new builder using this instance as it's base. + * Create a new builder using this instance as its base. * @return a new builder, never null. */ default ConfigurationBuilder toBuilder() { http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/api/src/main/java/org/apache/tamaya/spi/ConfigurationBuilder.java ---------------------------------------------------------------------- diff --git a/code/old/api/src/main/java/org/apache/tamaya/spi/ConfigurationBuilder.java b/code/old/api/src/main/java/org/apache/tamaya/spi/ConfigurationBuilder.java index 3511abe..ac4f686 100644 --- a/code/old/api/src/main/java/org/apache/tamaya/spi/ConfigurationBuilder.java +++ b/code/old/api/src/main/java/org/apache/tamaya/spi/ConfigurationBuilder.java @@ -72,7 +72,7 @@ public interface ConfigurationBuilder { * lowest priority regardless of its current ordinal value. To sort the property * sources based on their ordinals call {@link #sortPropertySources}. * - * @param propertySources the PropertySources to add + * @param propertySources the {@link PropertySource}s to add * @return this builder, for chaining, never null. * @throws IllegalArgumentException If a property source with a given name already * exists. @@ -85,7 +85,7 @@ public interface ConfigurationBuilder { * lowest priority regardless of its current ordinal value. To sort the property * sources based on their ordinals call {@link #sortPropertySources}. * - * @param propertySources the PropertySources to add + * @param propertySources the {@link PropertySource}s to add * @return this builder, for chaining, never null. * @throws IllegalArgumentException If a property source with a given name already * exists. @@ -192,7 +192,7 @@ public interface ConfigurationBuilder { ConfigurationBuilder lowestPriority(PropertySource propertySource); /** - * Adds the given PropertyFilter instances, hereby the instances are added + * Adds the given {@link PropertyFilter} instances, hereby the instances are added * to the end of the list with highest priority. The ordering of existing * property filters remains unchanged. To sort the property * filters call {@link #sortPropertyFilter}. @@ -203,7 +203,7 @@ public interface ConfigurationBuilder { ConfigurationBuilder addPropertyFilters(PropertyFilter... filters); /** - * Adds the given PropertyFilter instances, hereby the instances are added + * Adds the given {@link PropertyFilter} instances, hereby the instances are added * to the end of the list with highest priority. The ordering of existing * property filters remains unchanged. To sort the property * filters call {@link #sortPropertyFilter}. @@ -220,7 +220,7 @@ public interface ConfigurationBuilder { ConfigurationBuilder addDefaultPropertyFilters(); /** - * Removes the given PropertyFilter instances, if existing. The order of the remaining + * Removes the given {@link PropertyFilter} instances, if existing. The order of the remaining * filters is preserved. * * @param filters the filter to remove @@ -229,7 +229,7 @@ public interface ConfigurationBuilder { ConfigurationBuilder removePropertyFilters(PropertyFilter... filters); /** - * Removes the given PropertyFilter instances, if existing. The order of the remaining + * Removes the given {@link PropertyFilter} instances, if existing. The order of the remaining * filters is preserved. * * @param filters the filter to remove @@ -243,8 +243,8 @@ public interface ConfigurationBuilder { * For converters already registered for the current target type the * method has no effect. * - * @param typeToConvert the type for which the converter is for - * @param propertyConverters the PropertyConverters to add for this type + * @param typeToConvert the type for which the converter is used + * @param propertyConverters the {@link PropertyConverter}s to add for this type * @param <T> the target type. * @return this builder, for chaining, never null. */ @@ -257,7 +257,7 @@ public interface ConfigurationBuilder { * For converters already registered for the current target type the * method has no effect. * - * @param typeToConvert the type for which the converter is for + * @param typeToConvert the type for which the converter is used * @param propertyConverters the PropertyConverters to add for this type * @param <T> the target type. * @return this builder, for chaining, never null. @@ -272,10 +272,10 @@ public interface ConfigurationBuilder { ConfigurationBuilder addDefaultPropertyConverters(); /** - * Removes the given PropertyConverter instances for the given type, + * Removes the given {@link PropertyConverter} instances for the given type, * if existing. * - * @param typeToConvert the type which the converter is for + * @param typeToConvert the type which the converter is used * @param propertyConverters the converter to remove * @param <T> the target type. * @return this builder, for chaining, never null. @@ -287,7 +287,7 @@ public interface ConfigurationBuilder { * Removes the given PropertyConverter instances for the given type, * if existing. * - * @param typeToConvert the type which the converter is for + * @param typeToConvert the type which the converter is used * @param propertyConverters the converter to remove * @param <T> the target type. * @return this builder, for chaining, never null. @@ -299,7 +299,7 @@ public interface ConfigurationBuilder { * Removes all converters for the given type, which actually renders a given type * unsupported for type conversion. * - * @param typeToConvert the type which the converter is for + * @param typeToConvert the type which the converter is used * @return this builder, for chaining, never null. */ ConfigurationBuilder removePropertyConverters(TypeLiteral<?> typeToConvert); @@ -307,7 +307,7 @@ public interface ConfigurationBuilder { /** * Sorts the current registered property sources using the given comparator. * - * NOTE: property sources at the beginning have minimal significance. + * <p>NOTE: property sources at the beginning have minimal significance. * * @param comparator the comparator to be used, not {@code null}. * @return this instance for chaining. @@ -317,7 +317,7 @@ public interface ConfigurationBuilder { /** * Sorts the current registered property filters using the given comparator. * - * NOTE: property filters at the beginning have minimal significance. + * <p>NOTE: property filters at the beginning have minimal significance. * * @param comparator the comparator to be used, not {@code null}. * @return this instance for chaining. http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/api/src/main/java/org/apache/tamaya/spi/ConfigurationContext.java ---------------------------------------------------------------------- diff --git a/code/old/api/src/main/java/org/apache/tamaya/spi/ConfigurationContext.java b/code/old/api/src/main/java/org/apache/tamaya/spi/ConfigurationContext.java index f077a1d..448a9d1 100644 --- a/code/old/api/src/main/java/org/apache/tamaya/spi/ConfigurationContext.java +++ b/code/old/api/src/main/java/org/apache/tamaya/spi/ConfigurationContext.java @@ -26,7 +26,7 @@ import java.util.Map; /** * Central SPI for programmatically dealing with the setup of the configuration system. - * This includes adding and enlisting {@link org.apache.tamaya.spi.PropertySource}s, + * This includes adding and enlisting {@link PropertySource}s, * managing {@link PropertyConverter}s, ConfigFilters, etc. */ public interface ConfigurationContext { @@ -35,7 +35,7 @@ public interface ConfigurationContext { * This method can be used for programmatically adding {@link PropertySource}s. * It is not needed for normal 'usage' by end users, but only for Extension Developers! * - * @param propertySources the PropertySources to add + * @param propertySources the {@link PropertySource}s to add * @deprecated Use {@link ConfigurationContextBuilder} to create a new {@link ConfigurationContext}. * @see #toBuilder() */ @@ -43,16 +43,16 @@ public interface ConfigurationContext { void addPropertySources(PropertySource... propertySources); /** - * This method returns the current list of registered PropertySources ordered via their ordinal. - * PropertySources with a lower ordinal come last. The PropertySource with the + * This method returns the current list of registered {@link PropertySource}s ordered via their ordinal. + * {@link PropertySource}s with a lower ordinal come last. The {@link PropertySource} with the * highest ordinal comes first. - * If two PropertySources have the same ordinal number they will get sorted + * If two {@link PropertySource}s have the same ordinal number they will get sorted * using their class name just to ensure the user at least gets the same ordering * after a JVM restart, hereby names before are added last. - * PropertySources are loaded when this method is called the first time, which basically is + * {@link PropertySource}s are loaded when this method is called the first time, which basically is * when the first time configuration is accessed. * - * @return a sorted list of registered PropertySources. The returned list need not be modifiable + * @return a sorted list of registered {@link PropertySource}s. The returned list need not be modifiable */ List<PropertySource> getPropertySources(); @@ -79,10 +79,10 @@ public interface ConfigurationContext { /** * <p> - * This method returns the Map of registered PropertyConverters + * This method returns the Map of registered {@link PropertyConverter}s * per type. * The List for each type is ordered via their {@link javax.annotation.Priority} and - * cladd name. + * class name. * </p> * * <p>A simplified scenario could be like:</p> @@ -94,27 +94,27 @@ public interface ConfigurationContext { * } * </pre> * - * @return map with sorted list of registered PropertySources per type. + * @return map with sorted list of registered {@link PropertySource}s per type. */ Map<TypeLiteral<?>, List<PropertyConverter<?>>> getPropertyConverters(); /** * <p> - * This method returns the registered PropertyConverters for a given type. + * This method returns the registered {@link PropertyConverter}s for a given type. * The List for each type is ordered via their {@link javax.annotation.Priority}. * </p> * * <p> - * PropertyConverters with a higher Priority come first. The PropertyConverter with the - * lowest Priority comes last. - * If two PropertyConverter have the same ordinal number they will get sorted + * {@link PropertyConverter}s with a higher {@link javax.annotation.Priority} come first. + * The {@link PropertyConverter} with the lowest {@link javax.annotation.Priority} comes last. + * If two {@link PropertyConverter}s have the same ordinal number they will get sorted * using their class name just to ensure the user at least gets the same ordering * after a JVM restart. * </p> * * <p> - * Additionally if a PropertyProvider is accessed, which is not registered the implementation - * should try to figure out, if there could be a default implementation as follows:</p> + * Additionally, if a PropertyProvider is accessed which is not registered, the implementation + * should try to figure out if there could be a default implementation as follows:</p> * <ol> * <li>Look for static factory methods: {@code of(String), valueOf(String), getInstance(String), * instanceOf(String), fomr(String)}</li> @@ -123,7 +123,7 @@ public interface ConfigurationContext { * * <p> * If a correspoding factory method or constructor could be found, a corresponding - * PropertyConverter should be created and registered automatically for the given + * {@link PropertyConverter} should be created and registered automatically for the given * type. * </p> * @@ -140,26 +140,26 @@ public interface ConfigurationContext { * <p> * The converters returned for a type should be used as a chain, whereas the result of the * first converters that is able to convert the configured value, is taken as the chain's result. - * No more converters are called after a converters has successfully converted the input into + * No more converters are called after a converter has successfully converted the input into * the required target type. * </p> * * @param <T> the type of the type literal * @param type type of the desired converters - * @return a sorted list of registered PropertySources per type. + * @return a sorted list of registered {@link PropertySource}s per type. */ <T> List<PropertyConverter<T>> getPropertyConverters(TypeLiteral<T> type); /** - * Access the current PropertyFilter instances. - * @return the list of registered PropertyFilters, never null. + * Access the current {@link PropertyFilter} instances. + * @return the list of registered {@link PropertyFilter}s, never null. */ List<PropertyFilter> getPropertyFilters(); /** - * Access the {@link org.apache.tamaya.spi.PropertyValueCombinationPolicy} used to evaluate the final + * Access the {@link PropertyValueCombinationPolicy} used to evaluate the final * property values. - * @return the {@link org.apache.tamaya.spi.PropertyValueCombinationPolicy} used, never null. + * @return the {@link PropertyValueCombinationPolicy} used, never null. */ PropertyValueCombinationPolicy getPropertyValueCombinationPolicy(); http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/CoreConfiguration.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/CoreConfiguration.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/CoreConfiguration.java index 5363b76..cb692e9 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/CoreConfiguration.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/CoreConfiguration.java @@ -31,6 +31,8 @@ public final class CoreConfiguration extends DefaultConfiguration { /** * Creates a new builder instance. + * + * @param context The configuration Context to be used. */ public CoreConfiguration(ConfigurationContext context) { super(context); http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/CoreConfigurationBuilder.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/CoreConfigurationBuilder.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/CoreConfigurationBuilder.java index 61f9f4e..c15736d 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/CoreConfigurationBuilder.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/CoreConfigurationBuilder.java @@ -47,6 +47,7 @@ public final class CoreConfigurationBuilder extends DefaultConfigurationBuilder /** * Creates a new builder instance. + * @param config the configuration to be used, not null. */ public CoreConfigurationBuilder(Configuration config) { super(config); http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/DoubleConverter.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/DoubleConverter.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/DoubleConverter.java index e527756..e6a4d24 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/DoubleConverter.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/DoubleConverter.java @@ -34,6 +34,10 @@ import java.util.logging.Logger; * <li>NaN (ignoring case)</li> * <li>POSITIVE_INFINITY (ignoring case)</li> * <li>NEGATIVE_INFINITY (ignoring case)</li> + * <li>MIN_VALUE (ignoring case)</li> + * <li>MIN (ignoring case)</li> + * <li>MAX_VALUE (ignoring case)</li> + * <li>MAX (ignoring case)</li> * </ul> */ @Component(service = PropertyConverter.class) http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/FileConverter.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/FileConverter.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/FileConverter.java index e9891be..e95c16a 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/FileConverter.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/FileConverter.java @@ -28,7 +28,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Converter, converting from String to URI, using new URL(value). + * Converter, converting from String to File, using new File(value). */ @Component(service = PropertyConverter.class) public class FileConverter implements PropertyConverter<File> { http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/FloatConverter.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/FloatConverter.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/FloatConverter.java index 84daa10..f1c520e 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/FloatConverter.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/FloatConverter.java @@ -34,6 +34,10 @@ import java.util.logging.Logger; * <li>NaN (ignoring case)</li> * <li>POSITIVE_INFINITY (ignoring case)</li> * <li>NEGATIVE_INFINITY (ignoring case)</li> + * <li>MIN_VALUE (ignoring case)</li> + * <li>MIN (ignoring case)</li> + * <li>MAX_VALUE (ignoring case)</li> + * <li>MAX (ignoring case)</li> * </ul> */ @Component(service = PropertyConverter.class) @@ -83,7 +87,7 @@ public class FloatConverter implements PropertyConverter<Float> { @Override public boolean equals(Object o){ - return getClass().equals(o.getClass()); + return Objects.nonNull(o) && getClass().equals(o.getClass()); } @Override http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/InstantConverter.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/InstantConverter.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/InstantConverter.java index 4198b72..588fddf 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/InstantConverter.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/InstantConverter.java @@ -23,11 +23,12 @@ import org.apache.tamaya.spi.PropertyConverter; import org.osgi.service.component.annotations.Component; import java.time.Instant; +import java.util.Objects; import java.util.logging.Level; import java.util.logging.Logger; /** - * Converter, converting from String to Boolean. + * Converter, converting from String to Instant. */ @Component(service = PropertyConverter.class) public class InstantConverter implements PropertyConverter<Instant> { @@ -47,7 +48,7 @@ public class InstantConverter implements PropertyConverter<Instant> { @Override public boolean equals(Object o){ - return getClass().equals(o.getClass()); + return Objects.nonNull(o) && getClass().equals(o.getClass()); } @Override http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalDateConverter.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalDateConverter.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalDateConverter.java index 3bf9b67..4335a4a 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalDateConverter.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalDateConverter.java @@ -23,11 +23,12 @@ import org.apache.tamaya.spi.PropertyConverter; import org.osgi.service.component.annotations.Component; import java.time.LocalDate; +import java.util.Objects; import java.util.logging.Level; import java.util.logging.Logger; /** - * Converter, converting from String to Boolean. + * Converter, converting from String to LocalDate. */ @Component(service = PropertyConverter.class) public class LocalDateConverter implements PropertyConverter<LocalDate> { @@ -47,7 +48,7 @@ public class LocalDateConverter implements PropertyConverter<LocalDate> { @Override public boolean equals(Object o){ - return getClass().equals(o.getClass()); + return Objects.nonNull(o) && getClass().equals(o.getClass()); } @Override http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalDateTimeConverter.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalDateTimeConverter.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalDateTimeConverter.java index eb14000..cedc121 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalDateTimeConverter.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalDateTimeConverter.java @@ -23,11 +23,12 @@ import org.apache.tamaya.spi.PropertyConverter; import org.osgi.service.component.annotations.Component; import java.time.LocalDateTime; +import java.util.Objects; import java.util.logging.Level; import java.util.logging.Logger; /** - * Converter, converting from String to Boolean. + * Converter, converting from String to LocalDateTime. */ @Component(service = PropertyConverter.class) public class LocalDateTimeConverter implements PropertyConverter<LocalDateTime> { @@ -47,7 +48,7 @@ public class LocalDateTimeConverter implements PropertyConverter<LocalDateTime> @Override public boolean equals(Object o){ - return getClass().equals(o.getClass()); + return Objects.nonNull(o) && getClass().equals(o.getClass()); } @Override http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalTimeConverter.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalTimeConverter.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalTimeConverter.java index bf7d8ab..af9ad3e 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalTimeConverter.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/LocalTimeConverter.java @@ -23,11 +23,12 @@ import org.apache.tamaya.spi.PropertyConverter; import org.osgi.service.component.annotations.Component; import java.time.LocalTime; +import java.util.Objects; import java.util.logging.Level; import java.util.logging.Logger; /** - * Converter, converting from String to Boolean. + * Converter, converting from String to LocalTime. */ @Component(service = PropertyConverter.class) public class LocalTimeConverter implements PropertyConverter<LocalTime> { @@ -47,7 +48,7 @@ public class LocalTimeConverter implements PropertyConverter<LocalTime> { @Override public boolean equals(Object o){ - return getClass().equals(o.getClass()); + return Objects.nonNull(o) && getClass().equals(o.getClass()); } @Override http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OffsetDateTimeConverter.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OffsetDateTimeConverter.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OffsetDateTimeConverter.java index 062d584..a0d6d7b 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OffsetDateTimeConverter.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OffsetDateTimeConverter.java @@ -23,11 +23,12 @@ import org.apache.tamaya.spi.PropertyConverter; import org.osgi.service.component.annotations.Component; import java.time.OffsetDateTime; +import java.util.Objects; import java.util.logging.Level; import java.util.logging.Logger; /** - * Converter, converting from String to Boolean. + * Converter, converting from String to OffsetDateTime. */ @Component(service = PropertyConverter.class) public class OffsetDateTimeConverter implements PropertyConverter<OffsetDateTime> { @@ -47,7 +48,7 @@ public class OffsetDateTimeConverter implements PropertyConverter<OffsetDateTime @Override public boolean equals(Object o){ - return getClass().equals(o.getClass()); + return Objects.nonNull(o) && getClass().equals(o.getClass()); } @Override http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OffsetTimeConverter.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OffsetTimeConverter.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OffsetTimeConverter.java index 794ad8a..e0e3276 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OffsetTimeConverter.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OffsetTimeConverter.java @@ -23,11 +23,12 @@ import org.apache.tamaya.spi.PropertyConverter; import org.osgi.service.component.annotations.Component; import java.time.OffsetTime; +import java.util.Objects; import java.util.logging.Level; import java.util.logging.Logger; /** - * Converter, converting from String to Boolean. + * Converter, converting from String to OffsetTime. */ @Component(service = PropertyConverter.class) public class OffsetTimeConverter implements PropertyConverter<OffsetTime> { @@ -47,7 +48,7 @@ public class OffsetTimeConverter implements PropertyConverter<OffsetTime> { @Override public boolean equals(Object o){ - return getClass().equals(o.getClass()); + return Objects.nonNull(o) && getClass().equals(o.getClass()); } @Override http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OptionalConverter.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OptionalConverter.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OptionalConverter.java index 2fd4b47..bdb5809 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OptionalConverter.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/OptionalConverter.java @@ -26,10 +26,11 @@ import org.osgi.service.component.annotations.Component; import java.lang.reflect.ParameterizedType; import java.lang.reflect.Type; +import java.util.Objects; import java.util.Optional; /** - * Converter, converting from String to Boolean. + * Converter, converting from String to Optional. */ @Component(service = PropertyConverter.class) public class OptionalConverter implements PropertyConverter<Optional> { @@ -54,7 +55,7 @@ public class OptionalConverter implements PropertyConverter<Optional> { @Override public boolean equals(Object o){ - return getClass().equals(o.getClass()); + return Objects.nonNull(o) && getClass().equals(o.getClass()); } @Override http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/PathConverter.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/PathConverter.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/PathConverter.java index 404daee..579067a 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/PathConverter.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/PathConverter.java @@ -29,7 +29,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Converter, converting from String to URI, using new URL(value). + * Converter, converting from String to Path, using FileSystem.getPath(value). */ @Component(service = PropertyConverter.class) public class PathConverter implements PropertyConverter<Path> { @@ -53,7 +53,7 @@ public class PathConverter implements PropertyConverter<Path> { @Override public boolean equals(Object o){ - return getClass().equals(o.getClass()); + return Objects.nonNull(o) && getClass().equals(o.getClass()); } @Override http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/SupplierConverter.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/SupplierConverter.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/SupplierConverter.java index 6d00322..3f45de9 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/SupplierConverter.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/SupplierConverter.java @@ -26,11 +26,12 @@ import org.osgi.service.component.annotations.Component; import java.lang.reflect.ParameterizedType; import java.lang.reflect.Type; +import java.util.Objects; import java.util.function.Supplier; import java.util.logging.Logger; /** - * Converter, converting from String to Boolean. + * Converter, converting from String to Supplier. */ @Component(service = PropertyConverter.class) public class SupplierConverter implements PropertyConverter<Supplier> { @@ -60,7 +61,7 @@ public class SupplierConverter implements PropertyConverter<Supplier> { @Override public boolean equals(Object o){ - return getClass().equals(o.getClass()); + return Objects.nonNull(o) && getClass().equals(o.getClass()); } @Override http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/URLConverter.java ---------------------------------------------------------------------- diff --git a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/URLConverter.java b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/URLConverter.java index e1994bf..6050c4b 100644 --- a/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/URLConverter.java +++ b/code/old/core/src/main/java/org/apache/tamaya/core/internal/converters/URLConverter.java @@ -28,7 +28,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Converter, converting from String to URI, using new URL(value). + * Converter, converting from String to URL, using new URL(value). */ @Component(service = PropertyConverter.class) public class URLConverter implements PropertyConverter<URL> { @@ -52,7 +52,7 @@ public class URLConverter implements PropertyConverter<URL> { @Override public boolean equals(Object o){ - return getClass().equals(o.getClass()); + return Objects.nonNull(o) && getClass().equals(o.getClass()); } @Override http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/ConfigValueEvaluator.java ---------------------------------------------------------------------- diff --git a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/ConfigValueEvaluator.java b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/ConfigValueEvaluator.java index 92fd614..b0a4069 100644 --- a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/ConfigValueEvaluator.java +++ b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/ConfigValueEvaluator.java @@ -25,7 +25,7 @@ import java.util.Map; /** - * Component SPI which encapsulates the evaluation of a single or full <b>raw</b>value + * Component SPI which encapsulates the evaluation of a single or full <b>raw</b> value * for a {@link ConfigurationContext}. */ public interface ConfigValueEvaluator { http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/DefaultConfiguration.java ---------------------------------------------------------------------- diff --git a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/DefaultConfiguration.java b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/DefaultConfiguration.java index fbcf35f..b6f979a 100644 --- a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/DefaultConfiguration.java +++ b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/DefaultConfiguration.java @@ -43,7 +43,7 @@ import java.util.logging.Logger; /** * Implementation of the Configuration API. This class uses the current {@link ConfigurationContext} to evaluate the * chain of {@link PropertySource} and {@link org.apache.tamaya.spi.PropertyFilter} - * instance to evaluate the current Configuration. + * instances to evaluate the current Configuration. */ public class DefaultConfiguration implements Configuration { /** @@ -105,7 +105,7 @@ public class DefaultConfiguration implements Configuration { } /** - * Evaluates the raw value using the context's PropertyValueCombinationPolicy. + * Evaluates the raw value using the context's {@link PropertyValueCombinationPolicy}. * @param key the key, not null. * @return the value, before filtering is applied. */ @@ -172,7 +172,7 @@ public class DefaultConfiguration implements Configuration { * using the {@link PropertyConverter} instances provided by the current * {@link ConfigurationContext}. * - * @param key the property's absolute, or relative path, e.g. @code + * @param key the property's absolute, or relative path, e.g. {@code * a/b/c/d.myProperty}, never {@code null}. * @param type The target type required, not {@code null}. * @param <T> the value type @@ -188,11 +188,11 @@ public class DefaultConfiguration implements Configuration { * using the {@link PropertyConverter} instances provided by the current * {@link ConfigurationContext}. * - * @param key the property's absolute, or relative path, e.g. @code + * @param key the property's absolute, or relative path, e.g. {@code * a/b/c/d.myProperty}. - * @param type The target type required, not null. + * @param type The target type required, not {@code null}. * @param <T> the value type - * @return the converted value, never null. + * @return the converted value, never {@code null}. */ @Override public <T> T get(String key, TypeLiteral<T> type) { http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationContextBuilder.java ---------------------------------------------------------------------- diff --git a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationContextBuilder.java b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationContextBuilder.java index 079527f..80a434d 100644 --- a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationContextBuilder.java +++ b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/DefaultConfigurationContextBuilder.java @@ -77,6 +77,8 @@ public class DefaultConfigurationContextBuilder implements ConfigurationContextB /** * Allows to reset configuration context during unit tests. + * @param configurationContext the context to be used, not null. + * @return the builder for chaining */ public final ConfigurationContextBuilder resetWithConfigurationContext(ConfigurationContext configurationContext) { checkBuilderState(); @@ -397,7 +399,7 @@ public class DefaultConfigurationContextBuilder implements ConfigurationContextB /** * Builds a new configuration based on the configuration of this builder instance. * - * @return a new {@link org.apache.tamaya.Configuration configuration instance}, + * @return a new {@link org.apache.tamaya.Configuration} configuration instance, * never {@code null}. */ @Override http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/EnumConverter.java ---------------------------------------------------------------------- diff --git a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/EnumConverter.java b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/EnumConverter.java index ed5214a..01499d4 100644 --- a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/EnumConverter.java +++ b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/EnumConverter.java @@ -31,7 +31,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Converter, converting from String to tge given enum type. + * Converter, converting from String to the given enum type. */ @Component(service = PropertyConverter.class) public class EnumConverter<T> implements PropertyConverter<T> { http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertyConverterManager.java ---------------------------------------------------------------------- diff --git a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertyConverterManager.java b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertyConverterManager.java index 921cac6..38d5f97 100644 --- a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertyConverterManager.java +++ b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertyConverterManager.java @@ -168,7 +168,7 @@ public class PropertyConverterManager { * Allows to evaluate if a given target type is supported. * * @param targetType the target type, not {@code null}. - * @return true, if a converters for the given type is registered, or a default one can be created. + * @return true, if a converter for the given type is registered or a default one can be created. */ public boolean isTargetTypeSupported(TypeLiteral<?> targetType) { return converters.containsKey(targetType) || transitiveConverters.containsKey(targetType) || createDefaultPropertyConverter(targetType) != null; @@ -194,23 +194,25 @@ public class PropertyConverterManager { /** * Get the list of all current registered converters for the given target type. - * If not converters are registered, they component tries to create and register a dynamic + * + * <p> + * If no converters are registered, the component tries to create and register dynamic * converters based on String constructor or static factory methods available. * The converters provided are of the following type and returned in the following order: * <ul> * <li>Converters mapped explicitly to the required target type are returned first, ordered * by decreasing priority. This means, if explicit converters are registered these are used * primarily for converting a value.</li> - * <li>The target type of each explicitly registered converters also can be transitively mapped to + * <li>The target type of each explicitly registered converter can also be transitively mapped to * 1) all directly implemented interfaces, 2) all its superclasses (except Object), 3) all the interfaces - * implemented by its superclasses. These groups of transitive converters is returned similarly in the - * order as mentioned, whereas also here a priority based decreasing ordering is applied.</li> + * implemented by its superclasses. This group of transitive converters is returned similarly in the + * order already mentioned, whereas here a priority based on decreasing ordering is applied.</li> * <li>java.lang wrapper classes and native types are automatically mapped.</li> * <li>If no explicit converters are registered, for Enum types a default implementation is provided that - * compares the configuration values with the different enum members defined (cases sensitive mapping).</li> + * compares the configuration values with the different enum members defined (case sensitive mapping).</li> * </ul> * <p> - * So given that list above directly registered mappings always are tried first, before any transitive mapping + * The above list of directly registered mappings are always tried first, before any transitive mapping * should be used. Also in all cases @Priority annotations are honored for ordering of the converters in place. * Transitive conversion is supported for all directly implemented interfaces (including inherited ones) and * the inheritance hierarchy (exception Object). Superinterfaces of implemented interfaces are ignored. @@ -340,7 +342,7 @@ public class PropertyConverterManager { } /** - * Creates a dynamic PropertyConverter for the given target type. + * Creates a dynamic {@link PropertyConverter} for the given target type. * * @param targetType the target type * @param <T> the type class @@ -430,8 +432,8 @@ public class PropertyConverterManager { } /** - * Default converters imüöementation perfoming several lookups for String converion - * option. + * Default converter implementation performing several lookups for String conversion + * options. * @param <T> */ private static class DefaultPropertyConverter<T> implements PropertyConverter<T> { http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertyFilterComparator.java ---------------------------------------------------------------------- diff --git a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertyFilterComparator.java b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertyFilterComparator.java index 20eef63..c1d5520 100644 --- a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertyFilterComparator.java +++ b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertyFilterComparator.java @@ -25,7 +25,7 @@ import java.io.Serializable; import java.util.Comparator; /** - * Comparator for PropertyFilters based on their priority annotations. + * Comparator for {@link PropertyFilter}s based on their priority annotations. */ public final class PropertyFilterComparator implements Comparator<PropertyFilter>, Serializable { http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertySourceComparator.java ---------------------------------------------------------------------- diff --git a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertySourceComparator.java b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertySourceComparator.java index d572335..92057c4 100644 --- a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertySourceComparator.java +++ b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/PropertySourceComparator.java @@ -29,7 +29,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Comparator for ordering of PropertySources based on their ordinal method and class name. + * Comparator for ordering of {@link PropertySource}s based on their ordinal method and class name. */ public class PropertySourceComparator implements Comparator<PropertySource>, Serializable { /** serial version UID. */ @@ -71,7 +71,7 @@ public class PropertySourceComparator implements Comparator<PropertySource>, Ser } /** - * Evaluates an ordinal value from a {@link PropertySource}, Hereby the ordinal of type {@code int} + * Evaluates an ordinal value from a {@link PropertySource}, whereby the ordinal of type {@code int} * is evaluated as follows: * <ol> * <li>It evaluates the {@code String} value for {@link PropertySource#TAMAYA_ORDINAL} and tries @@ -104,7 +104,7 @@ public class PropertySourceComparator implements Comparator<PropertySource>, Ser } /** - * Overrides/adds the key to evaluate/override a property sources ordinal. + * Overrides/adds the key to evaluate/override a property source ordinal. * @param ordinalKey sets the alternative ordinal key, if null default * behaviour will be active. * @return the instance for chaining. http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/BasePropertySource.java ---------------------------------------------------------------------- diff --git a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/BasePropertySource.java b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/BasePropertySource.java index 6126b68..83600fe 100644 --- a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/BasePropertySource.java +++ b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/BasePropertySource.java @@ -27,7 +27,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Abstract {@link org.apache.tamaya.spi.PropertySource} that allows to set a default ordinal that will be used, if no + * Abstract {@link org.apache.tamaya.spi.PropertySource} that allows setting a default ordinal to be used, if no * ordinal is provided with the config. */ public abstract class BasePropertySource implements PropertySource{ @@ -88,7 +88,7 @@ public abstract class BasePropertySource implements PropertySource{ } /** - * Allows to set the ordinal of this property source explcitly. This will override any evaluated + * Allows setting the ordinal of this property source explcitly. This will override any evaluated * ordinal, or default ordinal. To reset an explcit ordinal call {@code setOrdinal(null);}. * @param ordinal the explicit ordinal, or {@code null}. */ @@ -97,7 +97,7 @@ public abstract class BasePropertySource implements PropertySource{ } /** - * Allows to set the ordinal of this property source explcitly. This will override any evaluated + * Allows setting the ordinal of this property source explcitly. This will override any evaluated * ordinal, or default ordinal. To reset an explcit ordinal call {@code setOrdinal(null);}. * @param defaultOrdinal the default ordinal, or {@code null}. */ http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/CLIPropertySource.java ---------------------------------------------------------------------- diff --git a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/CLIPropertySource.java b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/CLIPropertySource.java index a83722f..8364ec2 100644 --- a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/CLIPropertySource.java +++ b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/CLIPropertySource.java @@ -23,7 +23,7 @@ import org.apache.tamaya.spi.PropertyValue; import java.util.*; /** - * PropertySource that allows to add the programs main arguments as configuration entries. Unix syntax using '--' and + * PropertySource that allows adding the program's main arguments as configuration entries. Unix syntax using '--' and * '-' params is supported. */ public class CLIPropertySource extends BasePropertySource { @@ -73,7 +73,7 @@ public class CLIPropertySource extends BasePropertySource { /** * Configure the main arguments, hereby parsing and mapping the main arguments into - * configuration propertiesi as key-value pairs. + * configuration properties as key-value pairs. * @param args the main arguments, not null. */ public static void initMainArgs(String... args){ http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/PropertiesResourcePropertySource.java ---------------------------------------------------------------------- diff --git a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/PropertiesResourcePropertySource.java b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/PropertiesResourcePropertySource.java index 27b6e4b..94f2dec 100644 --- a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/PropertiesResourcePropertySource.java +++ b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/PropertiesResourcePropertySource.java @@ -29,7 +29,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Simple PropertySource, with a fixed ordinal that reads a .properties file from a given URL. + * Simple {@link org.apache.tamaya.spi.PropertySource}, with a fixed ordinal that reads a .properties file from a given URL. */ public class PropertiesResourcePropertySource extends MapPropertySource { /** The logger used. */ @@ -65,6 +65,7 @@ public class PropertiesResourcePropertySource extends MapPropertySource { * Creates a new instance. * @param prefix the (optional) prefix context for mapping (prefixing) the properties loaded. * @param path the resource path, not null. + * @param cl the class loader. */ public PropertiesResourcePropertySource(String path, String prefix, ClassLoader cl){ super(path, loadProps(path, cl), prefix); http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/c1665018/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/SimplePropertySource.java ---------------------------------------------------------------------- diff --git a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/SimplePropertySource.java b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/SimplePropertySource.java index 070a564..6dc41a7 100644 --- a/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/SimplePropertySource.java +++ b/code/old/spi-support/src/main/java/org/apache/tamaya/spisupport/propertysource/SimplePropertySource.java @@ -264,7 +264,8 @@ public class SimplePropertySource extends BasePropertySource { /** * Sets the {@code properties} and returns a reference to this Builder so that the methods can be chained together. * - * @param val the {@code properties} to set + * @param key the {@code properties} key to set + * @param val the {@code properties} value to set * @return a reference to this Builder */ public Builder withProperty(String key, String val) {
