Improve documentation

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131454 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2003-12-25 00:33:04 +00:00
parent 32200eb896
commit 5c1a8d15f0
3 changed files with 12 additions and 4 deletions

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/bidimap/DualTreeBidiMap.java,v 1.5 2003/12/01 22:49:00 scolebourne Exp $ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/bidimap/DualTreeBidiMap.java,v 1.6 2003/12/25 00:33:04 scolebourne Exp $
* ==================================================================== * ====================================================================
* *
* The Apache Software License, Version 1.1 * The Apache Software License, Version 1.1
@ -88,7 +88,7 @@ import org.apache.commons.collections.map.AbstractSortedMapDecorator;
* not store each object twice, which can save on memory use. * not store each object twice, which can save on memory use.
* *
* @since Commons Collections 3.0 * @since Commons Collections 3.0
* @version $Id: DualTreeBidiMap.java,v 1.5 2003/12/01 22:49:00 scolebourne Exp $ * @version $Id: DualTreeBidiMap.java,v 1.6 2003/12/25 00:33:04 scolebourne Exp $
* *
* @author Matthew Hawthorne * @author Matthew Hawthorne
* @author Stephen Colebourne * @author Stephen Colebourne
@ -243,6 +243,9 @@ public class DualTreeBidiMap extends AbstractDualBidiMap implements SortedBidiMa
} }
//----------------------------------------------------------------------- //-----------------------------------------------------------------------
/**
* Internal sorted map view.
*/
protected static class ViewMap extends AbstractSortedMapDecorator { protected static class ViewMap extends AbstractSortedMapDecorator {
final DualTreeBidiMap bidi; final DualTreeBidiMap bidi;

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/collection/SynchronizedCollection.java,v 1.1 2003/11/16 00:05:47 scolebourne Exp $ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/collection/SynchronizedCollection.java,v 1.2 2003/12/25 00:33:04 scolebourne Exp $
* ==================================================================== * ====================================================================
* *
* The Apache Software License, Version 1.1 * The Apache Software License, Version 1.1
@ -70,9 +70,10 @@ import java.util.Iterator;
* Iterator it = coll.iterator(); * Iterator it = coll.iterator();
* // do stuff with iterator * // do stuff with iterator
* } * }
* </pre>
* *
* @since Commons Collections 3.0 * @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/11/16 00:05:47 $ * @version $Revision: 1.2 $ $Date: 2003/12/25 00:33:04 $
* *
* @author Stephen Colebourne * @author Stephen Colebourne
*/ */

View File

@ -10,6 +10,10 @@ specific additional functionality.
<p> <p>
The following implementations are provided in the package: The following implementations are provided in the package:
<ul> <ul>
<li>CompositeSet - a set that combines multiple sets into one
</ul>
The following decorators are provided in the package:
<ul>
<li>Synchronized - synchronizes method access for multi-threaded environments <li>Synchronized - synchronizes method access for multi-threaded environments
<li>Unmodifiable - ensures the collection cannot be altered <li>Unmodifiable - ensures the collection cannot be altered
<li>Predicated - ensures that only elements that are valid according to a predicate can be added <li>Predicated - ensures that only elements that are valid according to a predicate can be added