incubator-sling-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cziege...@apache.org
Subject svn commit: r1571670 - in /sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource: ResourceResolver.java ResourceResolverFactory.java
Date Tue, 25 Feb 2014 12:51:22 GMT
Author: cziegeler
Date: Tue Feb 25 12:51:22 2014
New Revision: 1571670

URL: http://svn.apache.org/r1571670
Log:
Clarify getSearchPath javadocs

Modified:
    sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
    sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolverFactory.java

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java?rev=1571670&r1=1571669&r2=1571670&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
(original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
Tue Feb 25 12:51:22 2014
@@ -335,10 +335,14 @@ public interface ResourceResolver extend
      * to search for resources by relative path. If no search path is set an
      * empty array is returned.
      * <p>
-     * The returns array of Strings is a copy of the internal value, so
+     * The returned array of strings is a copy of the internal value, so
      * modifications to this array have no influence on the operation of the
      * ResourceResolver.
      * <p>
+     * The search path of a resource resolver never changes during the lifetime
+     * of the resource resolver. Therefore clients may call this method once
+     * and use the stored value together with this resource resolver.
+     * <p>
      * Each entry in the array is an absolute path terminated with a slash
      * character. Thus to create an absolute path from a search path entry and a
      * relative path, the search path entry and relative path may just be
@@ -449,14 +453,14 @@ public interface ResourceResolver extend
 
     /**
      * Checks if the specified resource has any direct child resources.
-     * 
+     *
      * @param resource
      *            the resource to check for direct children
      * @return <code>true</code> if the resource has any child resources
      * @since 2.4.4
      */
     boolean hasChildren(Resource resource);
-    
+
     /**
      * Returns a new <code>ResourceResolver</code> instance based on the given
      * <code>authenticationInfo</code> map and the original authentication info

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolverFactory.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolverFactory.java?rev=1571670&r1=1571669&r2=1571670&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolverFactory.java
(original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceResolverFactory.java
Tue Feb 25 12:51:22 2014
@@ -28,6 +28,9 @@ import aQute.bnd.annotation.ProviderType
  * <p>
  * As soon as the resource resolver is not used anymore,
  * {@link ResourceResolver#close()} should be called.
+ * <p>
+ * All resource resolvers returned by the same resource resolver factory
+ * must use the same search path
  *
  * @since 2.1
  */



Mime
View raw message