Author: bdelacretaz
Date: Thu Sep 16 11:47:36 2010
New Revision: 997700
URL: http://svn.apache.org/viewvc?rev=997700&view=rev
Log:
typos and details in comments
Modified:
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceDecorator.java
Modified:
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceDecorator.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceDecorator.java?rev=997700&r1=997699&r2=997700&view=diff
==============================================================================
---
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceDecorator.java
(original)
+++
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/ResourceDecorator.java
Thu Sep 16 11:47:36 2010
@@ -19,9 +19,9 @@ package org.apache.sling.api.resource;
import javax.servlet.http.HttpServletRequest;
/**
- * Optional services to decorate {...@link Resource}s returned by
+ * Optional service to decorate {...@link Resource}s returned by
* the {...@link ResourceResolver}.
- * Use cases for a decorator are
+ * Typical use cases for a decorator are
* - overwrite resource type/resource super type (for example
* based on the resource path)
* - add metadata
@@ -33,25 +33,25 @@ public interface ResourceDecorator {
/**
* Decorate a resource.
* If the service decorates the resource it should return
- * the new resource. IF the servie does not want to decorate
+ * the new resource. If the service does not want to decorate
* the resource, it should return the original resource.
* Returning <code>null</code> is considered the same as
* returning the original resource.
* @param resource The resource to decorate
- * @return The decorated resource or the original resource.
+ * @return The decorated resource, the original resource or null.
*/
Resource decorate(Resource resource);
/**
* Decorate a resource.
* If the service decorates the resource it should return
- * the new resource. IF the servie does not want to decorate
+ * the new resource. If the service does not want to decorate
* the resource, it should return the original resource.
* Returning <code>null</code> is considered the same as
* returning the original resource.
* @param resource The resource to decorate
* @param request The current request.
- * @return The decorated resource or the original resource.
+ * @return The decorated resource, the original resource or null.
*/
Resource decorate(Resource resource, HttpServletRequest request);
}
