commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pste...@apache.org
Subject cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections/map AbstractHashedMap.java LRUMap.java
Date Fri, 02 Jan 2004 01:36:52 GMT
psteitz     2004/01/01 17:36:52

  Modified:    collections/src/java/org/apache/commons/collections
                        BinaryHeap.java
               collections/src/java/org/apache/commons/collections/bag
                        AbstractMapBag.java
               collections/src/java/org/apache/commons/collections/bidimap
                        DualTreeBidiMap.java TreeBidiMap.java
               collections/src/java/org/apache/commons/collections/buffer
                        BinaryBuffer.java
               collections/src/java/org/apache/commons/collections/functors
                        ChainedTransformer.java IfClosure.java
                        InstanceofPredicate.java MapTransformer.java
               collections/src/java/org/apache/commons/collections/list
                        NodeCachingLinkedList.java
               collections/src/java/org/apache/commons/collections/map
                        AbstractHashedMap.java LRUMap.java
  Log:
  javadoc.
  
  Revision  Changes    Path
  1.18      +1 -1      jakarta-commons/collections/src/java/org/apache/commons/collections/BinaryHeap.java
  
  Index: BinaryHeap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/BinaryHeap.java,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  --- BinaryHeap.java	1 Jan 2004 23:56:51 -0000	1.17
  +++ BinaryHeap.java	2 Jan 2004 01:36:51 -0000	1.18
  @@ -419,7 +419,7 @@
        * <p>
        * Assume it is a maximum heap.
        *
  -     * @param element the element
  +     * @param index the index of the element to be percolated up
        */
       protected void percolateUpMaxHeap(final int index) {
           int hole = index;
  
  
  
  1.10      +4 -5      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.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- AbstractMapBag.java	28 Dec 2003 16:36:48 -0000	1.9
  +++ AbstractMapBag.java	2 Jan 2004 01:36:51 -0000	1.10
  @@ -4,7 +4,7 @@
    *
    * The Apache Software License, Version 1.1
    *
  - * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
  + * Copyright (c) 2002-2004 The Apache Software Foundation.  All rights
    * reserved.
    *
    * Redistribution and use in source and binary forms, with or without
  @@ -100,7 +100,6 @@
       /**
        * Constructor needed for subclass serialisation.
        * 
  -     * @param map  the map to assign
        */
       protected AbstractMapBag() {
           super();
  @@ -542,7 +541,7 @@
        * This Bag equals another Bag if it contains the same number of occurances of
        * the same elements.
        * 
  -     * @param obj  the Bag to compare to
  +     * @param object  the Bag to compare to
        * @return true if equal
        */
       public boolean equals(Object object) {
  
  
  
  1.8       +5 -5      jakarta-commons/collections/src/java/org/apache/commons/collections/bidimap/DualTreeBidiMap.java
  
  Index: DualTreeBidiMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bidimap/DualTreeBidiMap.java,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- DualTreeBidiMap.java	29 Dec 2003 00:38:08 -0000	1.7
  +++ DualTreeBidiMap.java	2 Jan 2004 01:36:51 -0000	1.8
  @@ -4,7 +4,7 @@
    *
    * The Apache Software License, Version 1.1
    *
  - * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
  + * Copyright (c) 2001-2004 The Apache Software Foundation.  All rights
    * reserved.
    *
    * Redistribution and use in source and binary forms, with or without
  @@ -123,7 +123,7 @@
       /** 
        * Constructs a <code>DualTreeBidiMap</code> using the specified Comparator.
        *
  -     * @param map  the map whose mappings are to be placed in this map
  +     * @param comparator  the Comparator
        */
       public DualTreeBidiMap(Comparator comparator) {
           super();
  @@ -156,7 +156,7 @@
        * 
        * @param normalMap  the normal direction map
        * @param reverseMap  the reverse direction map
  -     * @param inverseBidiMap  the inverse BidiMap
  +     * @param inverseMap  the inverse BidiMap
        * @return new bidi map
        */
       protected BidiMap createBidiMap(Map normalMap, Map reverseMap, BidiMap inverseMap)
{
  
  
  
  1.7       +5 -6      jakarta-commons/collections/src/java/org/apache/commons/collections/bidimap/TreeBidiMap.java
  
  Index: TreeBidiMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bidimap/TreeBidiMap.java,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- TreeBidiMap.java	6 Dec 2003 13:03:15 -0000	1.6
  +++ TreeBidiMap.java	2 Jan 2004 01:36:51 -0000	1.7
  @@ -4,7 +4,7 @@
    *
    * The Apache Software License, Version 1.1
    *
  - * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
  + * Copyright (c) 2001-2004 The Apache Software Foundation.  All rights
    * reserved.
    *
    * Redistribution and use in source and binary forms, with or without
  @@ -333,7 +333,7 @@
       /**
        * Gets the next key after the one specified.
        *
  -     * @param the key to search for next from
  +     * @param key the key to search for next from
        * @return the next key, null if no match or at end
        */
       public Object nextKey(Object key) {
  @@ -345,7 +345,7 @@
       /**
        * Gets the previous key before the one specified.
        *
  -     * @param the key to search for previous from
  +     * @param key the key to search for previous from
        * @return the previous key, null if no match or at start
        */
       public Object previousKey(Object key) {
  @@ -473,7 +473,6 @@
        * Compares for equals as per the API.
        *
        * @param obj  the object to compare to
  -     * @param index  the KEY or VALUE int
        * @return true if equal
        */
       public boolean equals(Object obj) {
  
  
  
  1.3       +1 -1      jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/BinaryBuffer.java
  
  Index: BinaryBuffer.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/buffer/BinaryBuffer.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- BinaryBuffer.java	1 Jan 2004 23:56:51 -0000	1.2
  +++ BinaryBuffer.java	2 Jan 2004 01:36:51 -0000	1.3
  @@ -439,7 +439,7 @@
        * <p>
        * Assume it is a maximum heap.
        *
  -     * @param element the element
  +     * @param index the index of the element to be percolated up
        */
       protected void percolateUpMaxHeap(final int index) {
           int hole = index;
  
  
  
  1.2       +4 -4      jakarta-commons/collections/src/java/org/apache/commons/collections/functors/ChainedTransformer.java
  
  Index: ChainedTransformer.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/ChainedTransformer.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- ChainedTransformer.java	23 Nov 2003 23:25:33 -0000	1.1
  +++ ChainedTransformer.java	2 Jan 2004 01:36:51 -0000	1.2
  @@ -4,7 +4,7 @@
    *
    * The Apache Software License, Version 1.1
    *
  - * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
  + * Copyright (c) 2001-2004 The Apache Software Foundation.  All rights
    * reserved.
    *
    * Redistribution and use in source and binary forms, with or without
  @@ -153,7 +153,7 @@
       /**
        * Execute a list of transformers.
        * 
  -     * @param input  the input object passed to each transformer
  +     * @param object  the input object passed to each transformer
        */
       public Object transform(Object object) {
           for (int i = 0; i < iTransformers.length; i++) {
  
  
  
  1.2       +8 -9      jakarta-commons/collections/src/java/org/apache/commons/collections/functors/IfClosure.java
  
  Index: IfClosure.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/IfClosure.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- IfClosure.java	23 Nov 2003 17:01:35 -0000	1.1
  +++ IfClosure.java	2 Jan 2004 01:36:51 -0000	1.2
  @@ -4,7 +4,7 @@
    *
    * The Apache Software License, Version 1.1
    *
  - * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
  + * Copyright (c) 2001-2004 The Apache Software Foundation.  All rights
    * reserved.
    *
    * Redistribution and use in source and binary forms, with or without
  @@ -86,12 +86,11 @@
       /**
        * Factory method that performs validation.
        * 
  -     * @param predicates  array of predicates, cloned, no nulls
  -     * @param closures  matching array of closures, cloned, no nulls
  -     * @param defaultClosure  the closure to use if no match, null means nop
  -     * @return the <code>chained</code> closure
  -     * @throws IllegalArgumentException if array is null
  -     * @throws IllegalArgumentException if any element in the array is null
  +     * @param predicate  predicate to switch on
  +     * @param trueClosure  closure used if true
  +     * @param falseClosure  closure used if false
  +     * @return the <code>if</code> closure
  +     * @throws IllegalArgumentException if any argument is null
        */
       public static Closure getInstance(Predicate predicate, Closure trueClosure, Closure
falseClosure) {
           if (predicate == null) {
  
  
  
  1.2       +4 -4      jakarta-commons/collections/src/java/org/apache/commons/collections/functors/InstanceofPredicate.java
  
  Index: InstanceofPredicate.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/InstanceofPredicate.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- InstanceofPredicate.java	23 Nov 2003 19:11:21 -0000	1.1
  +++ InstanceofPredicate.java	2 Jan 2004 01:36:51 -0000	1.2
  @@ -4,7 +4,7 @@
    *
    * The Apache Software License, Version 1.1
    *
  - * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
  + * Copyright (c) 2001-2004 The Apache Software Foundation.  All rights
    * reserved.
    *
    * Redistribution and use in source and binary forms, with or without
  @@ -96,7 +96,7 @@
        * Constructor that performs no validation.
        * Use <code>getInstance</code> if you want that.
        * 
  -     * @param object  the object to compare to
  +     * @param type  the type to check for
        */
       public InstanceofPredicate(Class type) {
           super();
  
  
  
  1.3       +4 -4      jakarta-commons/collections/src/java/org/apache/commons/collections/functors/MapTransformer.java
  
  Index: MapTransformer.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/functors/MapTransformer.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- MapTransformer.java	27 Nov 2003 23:57:09 -0000	1.2
  +++ MapTransformer.java	2 Jan 2004 01:36:51 -0000	1.3
  @@ -4,7 +4,7 @@
    *
    * The Apache Software License, Version 1.1
    *
  - * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
  + * Copyright (c) 2001-2004 The Apache Software Foundation.  All rights
    * reserved.
    *
    * Redistribution and use in source and binary forms, with or without
  @@ -84,7 +84,7 @@
        * <p>
        * If the map is null, a transformer that always returns null is returned.
        * 
  -     * @param the map, not cloned
  +     * @param map the map, not cloned
        * @return the transformer
        */
       public static Transformer getInstance(Map map) {
  
  
  
  1.4       +3 -4      jakarta-commons/collections/src/java/org/apache/commons/collections/list/NodeCachingLinkedList.java
  
  Index: NodeCachingLinkedList.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/list/NodeCachingLinkedList.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- NodeCachingLinkedList.java	29 Dec 2003 01:04:44 -0000	1.3
  +++ NodeCachingLinkedList.java	2 Jan 2004 01:36:52 -0000	1.4
  @@ -4,7 +4,7 @@
    *
    * The Apache Software License, Version 1.1
    *
  - * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
  + * Copyright (c) 2001-2004 The Apache Software Foundation.  All rights
    * reserved.
    *
    * Redistribution and use in source and binary forms, with or without
  @@ -252,7 +252,6 @@
        * Removes all the nodes from the list, storing as many as required in the
        * cache for reuse.
        * 
  -     * @param node  the node to remove
        */
       protected void removeAllNodes() {
           // Add the removed nodes to the cache, then remove the rest.
  
  
  
  1.5       +5 -8      jakarta-commons/collections/src/java/org/apache/commons/collections/map/AbstractHashedMap.java
  
  Index: AbstractHashedMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/map/AbstractHashedMap.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- AbstractHashedMap.java	29 Dec 2003 00:38:08 -0000	1.4
  +++ AbstractHashedMap.java	2 Jan 2004 01:36:52 -0000	1.5
  @@ -4,7 +4,7 @@
    *
    * The Apache Software License, Version 1.1
    *
  - * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
  + * Copyright (c) 2001-2004 The Apache Software Foundation.  All rights
    * reserved.
    *
    * Redistribution and use in source and binary forms, with or without
  @@ -550,12 +550,9 @@
        * <p>
        * This implementation adds the entry to the data storage table.
        * Subclasses could override to handle changes to the map.
  -     * 
  +     *
  +     * @param entry  the entry to add
        * @param hashIndex  the index into the data array to store at
  -     * @param hashCode  the hash code of the key to add
  -     * @param key  the key to add
  -     * @param value  the value to add
  -     * @return the value previously mapped to this key, null if none
        */
       protected void addEntry(HashEntry entry, int hashIndex) {
           data[hashIndex] = entry;
  
  
  
  1.5       +3 -5      jakarta-commons/collections/src/java/org/apache/commons/collections/map/LRUMap.java
  
  Index: LRUMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/map/LRUMap.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- LRUMap.java	11 Dec 2003 22:55:25 -0000	1.4
  +++ LRUMap.java	2 Jan 2004 01:36:52 -0000	1.5
  @@ -4,7 +4,7 @@
    *
    * The Apache Software License, Version 1.1
    *
  - * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
  + * Copyright (c) 2001-2004 The Apache Software Foundation.  All rights
    * reserved.
    *
    * Redistribution and use in source and binary forms, with or without
  @@ -173,8 +173,6 @@
        * This implementation moves the updated entry to the end of the list.
        * 
        * @param entry  the entry to update
  -     * @param newValue  the new value to store
  -     * @return value  the previous value
        */
       protected void moveToMRU(LinkEntry entry) {
           if (entry.after != header) {
  
  
  

---------------------------------------------------------------------
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