sling-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sseif...@apache.org
Subject svn commit: r1773951 - in /sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig: resource/spi/ spi/ spi/metadata/
Date Tue, 13 Dec 2016 11:36:21 GMT
Author: sseifert
Date: Tue Dec 13 11:36:21 2016
New Revision: 1773951

URL: http://svn.apache.org/viewvc?rev=1773951&view=rev
Log:
fix javadoc errors

Modified:
    sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/resource/spi/ConfigurationResourceResolvingStrategy.java
    sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationCollectionPersistData.java
    sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistData.java
    sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistenceStrategy.java
    sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/metadata/ConfigurationMetadata.java

Modified: sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/resource/spi/ConfigurationResourceResolvingStrategy.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/resource/spi/ConfigurationResourceResolvingStrategy.java?rev=1773951&r1=1773950&r2=1773951&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/resource/spi/ConfigurationResourceResolvingStrategy.java
(original)
+++ sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/resource/spi/ConfigurationResourceResolvingStrategy.java
Tue Dec 13 11:36:21 2016
@@ -45,6 +45,7 @@ public interface ConfigurationResourceRe
      * @param resource Context resource to fetch configuration for
      * @param bucketNames Configuration "bucket" names. For each inheritance level all bucket
names are tried, and the first
      *   one that has a result is included.
+     * @param configName Configuration name or relative path.
      * @return Configuration resource or {@code null} if this strategy did not found matching
resources.
      */
     @CheckForNull Resource getResource(@Nonnull Resource resource, @Nonnull Collection<String>
bucketNames, @Nonnull String configName);
@@ -61,7 +62,7 @@ public interface ConfigurationResourceRe
 
     /**
      * Get a context-aware singleton configuration resource inheritance chain defined by
the given configuration name.
-     * The first item of the inheritance chain it the same resource returned by {@link #getResource(Resource,
String, String)}.
+     * The first item of the inheritance chain it the same resource returned by {@link #getResource(Resource,
Collection, String)}.
      * @param resource Context resource to fetch configuration for
      * @param bucketNames Configuration "bucket" names. For each inheritance level all bucket
names are tried, and the first
      *   one that has a result is included.
@@ -72,7 +73,7 @@ public interface ConfigurationResourceRe
 
     /**
      * Get a collection of context-aware configuration resource inheritance chains defined
by the given configuration name.
-     * The first item of each inheritance chain is the same item returned by {@link #getResourceCollection(Resource,
String, String)}.
+     * The first item of each inheritance chain is the same item returned by {@link #getResourceCollection(Resource,
Collection, String)}.
      * @param resource Context resource to fetch configuration for
      * @param bucketNames Configuration "bucket" names. For each inheritance level all bucket
names are tried, and the first
      *   one that has a result is included.

Modified: sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationCollectionPersistData.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationCollectionPersistData.java?rev=1773951&r1=1773950&r2=1773951&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationCollectionPersistData.java
(original)
+++ sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationCollectionPersistData.java
Tue Dec 13 11:36:21 2016
@@ -42,7 +42,7 @@ public final class ConfigurationCollecti
     private Map<String,Object> properties;
     
     /**
-     * @param collection Collection of configuration collection items
+     * @param items Collection of configuration collection items
      */
     public ConfigurationCollectionPersistData(@Nonnull Collection<ConfigurationPersistData>
items) {
         validateItems(items);
@@ -81,7 +81,7 @@ public final class ConfigurationCollecti
     }
 
     /**
-     * @param properties Properties for the configuration collection itself. Does not contain
configuration data, but control data e.g. for enabling collection inheritance.
+     * @param value Properties for the configuration collection itself. Does not contain
configuration data, but control data e.g. for enabling collection inheritance.
      * @return this
      */
     public ConfigurationCollectionPersistData properties(Map<String, Object> value)
{

Modified: sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistData.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistData.java?rev=1773951&r1=1773950&r2=1773951&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistData.java
(original)
+++ sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistData.java
Tue Dec 13 11:36:21 2016
@@ -35,7 +35,6 @@ public final class ConfigurationPersistD
     private String collectionItemName;
     
     /**
-     * @param collectionItemName Resource collection item name
      * @param properties Property values
      */
     public ConfigurationPersistData(@Nonnull Map<String, Object> properties) {
@@ -57,7 +56,7 @@ public final class ConfigurationPersistD
     }
 
     /**
-     * @param collectionItemName Resource collection item name.  To be set only for resource
collection items.
+     * @param value Resource collection item name.  To be set only for resource collection
items.
      * @return this
      */
     public ConfigurationPersistData collectionItemName(String value) {

Modified: sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistenceStrategy.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistenceStrategy.java?rev=1773951&r1=1773950&r2=1773951&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistenceStrategy.java
(original)
+++ sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistenceStrategy.java
Tue Dec 13 11:36:21 2016
@@ -43,7 +43,7 @@ public interface ConfigurationPersistenc
     /**
      * Allows the strategy to transform the given configuration resource path according to
it's persistent strategies,
      * e.g. fetching the data from a child resource instead of the given resource. 
-     * @param resource Configuration resource path or part of it (e.g. config name)
+     * @param resourcePath Configuration resource path or part of it (e.g. config name)
      * @return Transformed configuration resource path. If null is returned this strategy
does not support the given configuration resource path.
      */
     @CheckForNull String getResourcePath(@Nonnull String resourcePath);
@@ -53,7 +53,7 @@ public interface ConfigurationPersistenc
      * The changes are written using the given resource resolver. They are not committed,
this is left to the caller.
      * @param resourceResolver Resource resolver
      * @param configResourcePath Path to store configuration data to. The resource (and it's
parents) may not exist and may have to be created. 
-     * @param properties Configuration properties
+     * @param data Configuration persistence data
      * @return true if the data was persisted. false if persisting the data was not accepted
by this persistence strategy
      *      (in case of error throw an exception).
      */
@@ -66,8 +66,7 @@ public interface ConfigurationPersistenc
      * @param resourceResolver Resource resolver
      * @param configResourceCollectionParentPath Parent path to store configuration collection
data to.
      *      The resource (and it's parents) may not exist and may have to be created. 
-     * @param resourceCollectionItems Resource collection items to be stored.
-     *      All existing collection entries on this context path level are erased and replaced
with the new ones.
+     * @param data Configuration collection data. All existing collection entries on this
context path level are erased and replaced with the new ones.
      * @return true if the data was persisted. false if persisting the data was not accepted
by this persistence strategy
      *      (in case of error throw an exception).
      */

Modified: sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/metadata/ConfigurationMetadata.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/metadata/ConfigurationMetadata.java?rev=1773951&r1=1773950&r2=1773951&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/metadata/ConfigurationMetadata.java
(original)
+++ sling/trunk/contrib/extensions/contextaware-config/spi/src/main/java/org/apache/sling/caconfig/spi/metadata/ConfigurationMetadata.java
Tue Dec 13 11:36:21 2016
@@ -37,6 +37,8 @@ public final class ConfigurationMetadata
 
     /**
      * @param name Configuration name
+     * @param propertyMetadata Property metadata
+     * @param collection Collection
      */
     public ConfigurationMetadata(@Nonnull String name,
             Collection<PropertyMetadata<?>> propertyMetadata,



Mime
View raw message