svn commit: r1448957 - /sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java

[cz...@apache.org]

Author: cziegeler
Date: Fri Feb 22 09:25:14 2013
New Revision: 1448957

URL: http://svn.apache.org/r1448957
Log:
SLING-2740 :  Clarify Resource#getResourceSuperType 

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

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java?rev=1448957&r1=1448956&r2=1448957&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/Resource.java Fri Feb 22 09:25:14 2013
@@ -117,8 +117,12 @@ public interface Resource extends Adapta
     String getResourceType();
 
     /**
-     * Returns the super type of the type of the resource or <code>null</code>
-     * if the {@link #getResourceType()} has no supertype.
+     * Returns the super type of the resource if the resource defines its
+     * own super type. Otherwise <code>null</code> is returned.
+     * A resource might return a resource super type to overwrite the
+     * resource type hierarchy.
+     * If a client is interested in the effective resource super type
+     * of a resource, it should call {@link ResourceResolver#getResourceSuperType(Resource)}.
      */
     String getResourceSuperType();