Return-Path: Delivered-To: apmail-sling-commits-archive@www.apache.org Received: (qmail 9019 invoked from network); 6 Apr 2010 06:26:08 -0000 Received: from unknown (HELO mail.apache.org) (140.211.11.3) by 140.211.11.9 with SMTP; 6 Apr 2010 06:26:08 -0000 Received: (qmail 41685 invoked by uid 500); 6 Apr 2010 06:26:08 -0000 Delivered-To: apmail-sling-commits-archive@sling.apache.org Received: (qmail 41621 invoked by uid 500); 6 Apr 2010 06:26:07 -0000 Mailing-List: contact commits-help@sling.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@sling.apache.org Delivered-To: mailing list commits@sling.apache.org Received: (qmail 41613 invoked by uid 99); 6 Apr 2010 06:26:06 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 06 Apr 2010 06:26:06 +0000 X-ASF-Spam-Status: No, hits=-1201.3 required=10.0 tests=ALL_TRUSTED,AWL X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 06 Apr 2010 06:26:05 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id E125323889C5; Tue, 6 Apr 2010 06:25:44 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r931033 - in /sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource: ResourceUtil.java ResourceWrapper.java Date: Tue, 06 Apr 2010 06:25:44 -0000 To: commits@sling.apache.org From: cziegeler@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20100406062544.E125323889C5@eris.apache.org> Author: cziegeler Date: Tue Apr 6 06:25:44 2010 New Revision: 931033 URL: http://svn.apache.org/viewvc?rev=931033&view=rev Log: Some javadocs. Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceUtil.java sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceWrapper.java Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceUtil.java URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceUtil.java?rev=931033&r1=931032&r2=931033&view=diff ============================================================================== --- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceUtil.java (original) +++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceUtil.java Tue Apr 6 06:25:44 2010 @@ -413,7 +413,15 @@ public class ResourceUtil { } /** - * @param + * Return an iterator for objecs of the specified type. + * A new iterator is returned which tries to adapt the provided resources + * to the given type (using {@link Resource#adaptTo(Class)}. + * If a resource in the original iterator is not adaptable to the given + * class, this object is skipped. This implies that the number of objects + * returned by the new iterator might be less than the number of resource + * objects. + * @param iterator A resource iterator. + * @param The adapted type * @since 2.0.6 */ public static Iterator adaptTo(final Iterator iterator, final Class type) { Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceWrapper.java URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceWrapper.java?rev=931033&r1=931032&r2=931033&view=diff ============================================================================== --- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceWrapper.java (original) +++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceWrapper.java Tue Apr 6 06:25:44 2010 @@ -26,7 +26,7 @@ package org.apache.sling.api.resource; */ public class ResourceWrapper implements Resource { - // the wrapped resource + /** the wrapped resource */ private final Resource resource; /** @@ -39,35 +39,58 @@ public class ResourceWrapper implements /** * Returns the Resource wrapped by this instance. + * This method can be overwritten by subclasses if required. All + * other methods use this method to get the resource object. */ public Resource getResource() { return resource; } + /** + * @see org.apache.sling.api.resource.Resource#getPath() + */ public String getPath() { - return resource.getPath(); + return getResource().getPath(); } + /** + * @see org.apache.sling.api.resource.Resource#getResourceMetadata() + */ public ResourceMetadata getResourceMetadata() { - return resource.getResourceMetadata(); + return getResource().getResourceMetadata(); } + /** + * @see org.apache.sling.api.resource.Resource#getResourceResolver() + */ public ResourceResolver getResourceResolver() { - return resource.getResourceResolver(); + return getResource().getResourceResolver(); } + /** + * @see org.apache.sling.api.resource.Resource#getResourceType() + */ public String getResourceType() { - return resource.getResourceType(); + return getResource().getResourceType(); } + /** + * @see org.apache.sling.api.resource.Resource#getResourceSuperType() + */ public String getResourceSuperType() { - return resource.getResourceSuperType(); + return getResource().getResourceSuperType(); } - + + /** + * @see org.apache.sling.api.adapter.Adaptable#adaptTo(java.lang.Class) + */ public AdapterType adaptTo(Class type) { - return resource.adaptTo(type); + return getResource().adaptTo(type); } + /** + * @see java.lang.Object#toString() + */ public String toString() { return getClass().getSimpleName() + ", type=" + getResourceType() + ", path=" + getPath() + ", resource=[" + getResource() + "]";