[sling-org-apache-sling-caconfig-api] 24/31: [SLING-8272] Fixed PR Comments

[kw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-caconfig-api.git

commit e19681fc3698e067417668ef5d6ef36b328e2c8e
Author: ompandey <om...@gmail.com>
AuthorDate: Sat Mar 9 12:01:38 2019 +0100

    [SLING-8272] Fixed PR Comments
---
 src/main/java/org/apache/sling/caconfig/ConfigurationBuilder.java | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/sling/caconfig/ConfigurationBuilder.java b/src/main/java/org/apache/sling/caconfig/ConfigurationBuilder.java
index 2ca00e7..84d7843 100644
--- a/src/main/java/org/apache/sling/caconfig/ConfigurationBuilder.java
+++ b/src/main/java/org/apache/sling/caconfig/ConfigurationBuilder.java
@@ -87,7 +87,12 @@ public interface ConfigurationBuilder {
     @NotNull <T> Collection<T> asAdaptableCollection(@NotNull Class<T> clazz);
 
     /**
-     * Check if the configuration node is existing
+     * Check if the configuration node is existing in the JCR. This method checks for the configuration existence based on {@code configName} defined in the
+     * configuration definition. It checks if the configuration is available for the context path in the current resource hierarchy and if not found, also
+     * checks in the global fall-back paths configured via {@link org.apache.sling.caconfig.resource.impl.def.DefaultConfigurationResourceResolvingStrategy}
+     * which by default are {@code /conf/global}, {@code /apps/config} and {@code /libs/config}.This method does not consider the default values provided in
+     * the configuration definition.
+     * Configuration name is optional - if not given via {@link #name(String)} method, it is derived from the annotation interface class name.
      * @param clazz Class that can be adapted from a {@link org.apache.sling.api.resource.Resource}
      * @param <T> Annotation class type
      * @return True/False based on configuration resource node existence in JCR.