commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scolebou...@apache.org
Subject cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections/map HashedMap.java StaticBucketMap.java ReferenceMap.java
Date Sun, 28 Dec 2003 16:36:48 GMT
scolebourne    2003/12/28 08:36:48

  Modified:    collections/src/java/org/apache/commons/collections/bag
                        TreeBag.java AbstractMapBag.java HashBag.java
               collections/src/java/org/apache/commons/collections
                        HashBag.java TreeBag.java
               collections/src/java/org/apache/commons/collections/buffer
                        BoundedFifoBuffer.java UnboundedFifoBuffer.java
                        BinaryHeap.java
               collections/src/java/org/apache/commons/collections/map
                        HashedMap.java StaticBucketMap.java
                        ReferenceMap.java
  Log:
  Improve documentation
  
  Revision  Changes    Path
  1.4       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/bag/TreeBag.java
  
  Index: TreeBag.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bag/TreeBag.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- TreeBag.java	28 Dec 2003 14:55:46 -0000	1.3
  +++ TreeBag.java	28 Dec 2003 16:36:48 -0000	1.4
  @@ -81,7 +81,7 @@
    * interface javadoc carefully as several methods violate the
    * <code>Collection</code> interface specification.
    *
  - * @since Commons Collections 3.0
  + * @since Commons Collections 3.0 (previously in main package v2.0)
    * @version $Revision$ $Date$
    * 
    * @author Chuck Burdick
  
  
  
  1.9       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/bag/AbstractMapBag.java
  
  Index: AbstractMapBag.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bag/AbstractMapBag.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- AbstractMapBag.java	28 Dec 2003 14:46:28 -0000	1.8
  +++ AbstractMapBag.java	28 Dec 2003 16:36:48 -0000	1.9
  @@ -78,7 +78,7 @@
    * The map will be used to map bag elements to a number; the number represents
    * the number of occurrences of that element in the bag.
    *
  - * @since Commons Collections 3.0
  + * @since Commons Collections 3.0 (previously DefaultMapBag v2.0)
    * @version $Revision$ $Date$
    * 
    * @author Chuck Burdick
  
  
  
  1.4       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/bag/HashBag.java
  
  Index: HashBag.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bag/HashBag.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- HashBag.java	28 Dec 2003 14:55:46 -0000	1.3
  +++ HashBag.java	28 Dec 2003 16:36:48 -0000	1.4
  @@ -76,7 +76,7 @@
    * interface javadoc carefully as several methods violate the
    * <code>Collection</code> interface specification.
    *
  - * @since Commons Collections 3.0
  + * @since Commons Collections 3.0 (previously in main package v2.0)
    * @version $Revision$ $Date$
    * 
    * @author Chuck Burdick
  
  
  
  1.11      +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/HashBag.java
  
  Index: HashBag.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/HashBag.java,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- HashBag.java	2 Dec 2003 23:36:12 -0000	1.10
  +++ HashBag.java	28 Dec 2003 16:36:48 -0000	1.11
  @@ -63,7 +63,7 @@
   /**
    * A {@link Bag} that is backed by a {@link HashMap}.
    *
  - * @deprecated Moved to bag subpackage. Due to be removed in v4.0.
  + * @deprecated Moved to bag subpackage and rewritten internally. Due to be removed in v4.0.
    * @since Commons Collections 2.0
    * @version $Revision$ $Date$
    * 
  
  
  
  1.11      +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/TreeBag.java
  
  Index: TreeBag.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/TreeBag.java,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- TreeBag.java	2 Dec 2003 23:36:12 -0000	1.10
  +++ TreeBag.java	28 Dec 2003 16:36:48 -0000	1.11
  @@ -67,7 +67,7 @@
    * Order will be maintained among the unique representative
    * members.
    *
  - * @deprecated Moved to bag subpackage. Due to be removed in v4.0.
  + * @deprecated Moved to bag subpackage and rewritten internally. Due to be removed in v4.0.
    * @since Commons Collections 2.0
    * @version $Revision$ $Date$
    * 
  
  
  
  1.3       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/BoundedFifoBuffer.java
  
  Index: BoundedFifoBuffer.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/BoundedFifoBuffer.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- BoundedFifoBuffer.java	29 Nov 2003 18:14:20 -0000	1.2
  +++ BoundedFifoBuffer.java	28 Dec 2003 16:36:48 -0000	1.3
  @@ -88,7 +88,7 @@
    * <p>
    * This buffer prevents null objects from being added.
    *
  - * @since Commons Collections 3.0
  + * @since Commons Collections 3.0 (previously in main package v2.1)
    * @version $Revision$ $Date$
    * 
    * @author Avalon
  
  
  
  1.2       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java
  
  Index: UnboundedFifoBuffer.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/UnboundedFifoBuffer.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- UnboundedFifoBuffer.java	29 Nov 2003 18:04:57 -0000	1.1
  +++ UnboundedFifoBuffer.java	28 Dec 2003 16:36:48 -0000	1.2
  @@ -85,7 +85,7 @@
    * <p>
    * This buffer prevents null objects from being added.
    * 
  - * @since Commons Collections 3.0
  + * @since Commons Collections 3.0 (previously in main package v2.1)
    * @version $Revision$ $Date$
    *
    * @author Avalon
  
  
  
  1.2       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/BinaryHeap.java
  
  Index: BinaryHeap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/BinaryHeap.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- BinaryHeap.java	29 Nov 2003 18:04:57 -0000	1.1
  +++ BinaryHeap.java	28 Dec 2003 16:36:48 -0000	1.2
  @@ -90,7 +90,7 @@
    * Buffer heap = BufferUtils.synchronizedBuffer(new BinaryHeap());
    * </pre>
    *
  - * @since Commons Collections 3.0
  + * @since Commons Collections 3.0 (previously in main package v1.0)
    * @version $Revision$ $Date$
    * 
    * @author Peter Donald
  
  
  
  1.10      +5 -5      jakarta-commons/collections/src/java/org/apache/commons/collections/map/HashedMap.java
  
  Index: HashedMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/map/HashedMap.java,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- HashedMap.java	7 Dec 2003 23:59:13 -0000	1.9
  +++ HashedMap.java	28 Dec 2003 16:36:48 -0000	1.10
  @@ -64,12 +64,12 @@
   import java.util.Map;
   
   /**
  - * A <code>Map</code> implementation that is a general purpose replacement
  - * for <code>HashMap</code>.
  + * A <code>Map</code> implementation that is a general purpose alternative
  + * to <code>HashMap</code>.
    * <p>
    * This implementation improves on the JDK1.4 HahMap by adding the 
    * {@link org.apache.commons.collections.iterators.MapIterator MapIterator}
  - * functionality and improving performance of <code>putAll</code>.
  + * functionality and many methods for subclassing.
    * <p>
    * @since Commons Collections 3.0
    * @version $Revision$ $Date$
  
  
  
  1.4       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/map/StaticBucketMap.java
  
  Index: StaticBucketMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/map/StaticBucketMap.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- StaticBucketMap.java	14 Dec 2003 13:00:03 -0000	1.3
  +++ StaticBucketMap.java	28 Dec 2003 16:36:48 -0000	1.4
  @@ -131,7 +131,7 @@
    * iterations, or if you can make your own guarantees about how bulk 
    * operations will affect the map.<p>
    *
  - * @since Commons Collections 3.0
  + * @since Commons Collections 3.0 (previously in main package v2.1)
    * @version $Revision$ $Date$
    * 
    * @author Berin Loritsch
  
  
  
  1.4       +38 -38    jakarta-commons/collections/src/java/org/apache/commons/collections/map/ReferenceMap.java
  
  Index: ReferenceMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/map/ReferenceMap.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- ReferenceMap.java	6 Dec 2003 13:03:15 -0000	1.3
  +++ ReferenceMap.java	28 Dec 2003 16:36:48 -0000	1.4
  @@ -80,45 +80,45 @@
   import org.apache.commons.collections.keyvalue.DefaultMapEntry;
   
   /**
  - *  Hash-based {@link Map} implementation that allows
  - *  mappings to be removed by the garbage collector.<p>
  - *
  - *  When you construct a <code>ReferenceMap</code>, you can 
  - *  specify what kind of references are used to store the
  - *  map's keys and values.  If non-hard references are 
  - *  used, then the garbage collector can remove mappings
  - *  if a key or value becomes unreachable, or if the 
  - *  JVM's memory is running low.  For information on how
  - *  the different reference types behave, see
  - *  {@link Reference}.<p>
  - *
  - *  Different types of references can be specified for keys
  - *  and values.  The keys can be configured to be weak but
  - *  the values hard, in which case this class will behave
  - *  like a <a href="http://java.sun.com/j2se/1.4/docs/api/java/util/WeakHashMap.html">
  - *  <code>WeakHashMap</code></a>.  However, you
  - *  can also specify hard keys and weak values, or any other
  - *  combination.  The default constructor uses hard keys
  - *  and soft values, providing a memory-sensitive cache.<p>
  - *
  - *  The algorithms used are basically the same as those
  - *  in {@link java.util.HashMap}.  In particular, you 
  - *  can specify a load factor and capacity to suit your
  - *  needs.  All optional {@link Map} operations are 
  - *  supported.<p>
  - *
  - *  However, this {@link Map} implementation does <I>not</I>
  - *  allow null elements.  Attempting to add a null key or
  - *  or a null value to the map will raise a 
  - *  <code>NullPointerException</code>.<p>
  - *
  - *  As usual, this implementation is not synchronized.  You
  - *  can use {@link java.util.Collections#synchronizedMap} to 
  - *  provide synchronized access to a <code>ReferenceMap</code>.
  + * Hash-based <code>Map</code> implementation that allows
  + * mappings to be removed by the garbage collector.
  + * <p>
  + * When you construct a <code>ReferenceMap</code>, you can 
  + * specify what kind of references are used to store the
  + * map's keys and values.  If non-hard references are 
  + * used, then the garbage collector can remove mappings
  + * if a key or value becomes unreachable, or if the 
  + * JVM's memory is running low.  For information on how
  + * the different reference types behave, see
  + * {@link Reference}.
  + * <p>
  + * Different types of references can be specified for keys
  + * and values.  The keys can be configured to be weak but
  + * the values hard, in which case this class will behave
  + * like a <a href="http://java.sun.com/j2se/1.4/docs/api/java/util/WeakHashMap.html">
  + * <code>WeakHashMap</code></a>.  However, you
  + * can also specify hard keys and weak values, or any other
  + * combination.  The default constructor uses hard keys
  + * and soft values, providing a memory-sensitive cache.
  + * <p>
  + * The algorithms used are basically the same as those
  + * in {@link java.util.HashMap}.  In particular, you 
  + * can specify a load factor and capacity to suit your
  + * needs.  All optional {@link Map} operations are 
  + * supported.
  + * <p>
  + * However, this {@link Map} implementation does <I>not</I>
  + * allow null elements.  Attempting to add a null key or
  + * or a null value to the map will raise a 
  + * <code>NullPointerException</code>.
  + * <p>
  + * As usual, this implementation is not synchronized.  You
  + * can use {@link java.util.Collections#synchronizedMap} to 
  + * provide synchronized access to a <code>ReferenceMap</code>.
    *
    * @see java.lang.ref.Reference
    * 
  - * @since Commons Collections 3.0
  + * @since Commons Collections 3.0 (previously in main package v2.1)
    * @version $Revision$ $Date$
    * 
    * @author Paul Jack
  
  
  

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


Mime
View raw message