scolebourne 2004/05/15 05:39:13
Modified: collections/src/java/org/apache/commons/collections/collection
PredicatedCollection.java
UnmodifiableCollection.java
SynchronizedCollection.java
CompositeCollection.java TypedCollection.java
TransformedCollection.java
UnmodifiableBoundedCollection.java
Log:
Javadoc
Revision Changes Path
1.4 +2 -1
jakarta-commons/collections/src/java/org/apache/commons/collections/collection/PredicatedCollection.java
Index: PredicatedCollection.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/collection/PredicatedCollection.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PredicatedCollection.java 18 Feb 2004 00:58:53 -0000 1.3
+++ PredicatedCollection.java 15 May 2004 12:39:13 -0000 1.4
@@ -46,6 +46,7 @@
*
* @param coll the collection to decorate, must not be null
* @param predicate the predicate to use for validation, must not be null
+ * @return a new predicated collection
* @throws IllegalArgumentException if collection or predicate is null
* @throws IllegalArgumentException if the collection contains invalid elements
*/
1.6 +4 -1
jakarta-commons/collections/src/java/org/apache/commons/collections/collection/UnmodifiableCollection.java
Index: UnmodifiableCollection.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/collection/UnmodifiableCollection.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- UnmodifiableCollection.java 18 Feb 2004 00:58:53 -0000 1.5
+++ UnmodifiableCollection.java 15 May 2004 12:39:13 -0000 1.6
@@ -33,8 +33,11 @@
/**
* Factory method to create an unmodifiable collection.
+ * <p>
+ * If the collection passed in is already unmodifiable, it is returned.
*
* @param coll the collection to decorate, must not be null
+ * @return an unmodifiable collection
* @throws IllegalArgumentException if collection is null
*/
public static Collection decorate(Collection coll) {
1.5 +2 -1
jakarta-commons/collections/src/java/org/apache/commons/collections/collection/SynchronizedCollection.java
Index: SynchronizedCollection.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/collection/SynchronizedCollection.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- SynchronizedCollection.java 18 Feb 2004 00:58:53 -0000 1.4
+++ SynchronizedCollection.java 15 May 2004 12:39:13 -0000 1.5
@@ -46,6 +46,7 @@
* Factory method to create a synchronized collection.
*
* @param coll the collection to decorate, must not be null
+ * @return a new synchronized collection
* @throws IllegalArgumentException if collection is null
*/
public static Collection decorate(Collection coll) {
1.6 +10 -3
jakarta-commons/collections/src/java/org/apache/commons/collections/collection/CompositeCollection.java
Index: CompositeCollection.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/collection/CompositeCollection.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- CompositeCollection.java 18 Feb 2004 00:58:53 -0000 1.5
+++ CompositeCollection.java 15 May 2004 12:39:13 -0000 1.6
@@ -113,6 +113,7 @@
* <p>
* This implementation calls <code>contains()</code> on each collection.
*
+ * @param obj the object to search for
* @return true if obj is contained in any of the contained collections
*/
public boolean contains(Object obj) {
@@ -163,9 +164,10 @@
* Returns an object array, populating the supplied array if possible.
* See <code>Collection</code> interface for full details.
*
+ * @param array the array to use, populating if possible
* @return an array of all the elements in the collection
*/
- public Object[] toArray(Object array[]) {
+ public Object[] toArray(Object[] array) {
int size = this.size();
Object[] result = null;
if (array.length >= size) {
@@ -338,13 +340,18 @@
/**
* Add an additional collection to this composite.
+ *
+ * @param c the collection to add
*/
public void addComposited(Collection c) {
this.addComposited(new Collection[]{c});
}
/**
- * Add two additional collection to this composite.
+ * Add two additional collections to this composite.
+ *
+ * @param c the first collection to add
+ * @param d the second collection to add
*/
public void addComposited(Collection c, Collection d) {
this.addComposited(new Collection[]{c, d});
1.5 +3 -1
jakarta-commons/collections/src/java/org/apache/commons/collections/collection/TypedCollection.java
Index: TypedCollection.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/collection/TypedCollection.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TypedCollection.java 7 May 2004 23:28:38 -0000 1.4
+++ TypedCollection.java 15 May 2004 12:39:13 -0000 1.5
@@ -42,6 +42,7 @@
*
* @param coll the collection to decorate, must not be null
* @param type the type to allow into the collection, must not be null
+ * @return a new typed collection
* @throws IllegalArgumentException if collection or type is null
* @throws IllegalArgumentException if the collection contains invalid elements
*/
@@ -53,6 +54,7 @@
* Restrictive constructor.
*/
protected TypedCollection() {
+ super();
}
}
1.5 +2 -1
jakarta-commons/collections/src/java/org/apache/commons/collections/collection/TransformedCollection.java
Index: TransformedCollection.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/collection/TransformedCollection.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TransformedCollection.java 18 Feb 2004 00:58:53 -0000 1.4
+++ TransformedCollection.java 15 May 2004 12:39:13 -0000 1.5
@@ -48,6 +48,7 @@
*
* @param coll the collection to decorate, must not be null
* @param transformer the transformer to use for conversion, must not be null
+ * @return a new transformed collection
* @throws IllegalArgumentException if collection or transformer is null
*/
public static Collection decorate(Collection coll, Transformer transformer) {
1.8 +3 -1
jakarta-commons/collections/src/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java
Index: UnmodifiableBoundedCollection.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- UnmodifiableBoundedCollection.java 14 Apr 2004 20:11:45 -0000 1.7
+++ UnmodifiableBoundedCollection.java 15 May 2004 12:39:13 -0000 1.8
@@ -42,6 +42,7 @@
* Factory method to create an unmodifiable bounded collection.
*
* @param coll the <code>BoundedCollection</code> to decorate, must not be null
+ * @return a new unmodifiable bounded collection
* @throws IllegalArgumentException if bag is null
*/
public static BoundedCollection decorate(BoundedCollection coll) {
@@ -55,6 +56,7 @@
* to find a suitable BoundedCollection.
*
* @param coll the <code>BoundedCollection</code> to decorate, must not be null
+ * @return a new unmodifiable bounded collection
* @throws IllegalArgumentException if bag is null
*/
public static BoundedCollection decorateUsing(Collection coll) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
