From 7eb41b7cddeaaf01e3b8eacd70a2827ce69f9945 Mon Sep 17 00:00:00 2001 From: Stephen Colebourne Date: Wed, 7 May 2003 12:18:55 +0000 Subject: [PATCH] Javadoc improvements git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131046 13f79535-47bb-0310-9956-ffa450edef68 --- .../commons/collections/decorators/FixedSizeList.java | 8 ++++---- .../decorators/SynchronizedCollection.java | 6 +++--- .../collections/decorators/SynchronizedList.java | 7 ++++--- .../collections/decorators/SynchronizedSet.java | 7 ++++--- .../collections/decorators/SynchronizedSortedSet.java | 7 ++++--- .../decorators/UnmodifiableCollection.java | 11 ++++------- 6 files changed, 23 insertions(+), 23 deletions(-) diff --git a/src/java/org/apache/commons/collections/decorators/FixedSizeList.java b/src/java/org/apache/commons/collections/decorators/FixedSizeList.java index 199c8b717..31efd0d57 100644 --- a/src/java/org/apache/commons/collections/decorators/FixedSizeList.java +++ b/src/java/org/apache/commons/collections/decorators/FixedSizeList.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/FixedSizeList.java,v 1.3 2003/05/07 11:20:21 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/FixedSizeList.java,v 1.4 2003/05/07 12:18:55 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -62,14 +62,14 @@ import java.util.List; import java.util.ListIterator; /** - * FixedSizeList decorates another List to - * fix the size. + * FixedSizeList decorates another List + * to fix the size. *

* The add, remove, clear and retain operations are unsupported. * The set method is allowed (as it doesn't change the list size). * * @since Commons Collections 3.0 - * @version $Revision: 1.3 $ $Date: 2003/05/07 11:20:21 $ + * @version $Revision: 1.4 $ $Date: 2003/05/07 12:18:55 $ * * @author Stephen Colebourne * @author Paul Jack diff --git a/src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java b/src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java index 605c95968..567c18164 100644 --- a/src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java +++ b/src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java @@ -1,5 +1,5 @@ /* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedCollection.java,v 1.2 2003/05/07 11:20:21 scolebourne Exp $ + * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedCollection.java,v 1.3 2003/05/07 12:18:55 scolebourne Exp $ * ==================================================================== * * The Apache Software License, Version 1.1 @@ -62,7 +62,7 @@ import java.util.Iterator; /** * SynchronizedCollection decorates another Collection - * to synchronize the method calls. + * to synchronize its behaviour for a multi-threaded environment. *

* Iterators must be manually synchronized: * 

@@ -72,7 +72,7 @@ import java.util.Iterator;
  * }
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.2 $ $Date: 2003/05/07 11:20:21 $
+ * @version $Revision: 1.3 $ $Date: 2003/05/07 12:18:55 $
  * 
  * @author Stephen Colebourne
  */
diff --git a/src/java/org/apache/commons/collections/decorators/SynchronizedList.java b/src/java/org/apache/commons/collections/decorators/SynchronizedList.java
index ddc67fd0e..f31eb281e 100644
--- a/src/java/org/apache/commons/collections/decorators/SynchronizedList.java
+++ b/src/java/org/apache/commons/collections/decorators/SynchronizedList.java
@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedList.java,v 1.3 2003/05/07 11:20:21 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedList.java,v 1.4 2003/05/07 12:18:55 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -62,12 +62,13 @@ import java.util.List;
 import java.util.ListIterator;
 
 /**
- * SynchronizedList decorates another List.
+ * SynchronizedList decorates another List
+ * to synchronize its behaviour for a multi-threaded environment.
  * 

  * Methods are synchronized, then forwarded to the decorated list.
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.3 $ $Date: 2003/05/07 11:20:21 $
+ * @version $Revision: 1.4 $ $Date: 2003/05/07 12:18:55 $
  * 
  * @author Stephen Colebourne
  */
diff --git a/src/java/org/apache/commons/collections/decorators/SynchronizedSet.java b/src/java/org/apache/commons/collections/decorators/SynchronizedSet.java
index 1dc0579f9..e8b23341f 100644
--- a/src/java/org/apache/commons/collections/decorators/SynchronizedSet.java
+++ b/src/java/org/apache/commons/collections/decorators/SynchronizedSet.java
@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedSet.java,v 1.1 2003/05/07 11:19:46 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedSet.java,v 1.2 2003/05/07 12:18:55 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -60,12 +60,13 @@ package org.apache.commons.collections.decorators;
 import java.util.Set;
 
 /**
- * SynchronizedSet decorates another Set.
+ * SynchronizedSet decorates another Set
+ * to synchronize its behaviour for a multi-threaded environment.
  * 

  * Methods are synchronized, then forwarded to the decorated set.
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.1 $ $Date: 2003/05/07 11:19:46 $
+ * @version $Revision: 1.2 $ $Date: 2003/05/07 12:18:55 $
  * 
  * @author Stephen Colebourne
  */
diff --git a/src/java/org/apache/commons/collections/decorators/SynchronizedSortedSet.java b/src/java/org/apache/commons/collections/decorators/SynchronizedSortedSet.java
index 3c5f0a61c..9eeb793ce 100644
--- a/src/java/org/apache/commons/collections/decorators/SynchronizedSortedSet.java
+++ b/src/java/org/apache/commons/collections/decorators/SynchronizedSortedSet.java
@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedSortedSet.java,v 1.1 2003/05/07 11:19:46 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/SynchronizedSortedSet.java,v 1.2 2003/05/07 12:18:55 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -61,12 +61,13 @@ import java.util.Comparator;
 import java.util.SortedSet;
 
 /**
- * SynchronizedSortedSet decorates another SortedSet.
+ * SynchronizedSortedSet decorates another SortedSet
+ * to synchronize its behaviour for a multi-threaded environment.
  * 

  * Methods are synchronized, then forwarded to the decorated set.
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.1 $ $Date: 2003/05/07 11:19:46 $
+ * @version $Revision: 1.2 $ $Date: 2003/05/07 12:18:55 $
  * 
  * @author Stephen Colebourne
  */
diff --git a/src/java/org/apache/commons/collections/decorators/UnmodifiableCollection.java b/src/java/org/apache/commons/collections/decorators/UnmodifiableCollection.java
index 77152c335..ae82fcaf2 100644
--- a/src/java/org/apache/commons/collections/decorators/UnmodifiableCollection.java
+++ b/src/java/org/apache/commons/collections/decorators/UnmodifiableCollection.java
@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/UnmodifiableCollection.java,v 1.3 2003/05/07 11:20:21 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/decorators/Attic/UnmodifiableCollection.java,v 1.4 2003/05/07 12:18:55 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -63,14 +63,11 @@ import java.util.Iterator;
 import org.apache.commons.collections.IteratorUtils;
 
 /**
- * PredicatedCollection decorates another Collection
- * to validate addition match a specified predicate.
- * 

- * If an object cannot be addded to the collection, an IllegalArgumentException
- * is thrown.
+ * UnmodifiableCollection decorates another Collection
+ * to ensure it can't be altered.
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.3 $ $Date: 2003/05/07 11:20:21 $
+ * @version $Revision: 1.4 $ $Date: 2003/05/07 12:18:55 $
  * 
  * @author Stephen Colebourne
  */