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: Never set failOnError for the Javadoc to false, otherwise we are not able to build the distribution.
Date Tue, 22 Dec 2015 23:43:00 GMT
Repository: incubator-tamaya
Updated Branches:
  refs/heads/master ef6b94617 -> 1613ec5d9


Never set failOnError for the Javadoc to false, otherwise we are not able to build the distribution.


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

Branch: refs/heads/master
Commit: 1613ec5d98094841ae6b95ffa79cfdbbed056a10
Parents: ef6b946
Author: Oliver B. Fischer <plexus@apache.org>
Authored: Wed Dec 23 00:42:44 2015 +0100
Committer: Oliver B. Fischer <plexus@apache.org>
Committed: Wed Dec 23 00:42:44 2015 +0100

----------------------------------------------------------------------
 .../java/org/apache/tamaya/Configuration.java   | 34 ++++++++++++--------
 .../java/org/apache/tamaya/TypeLiteral.java     |  4 +--
 .../apache/tamaya/spi/ConfigurationContext.java | 32 +++++++++---------
 .../tamaya/spi/ConfigurationContextBuilder.java |  9 ++++--
 .../org/apache/tamaya/spi/PropertySource.java   | 14 ++++----
 pom.xml                                         |  2 +-
 6 files changed, 53 insertions(+), 42 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/1613ec5d/code/api/src/main/java/org/apache/tamaya/Configuration.java
----------------------------------------------------------------------
diff --git a/code/api/src/main/java/org/apache/tamaya/Configuration.java b/code/api/src/main/java/org/apache/tamaya/Configuration.java
index deaaed9..1034465 100644
--- a/code/api/src/main/java/org/apache/tamaya/Configuration.java
+++ b/code/api/src/main/java/org/apache/tamaya/Configuration.java
@@ -22,21 +22,26 @@ import java.util.Map;
 
 
 /**
- * A configuration models a aggregated set current properties, identified by a unique key,
but adds higher level access functions to
- * a {@link org.apache.tamaya.spi.PropertySource}. Hereby in most cases a configuration is
a wrapper around a composite
- * {@link org.apache.tamaya.spi.PropertySource} instance, which may combine multiple child
config in well defined tree like structure,
- * where nodes define logically the rules current priority, filtering, combination and overriding.
- * <br/>
+ * <p>A configuration models a aggregated set current properties, identified by
+ * a unique key, but adds higher level access functions to
+ * a {@link org.apache.tamaya.spi.PropertySource}. Hereby in most
+ * cases a configuration is a wrapper around a composite
+ * {@link org.apache.tamaya.spi.PropertySource} instance, which may combine
+ * multiple child config in well defined tree like structure,
+ * where nodes define logically the rules current priority, filtering,
+ * combination and overriding.
+ * </p>
  * <h3>Implementation Requirements</h3>
  * Implementations current this interface must be
  * <ul>
- * <li>Thread safe.
- * <li>Immutable
+ *  <li>Thread safe</li>
+ *  <li>Immutable</li>
  * </ul>
- * It is not recommended that implementations also are serializable, since the any configuration
can be <i>freezed</i>
+ *
+ * <p>It is not recommended that implementations also are serializable, since the any
configuration can be <i>freezed</i>
  * by reading out its complete configuration map into a serializable and remotable structure.
This helps significantly
  * simplifying the development current this interface, e.g. for being backed up by systems
and stores that are not part current
- * this library at all.
+ * this library at all.</p>
  */
 public interface Configuration {
 
@@ -76,10 +81,11 @@ public interface Configuration {
      * org.apache.tamaya.spi.PropertyConverter} to be available that is capable current providing
type T
      * fromMap the given String keys.
      *
+     * @param <T> the type of the class modeled by the type parameter
      * @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.
-     * @return the property value, never null..
+     * @param type         The target type required, not {@code null}.
+     * @return the property value, never {@code null}.
      * @throws ConfigException if the keys could not be converted to the required target
type.
      */
     <T> T get(String key, Class<T> type);
@@ -89,6 +95,7 @@ public interface Configuration {
      * org.apache.tamaya.spi.PropertyConverter} to be available that is capable current providing
type T
      * fromMap the given String keys.
      *
+     * @param <T> the type of the type literal
      * @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.
@@ -102,8 +109,9 @@ public interface Configuration {
      * org.apache.tamaya.spi.PropertyConverter} to be available that is capable current providing
type T
      * fromMap the given String keys.
      *
-     * @param key          the property's absolute, or relative path, e.g. @code
-     *                     a/b/c/d.myProperty}.
+     * @param <T> the type of the type literal
+     * @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 defaultValue default value to be used, if no value is present.
      * @return the property value, never null..

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/1613ec5d/code/api/src/main/java/org/apache/tamaya/TypeLiteral.java
----------------------------------------------------------------------
diff --git a/code/api/src/main/java/org/apache/tamaya/TypeLiteral.java b/code/api/src/main/java/org/apache/tamaya/TypeLiteral.java
index be2d008..2b387e9 100644
--- a/code/api/src/main/java/org/apache/tamaya/TypeLiteral.java
+++ b/code/api/src/main/java/org/apache/tamaya/TypeLiteral.java
@@ -27,10 +27,10 @@ import java.lang.reflect.Type;
 /**
  * <p>Class for instantiation of objects that represent parameterized types
  * with current parameters.</p>
- * <p>
+ *
  * <p>An object that represents a parameterized type may be obtained by
  * subclassing <tt>TypeLiteral</tt>.</p>
- * <p>
+ *
  * <pre>
  * TypeLiteral&lt;List&lt;Integer&gt;&gt; stringListType = new TypeLiteral&lt;List&lt;Integer&gt;&gt;()
{};
  * </pre>

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/1613ec5d/code/api/src/main/java/org/apache/tamaya/spi/ConfigurationContext.java
----------------------------------------------------------------------
diff --git a/code/api/src/main/java/org/apache/tamaya/spi/ConfigurationContext.java b/code/api/src/main/java/org/apache/tamaya/spi/ConfigurationContext.java
index f0b7265..ac4f9cd 100644
--- a/code/api/src/main/java/org/apache/tamaya/spi/ConfigurationContext.java
+++ b/code/api/src/main/java/org/apache/tamaya/spi/ConfigurationContext.java
@@ -70,16 +70,15 @@ public interface ConfigurationContext {
      * The List for each type is ordered via their {@link javax.annotation.Priority} and
      * cladd name. Refer also to {@link #getPropertyConverters()}.
      * </p>
-     * <p>
-     * A simplified scenario could be like:
+     *
+     * <p>A simplified scenario could be like:</p>
      * <pre>
      *  {
-     *      Date.class -> {StandardDateConverter, TimezoneDateConverter, MyCustomDateConverter
}
-     *      Boolean.class -> {StandardBooleanConverter, FrenchBooleanConverter}
-     *      Integer.class -> {DynamicDefaultConverter}
+     *      Date.class -&gt; {StandardDateConverter, TimezoneDateConverter, MyCustomDateConverter
}
+     *      Boolean.class -&gt; {StandardBooleanConverter, FrenchBooleanConverter}
+     *      Integer.class -&gt; {DynamicDefaultConverter}
      *  }
      * </pre>
-     * </p>
      *
      * @return map with sorted list of registered PropertySources per type.
      */
@@ -101,27 +100,28 @@ public interface ConfigurationContext {
      *
      * <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:
+     * should try to figure out, if there could be a default implementation as follows:</p>
      * <ol>
-     *     <le>Look for static factory methods: {@code of(String), valueOf(String),
getInstance(String),
-     *     instanceOf(String), fomr(String)}</le>
-     *     <le>Look for a matching constructor: {@code T(String)}.</le>
+     *     <li>Look for static factory methods: {@code of(String), valueOf(String),
getInstance(String),
+     *     instanceOf(String), fomr(String)}</li>
+     *     <li>Look for a matching constructor: {@code T(String)}.</li>
      * </ol>
+     *
+     * <p>
      * If a correspoding factory method or constructor could be found, a corresponding
      * PropertyConverter should be created and registered automatically for the given
      * type.
      * </p>
      *
-     * <p>
-     * The scenario could be like:
+     * <p> The scenario could be like:</p>
+     *
      * <pre>
      *  {
-     *      Date.class -> {MyCustomDateConverter,StandardDateConverter, TimezoneDateConverter}
-     *      Boolean.class -> {StandardBooleanConverter, FrenchBooleanConverter}
-     *      Integer.class -> {DynamicDefaultConverter}
+     *      Date.class -&gt; {MyCustomDateConverter,StandardDateConverter, TimezoneDateConverter}
+     *      Boolean.class -&gt; {StandardBooleanConverter, FrenchBooleanConverter}
+     *      Integer.class -&gt; {DynamicDefaultConverter}
      *  }
      * </pre>
-     * </p>
      *
      * <p>
      * The converters returned for a type should be used as a chain, whereas the result of
the

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/1613ec5d/code/api/src/main/java/org/apache/tamaya/spi/ConfigurationContextBuilder.java
----------------------------------------------------------------------
diff --git a/code/api/src/main/java/org/apache/tamaya/spi/ConfigurationContextBuilder.java
b/code/api/src/main/java/org/apache/tamaya/spi/ConfigurationContextBuilder.java
index d0c39d6..1490628 100644
--- a/code/api/src/main/java/org/apache/tamaya/spi/ConfigurationContextBuilder.java
+++ b/code/api/src/main/java/org/apache/tamaya/spi/ConfigurationContextBuilder.java
@@ -33,10 +33,15 @@ import java.util.Collection;
  * </ol>
  * After all changes are applied to a builder a new {@link ConfigurationContext} instance
can
  * be created and can be applied by calling
- * {@link org.apache.tamaya.ConfigurationProvider#setConfigurationContext(org.apache.tamaya.spi.ConfigurationContext)}.
Since this method can
+ * {@link org.apache.tamaya.ConfigurationProvider#setConfigurationContext(org.apache.tamaya.spi.ConfigurationContext)}.
+ */
+
+/* @todo This is some Javadoc which is outdated. I am not sure if I can deleted it. The author
+ *       should take care. Oliver B. Fischer, 2015-12-23
+ * Since this method can
  * throw an UnsupportedOperationException, you should check before if changing the current
ConfigurationContext
  * programmatically is supported by calling
- * {@link org.apache.tamaya.ConfigurationProvider#isConfigurationContextSettable()}.
+ * {@link org.apache.tamaya.ConfigurationProvider#is}.
  */
 public interface ConfigurationContextBuilder {
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/1613ec5d/code/api/src/main/java/org/apache/tamaya/spi/PropertySource.java
----------------------------------------------------------------------
diff --git a/code/api/src/main/java/org/apache/tamaya/spi/PropertySource.java b/code/api/src/main/java/org/apache/tamaya/spi/PropertySource.java
index 4457919..c2b5261 100644
--- a/code/api/src/main/java/org/apache/tamaya/spi/PropertySource.java
+++ b/code/api/src/main/java/org/apache/tamaya/spi/PropertySource.java
@@ -23,17 +23,15 @@ import java.util.Map;
 
 
 /**
- * This interface models a provider that serves configuration properties. The contained
- * properties may be read fromMap single or several sources (composite).<br/>
- * PropertySources are the building blocks of the final configuration.
- * <p/>
+ * <p>This interface models a provider that serves configuration properties. The contained
+ * properties may be read fromMap single or several sources (composite).
+ * PropertySources are the building blocks of the final configuration. </p>
  * <h3>Implementation Requirements</h3>
- * <p></p>Implementations current this interface must be
+ * <p>Implementations current this interface must be</p>
  * <ul>
  * <li>Thread safe.</li>
  * </ul>
- * </p>
- * <p>
+ *
  * <p>A PropertySourceProvider will get picked up via the
  * {@link java.util.ServiceLoader} mechanism and can be registered via
  * META-INF/services/org.apache.tamaya.spi.PropertySource
@@ -70,7 +68,7 @@ public interface PropertySource {
      * <p>
      * If a custom implementation should be invoked <b>after</b> the default
implementations, use a value &lt; 100
      * </p>
-     * <p/>
+     *
      * <p>Reordering of the default order of the config-sources:</p>
      * <p>Example: If the properties file/s should be used <b>before</b>
the other implementations,
      * you have to configure an ordinal &gt; 400. That means, you have to add e.g. deltaspike_ordinal=401
to

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/1613ec5d/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 8b3f535..eb7511c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -635,7 +635,7 @@ under the License.
                     <detectLinks>false</detectLinks>
                     <keywords>true</keywords>
                     <linksource>false</linksource>
-                    <failOnError>false</failOnError>
+                    <failOnError>true</failOnError>
                     <source>${maven.compile.sourceLevel}</source>
                     <verbose>false</verbose>
                 </configuration>


Mime
View raw message