You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sc...@apache.org on 2003/05/07 14:18:55 UTC

cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections/decorators SynchronizedSet.java SynchronizedCollection.java UnmodifiableCollection.java SynchronizedList.java SynchronizedSortedSet.java FixedSizeList.java

scolebourne    2003/05/07 05:18:55

  Modified:    collections/src/java/org/apache/commons/collections/decorators
                        SynchronizedSet.java SynchronizedCollection.java
                        UnmodifiableCollection.java SynchronizedList.java
                        SynchronizedSortedSet.java FixedSizeList.java
  Log:
  Javadoc improvements
  
  Revision  Changes    Path
  1.2       +4 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/SynchronizedSet.java
  
  Index: SynchronizedSet.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/SynchronizedSet.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- SynchronizedSet.java	7 May 2003 11:19:46 -0000	1.1
  +++ SynchronizedSet.java	7 May 2003 12:18:55 -0000	1.2
  @@ -60,7 +60,8 @@
   import java.util.Set;
   
   /**
  - * <code>SynchronizedSet</code> decorates another <code>Set</code>.
  + * <code>SynchronizedSet</code> decorates another <code>Set</code>
  + * to synchronize its behaviour for a multi-threaded environment.
    * <p>
    * Methods are synchronized, then forwarded to the decorated set.
    *
  
  
  
  1.3       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java
  
  Index: SynchronizedCollection.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- SynchronizedCollection.java	7 May 2003 11:20:21 -0000	1.2
  +++ SynchronizedCollection.java	7 May 2003 12:18:55 -0000	1.3
  @@ -62,7 +62,7 @@
   
   /**
    * <code>SynchronizedCollection</code> decorates another <code>Collection</code>
  - * to synchronize the method calls.
  + * to synchronize its behaviour for a multi-threaded environment.
    * <p>
    * Iterators must be manually synchronized:
    * <pre>
  
  
  
  1.4       +4 -7      jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/UnmodifiableCollection.java
  
  Index: UnmodifiableCollection.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/UnmodifiableCollection.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- UnmodifiableCollection.java	7 May 2003 11:20:21 -0000	1.3
  +++ UnmodifiableCollection.java	7 May 2003 12:18:55 -0000	1.4
  @@ -63,11 +63,8 @@
   import org.apache.commons.collections.IteratorUtils;
   
   /**
  - * <code>PredicatedCollection</code> decorates another <code>Collection</code>
  - * to validate addition match a specified predicate.
  - * <p>
  - * If an object cannot be addded to the collection, an IllegalArgumentException
  - * is thrown.
  + * <code>UnmodifiableCollection</code> decorates another <code>Collection</code>
  + * to ensure it can't be altered.
    *
    * @since Commons Collections 3.0
    * @version $Revision$ $Date$
  
  
  
  1.4       +4 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/SynchronizedList.java
  
  Index: SynchronizedList.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/SynchronizedList.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- SynchronizedList.java	7 May 2003 11:20:21 -0000	1.3
  +++ SynchronizedList.java	7 May 2003 12:18:55 -0000	1.4
  @@ -62,7 +62,8 @@
   import java.util.ListIterator;
   
   /**
  - * <code>SynchronizedList</code> decorates another <code>List</code>.
  + * <code>SynchronizedList</code> decorates another <code>List</code>
  + * to synchronize its behaviour for a multi-threaded environment.
    * <p>
    * Methods are synchronized, then forwarded to the decorated list.
    *
  
  
  
  1.2       +4 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/SynchronizedSortedSet.java
  
  Index: SynchronizedSortedSet.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/SynchronizedSortedSet.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- SynchronizedSortedSet.java	7 May 2003 11:19:46 -0000	1.1
  +++ SynchronizedSortedSet.java	7 May 2003 12:18:55 -0000	1.2
  @@ -61,7 +61,8 @@
   import java.util.SortedSet;
   
   /**
  - * <code>SynchronizedSortedSet</code> decorates another <code>SortedSet</code>.
  + * <code>SynchronizedSortedSet</code> decorates another <code>SortedSet</code>
  + * to synchronize its behaviour for a multi-threaded environment.
    * <p>
    * Methods are synchronized, then forwarded to the decorated set.
    *
  
  
  
  1.4       +4 -4      jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/FixedSizeList.java
  
  Index: FixedSizeList.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/FixedSizeList.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- FixedSizeList.java	7 May 2003 11:20:21 -0000	1.3
  +++ FixedSizeList.java	7 May 2003 12:18:55 -0000	1.4
  @@ -62,8 +62,8 @@
   import java.util.ListIterator;
   
   /**
  - * <code>FixedSizeList</code> decorates another <code>List</code> to
  - * fix the size.
  + * <code>FixedSizeList</code> decorates another <code>List</code>
  + * to fix the size.
    * <p>
    * The add, remove, clear and retain operations are unsupported.
    * The set method is allowed (as it doesn't change the list size).
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org