Author: bdelacretaz
Date: Mon May 6 09:05:30 2013
New Revision: 1479500
URL: http://svn.apache.org/r1479500
Log:
SLING-2853 - tweak javadocs
Modified:
sling/trunk/contrib/extensions/collection/src/main/java/org/apache/sling/resource/collection/ResourceCollection.java
sling/trunk/contrib/extensions/collection/src/main/java/org/apache/sling/resource/collection/ResourceCollectionManager.java
Modified:
sling/trunk/contrib/extensions/collection/src/main/java/org/apache/sling/resource/collection/ResourceCollection.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/collection/src/main/java/org/apache/sling/resource/collection/ResourceCollection.java?rev=1479500&r1=1479499&r2=1479500&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/collection/src/main/java/org/apache/sling/resource/collection/ResourceCollection.java
(original)
+++
sling/trunk/contrib/extensions/collection/src/main/java/org/apache/sling/resource/collection/ResourceCollection.java
Mon May 6 09:05:30 2013
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.sling.resource.collection;
import java.util.Iterator;
import java.util.Map;
@@ -27,10 +26,13 @@ import org.apache.sling.api.resource.Per
import org.apache.sling.api.resource.Resource;
/**
- * ResourceCollection is an ordered collection of resources. Actual resources
are not stored inside the collection.
+ * ResourceCollection is an ordered collection of {@link Resource}.
+ * The collection does not store the actual Resources, it only points to
+ * them.
*
- * Each entry in a collection is represented as a resource, which contain a
reference to original resource
- * and it can have additional properties i.e. creationDate.
+ * Each entry in the collection is represented by a Resource which contains a
+ * reference to original resource. That reference Resource can have additional
+ * properties (creationDate, etc.)
*/
public interface ResourceCollection {
@@ -76,7 +78,6 @@ public interface ResourceCollection {
*/
boolean contains(Resource resource);
-
/**
* Creates a new entry in the collection at the last position and add a
reference to resource
* in the entry.
Modified:
sling/trunk/contrib/extensions/collection/src/main/java/org/apache/sling/resource/collection/ResourceCollectionManager.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/collection/src/main/java/org/apache/sling/resource/collection/ResourceCollectionManager.java?rev=1479500&r1=1479499&r2=1479500&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/collection/src/main/java/org/apache/sling/resource/collection/ResourceCollectionManager.java
(original)
+++
sling/trunk/contrib/extensions/collection/src/main/java/org/apache/sling/resource/collection/ResourceCollectionManager.java
Mon May 6 09:05:30 2013
@@ -17,7 +17,6 @@
* under the License.
*/
-
package org.apache.sling.resource.collection;
import java.util.Map;
@@ -28,9 +27,9 @@ import org.apache.sling.api.resource.Res
/**
* The <code>ResourceCollectionManager<code> defines the API to get, create
and delete
- * resource collection {@link
org.apache.sling.resource.collection.ResourceCollection}.
+ * resource collections {@link
org.apache.sling.resource.collection.ResourceCollection}.
*
- * A ResourceCollectionManager instance can be retrieved by adapting
ResourceResolver.
+ * A ResourceCollectionManager instance can be retrieved by adapting a {@link
ResourceResolver}.
*/
public interface ResourceCollectionManager {
