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/bidimap UnmodifiableOrderedBidiMap.java AbstractDualBidiMap.java UnmodifiableBidiMap.java DualTreeBidiMap.java UnmodifiableSortedBidiMap.java
Date Sat, 15 May 2004 12:13:03 GMT
scolebourne    2004/05/15 05:13:03

  Modified:    collections/src/java/org/apache/commons/collections/bidimap
                        UnmodifiableOrderedBidiMap.java
                        AbstractDualBidiMap.java UnmodifiableBidiMap.java
                        DualTreeBidiMap.java UnmodifiableSortedBidiMap.java
  Log:
  Javadoc
  
  Revision  Changes    Path
  1.5       +4 -1      jakarta-commons/collections/src/java/org/apache/commons/collections/bidimap/UnmodifiableOrderedBidiMap.java
  
  Index: UnmodifiableOrderedBidiMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bidimap/UnmodifiableOrderedBidiMap.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- UnmodifiableOrderedBidiMap.java	18 Feb 2004 00:57:39 -0000	1.4
  +++ UnmodifiableOrderedBidiMap.java	15 May 2004 12:13:03 -0000	1.5
  @@ -45,8 +45,11 @@
   
       /**
        * Factory method to create an unmodifiable map.
  +     * <p>
  +     * If the map passed in is already unmodifiable, it is returned.
        * 
        * @param map  the map to decorate, must not be null
  +     * @return an unmodifiable OrderedBidiMap
        * @throws IllegalArgumentException if map is null
        */
       public static OrderedBidiMap decorate(OrderedBidiMap map) {
  
  
  
  1.12      +25 -1     jakarta-commons/collections/src/java/org/apache/commons/collections/bidimap/AbstractDualBidiMap.java
  
  Index: AbstractDualBidiMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bidimap/AbstractDualBidiMap.java,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- AbstractDualBidiMap.java	1 Apr 2004 22:18:12 -0000	1.11
  +++ AbstractDualBidiMap.java	15 May 2004 12:13:03 -0000	1.12
  @@ -401,6 +401,11 @@
           /** Whether remove is allowed at present */
           protected boolean canRemove = false;
           
  +        /**
  +         * Constructor.
  +         * @param iterator  the iterator to decorate
  +         * @param parent  the parent map
  +         */
           protected KeySetIterator(Iterator iterator, AbstractDualBidiMap parent) {
               super(iterator);
               this.parent = parent;
  @@ -469,6 +474,11 @@
           /** Whether remove is allowed at present */
           protected boolean canRemove = false;
           
  +        /**
  +         * Constructor.
  +         * @param iterator  the iterator to decorate
  +         * @param parent  the parent map
  +         */
           protected ValuesIterator(Iterator iterator, AbstractDualBidiMap parent) {
               super(iterator);
               this.parent = parent;
  @@ -540,6 +550,11 @@
           /** Whether remove is allowed at present */
           protected boolean canRemove = false;
           
  +        /**
  +         * Constructor.
  +         * @param iterator  the iterator to decorate
  +         * @param parent  the parent map
  +         */
           protected EntrySetIterator(Iterator iterator, AbstractDualBidiMap parent) {
               super(iterator);
               this.parent = parent;
  @@ -572,6 +587,11 @@
           /** The parent map */        
           protected final AbstractDualBidiMap parent;
           
  +        /**
  +         * Constructor.
  +         * @param entry  the entry to decorate
  +         * @param parent  the parent map
  +         */
           protected MapEntry(Map.Entry entry, AbstractDualBidiMap parent) {
               super(entry);
               this.parent = parent;
  @@ -603,6 +623,10 @@
           /** Whether remove is allowed at present */
           protected boolean canRemove = false;
           
  +        /**
  +         * Constructor.
  +         * @param parent  the parent map
  +         */
           protected BidiMapIterator(AbstractDualBidiMap parent) {
               super();
               this.parent = parent;
  
  
  
  1.5       +4 -1      jakarta-commons/collections/src/java/org/apache/commons/collections/bidimap/UnmodifiableBidiMap.java
  
  Index: UnmodifiableBidiMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bidimap/UnmodifiableBidiMap.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- UnmodifiableBidiMap.java	18 Feb 2004 00:57:39 -0000	1.4
  +++ UnmodifiableBidiMap.java	15 May 2004 12:13:03 -0000	1.5
  @@ -43,8 +43,11 @@
   
       /**
        * Factory method to create an unmodifiable map.
  +     * <p>
  +     * If the map passed in is already unmodifiable, it is returned.
        * 
        * @param map  the map to decorate, must not be null
  +     * @return an unmodifiable BidiMap
        * @throws IllegalArgumentException if map is null
        */
       public static BidiMap decorate(BidiMap map) {
  
  
  
  1.13      +13 -1     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.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- DualTreeBidiMap.java	18 Feb 2004 00:57:39 -0000	1.12
  +++ DualTreeBidiMap.java	15 May 2004 12:13:03 -0000	1.13
  @@ -172,6 +172,8 @@
        * <p>
        * This implementation copies the elements to an ArrayList in order to
        * provide the forward/backward behaviour.
  +     * 
  +     * @return a new ordered map iterator
        */
       public OrderedMapIterator orderedMapIterator() {
           return new BidiOrderedMapIterator(this);
  @@ -206,8 +208,14 @@
        * Internal sorted map view.
        */
       protected static class ViewMap extends AbstractSortedMapDecorator {
  +        /** The parent bidi map. */
           final DualTreeBidiMap bidi;
           
  +        /**
  +         * Constructor.
  +         * @param bidi  the parent bidi map
  +         * @param sm  the subMap sorted map
  +         */
           protected ViewMap(DualTreeBidiMap bidi, SortedMap sm) {
               // the implementation is not great here...
               // use the maps[0] as the filtered map, but maps[1] as the full map
  @@ -255,6 +263,10 @@
           /** The last returned entry */
           private Map.Entry last = null;
           
  +        /**
  +         * Constructor.
  +         * @param parent  the parent map
  +         */
           protected BidiOrderedMapIterator(AbstractDualBidiMap parent) {
               super();
               this.parent = parent;
  
  
  
  1.5       +4 -1      jakarta-commons/collections/src/java/org/apache/commons/collections/bidimap/UnmodifiableSortedBidiMap.java
  
  Index: UnmodifiableSortedBidiMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/bidimap/UnmodifiableSortedBidiMap.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- UnmodifiableSortedBidiMap.java	18 Feb 2004 00:57:39 -0000	1.4
  +++ UnmodifiableSortedBidiMap.java	15 May 2004 12:13:03 -0000	1.5
  @@ -48,8 +48,11 @@
   
       /**
        * Factory method to create an unmodifiable map.
  +     * <p>
  +     * If the map passed in is already unmodifiable, it is returned.
        * 
        * @param map  the map to decorate, must not be null
  +     * @return an unmodifiable SortedBidiMap
        * @throws IllegalArgumentException if map is null
        */
       public static SortedBidiMap decorate(SortedBidiMap map) {
  
  
  

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