Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc improvements 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131046 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2003-05-07 12:18:55 +00:00
parent db5765e6be
commit 7eb41b7cdd
6 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/java/org/apache/commons/collections/decorators/FixedSizeList.java
View File

@ -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 * The Apache Software License, Version 1.1
@ -62,14 +62,14 @@ import java.util.List;
import java.util.ListIterator; import java.util.ListIterator;
/** /**
* <code>FixedSizeList</code> decorates another <code>List</code> to * <code>FixedSizeList</code> decorates another <code>List</code>
* fix the size. * to fix the size.
* <p> * <p>
* The add, remove, clear and retain operations are unsupported. * The add, remove, clear and retain operations are unsupported.
* The set method is allowed (as it doesn't change the list size). * The set method is allowed (as it doesn't change the list size).
* *
* @since Commons Collections 3.0 * @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 Stephen Colebourne
* @author Paul Jack * @author Paul Jack

6
src/java/org/apache/commons/collections/decorators/SynchronizedCollection.java
View File

@ -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 * The Apache Software License, Version 1.1
@ -62,7 +62,7 @@ import java.util.Iterator;
/** /**
* <code>SynchronizedCollection</code> decorates another <code>Collection</code> * <code>SynchronizedCollection</code> decorates another <code>Collection</code>
* to synchronize the method calls. * to synchronize its behaviour for a multi-threaded environment.
* <p> * <p>
* Iterators must be manually synchronized: * Iterators must be manually synchronized:
* <pre> * <pre>
@ -72,7 +72,7 @@ import java.util.Iterator;
* } * }
* *
* @since Commons Collections 3.0 * @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 * @author Stephen Colebourne
*/ */

7
src/java/org/apache/commons/collections/decorators/SynchronizedList.java
View File

@ -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 * The Apache Software License, Version 1.1
@ -62,12 +62,13 @@ import java.util.List;
import java.util.ListIterator; 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> * <p>
* Methods are synchronized, then forwarded to the decorated list. * Methods are synchronized, then forwarded to the decorated list.
* *
* @since Commons Collections 3.0 * @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 Stephen Colebourne
*/ */

7
src/java/org/apache/commons/collections/decorators/SynchronizedSet.java
View File

@ -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 * The Apache Software License, Version 1.1
@ -60,12 +60,13 @@ package org.apache.commons.collections.decorators;
import java.util.Set; 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> * <p>
* Methods are synchronized, then forwarded to the decorated set. * Methods are synchronized, then forwarded to the decorated set.
* *
* @since Commons Collections 3.0 * @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 * @author Stephen Colebourne
*/ */

7
src/java/org/apache/commons/collections/decorators/SynchronizedSortedSet.java
View File

@ -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 * The Apache Software License, Version 1.1
@ -61,12 +61,13 @@ import java.util.Comparator;
import java.util.SortedSet; 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> * <p>
* Methods are synchronized, then forwarded to the decorated set. * Methods are synchronized, then forwarded to the decorated set.
* *
* @since Commons Collections 3.0 * @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 * @author Stephen Colebourne
*/ */

11
src/java/org/apache/commons/collections/decorators/UnmodifiableCollection.java
View File

@ -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 * The Apache Software License, Version 1.1
@ -63,14 +63,11 @@ import java.util.Iterator;
import org.apache.commons.collections.IteratorUtils; import org.apache.commons.collections.IteratorUtils;
/** /**
* <code>PredicatedCollection</code> decorates another <code>Collection</code> * <code>UnmodifiableCollection</code> decorates another <code>Collection</code>
* to validate addition match a specified predicate. * to ensure it can't be altered.
* <p>
* If an object cannot be addded to the collection, an IllegalArgumentException
* is thrown.
* *
* @since Commons Collections 3.0 * @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 Stephen Colebourne
*/ */