svn commit: r1677778 - in /sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource: Resource.java ResourceResolver.java

[cz...@apache.org]

Author: cziegeler
Date: Tue May  5 10:33:02 2015
New Revision: 1677778

URL: http://svn.apache.org/r1677778
Log:
Update javadocs

Modified:
    sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/Resource.java
    sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/ResourceResolver.java

Modified: sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/Resource.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/Resource.java?rev=1677778&r1=1677777&r2=1677778&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/Resource.java (original)
+++ sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/Resource.java Tue May  5 10:33:02 2015
@@ -80,6 +80,7 @@ public interface Resource extends Adapta
      * represents the root of the resource tree.
      *
      * @since 2.1 (Sling API Bundle 2.1.0)
+     * @see ResourceResolver#getParent(Resource)
      */
     @CheckForNull Resource getParent();
 

Modified: sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/ResourceResolver.java?rev=1677778&r1=1677777&r2=1677778&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/ResourceResolver.java (original)
+++ sling/whiteboard/cziegeler/api-v3/src/main/java/org/apache/sling/api/resource/ResourceResolver.java Tue May  5 10:33:02 2015
@@ -381,7 +381,23 @@ public interface ResourceResolver extend
      */
     @Nonnull Iterator<Resource> listChildren(@Nonnull Resource parent);
 
-    @CheckForNull Resource getParent(@Nonnull Resource parent);
+    /**
+     * Returns the parent resource of this resource.
+     * <p>
+     * This method is implemented by getting the parent resource path first
+     * calling the {@link ResourceUtil#getParent(String)} method and then to
+     * retrieve that resource.
+     *
+     * @param child The {@link Resource Resource} whose parent is requested.
+     * @return The parent resource or {@code null}.
+     * @throws NullPointerException If <code>child</code> is <code>null</code>.
+     * @throws org.apache.sling.api.SlingException If any error occurs acquiring
+     *             the parent resource.
+     * @throws IllegalStateException if this resource resolver has already been
+     *             {@link #close() closed}.
+     * @since 2.9 (Sling API Bundle 2.10.0)
+     */
+    @CheckForNull Resource getParent(@Nonnull Resource child);
 
     /**
      * Returns an <code>Iterable</code> of {@link Resource} objects loaded from