You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ro...@apache.org on 2017/11/07 09:19:52 UTC
[sling-org-apache-sling-caconfig-spi] 21/23: fix javadoc errors
This is an automated email from the ASF dual-hosted git repository.
rombert pushed a commit to annotated tag org.apache.sling.caconfig.spi-1.2.0
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-caconfig-spi.git
commit c53d2c838a96608ca746be5645b1a79656ee6e4a
Author: Stefan Seifert <ss...@apache.org>
AuthorDate: Tue Dec 13 11:36:21 2016 +0000
fix javadoc errors
git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/contextaware-config/spi@1773951 13f79535-47bb-0310-9956-ffa450edef68
---
.../resource/spi/ConfigurationResourceResolvingStrategy.java | 5 +++--
.../sling/caconfig/spi/ConfigurationCollectionPersistData.java | 4 ++--
.../org/apache/sling/caconfig/spi/ConfigurationPersistData.java | 3 +--
.../sling/caconfig/spi/ConfigurationPersistenceStrategy.java | 7 +++----
.../apache/sling/caconfig/spi/metadata/ConfigurationMetadata.java | 2 ++
5 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/src/main/java/org/apache/sling/caconfig/resource/spi/ConfigurationResourceResolvingStrategy.java b/src/main/java/org/apache/sling/caconfig/resource/spi/ConfigurationResourceResolvingStrategy.java
index 7b96f80..3b96ae2 100644
--- a/src/main/java/org/apache/sling/caconfig/resource/spi/ConfigurationResourceResolvingStrategy.java
+++ b/src/main/java/org/apache/sling/caconfig/resource/spi/ConfigurationResourceResolvingStrategy.java
@@ -45,6 +45,7 @@ public interface ConfigurationResourceResolvingStrategy {
* @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 ConfigurationResourceResolvingStrategy {
/**
* 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 ConfigurationResourceResolvingStrategy {
/**
* 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.
diff --git a/src/main/java/org/apache/sling/caconfig/spi/ConfigurationCollectionPersistData.java b/src/main/java/org/apache/sling/caconfig/spi/ConfigurationCollectionPersistData.java
index 800b1ce..00dfa57 100644
--- a/src/main/java/org/apache/sling/caconfig/spi/ConfigurationCollectionPersistData.java
+++ b/src/main/java/org/apache/sling/caconfig/spi/ConfigurationCollectionPersistData.java
@@ -42,7 +42,7 @@ public final class ConfigurationCollectionPersistData {
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 ConfigurationCollectionPersistData {
}
/**
- * @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) {
diff --git a/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistData.java b/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistData.java
index a062a05..5a1f2fd 100644
--- a/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistData.java
+++ b/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistData.java
@@ -35,7 +35,6 @@ public final class ConfigurationPersistData {
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 ConfigurationPersistData {
}
/**
- * @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) {
diff --git a/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistenceStrategy.java b/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistenceStrategy.java
index cf88798..505ff51 100644
--- a/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistenceStrategy.java
+++ b/src/main/java/org/apache/sling/caconfig/spi/ConfigurationPersistenceStrategy.java
@@ -43,7 +43,7 @@ public interface ConfigurationPersistenceStrategy {
/**
* 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 ConfigurationPersistenceStrategy {
* 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 ConfigurationPersistenceStrategy {
* @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).
*/
diff --git a/src/main/java/org/apache/sling/caconfig/spi/metadata/ConfigurationMetadata.java b/src/main/java/org/apache/sling/caconfig/spi/metadata/ConfigurationMetadata.java
index 8948c8c..bc4ef43 100644
--- a/src/main/java/org/apache/sling/caconfig/spi/metadata/ConfigurationMetadata.java
+++ b/src/main/java/org/apache/sling/caconfig/spi/metadata/ConfigurationMetadata.java
@@ -37,6 +37,8 @@ public final class ConfigurationMetadata extends AbstractMetadata<ConfigurationM
/**
* @param name Configuration name
+ * @param propertyMetadata Property metadata
+ * @param collection Collection
*/
public ConfigurationMetadata(@Nonnull String name,
Collection<PropertyMetadata<?>> propertyMetadata,
--
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.