From fcf4320023d468df672d9773c3a2755b7857b296 Mon Sep 17 00:00:00 2001
From: Sebastian Bazley <sebb@apache.org>
Date: Mon, 29 Apr 2013 22:58:50 +0000
Subject: [PATCH] Make fields private (and final) if possible

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1477400 13f79535-47bb-0310-9956-ffa450edef68
---
 .../commons/collections4/bag/SynchronizedBag.java      |  2 +-
 .../collections4/bag/SynchronizedSortedBag.java        |  2 +-
 .../commons/collections4/bidimap/DualTreeBidiMap.java  |  4 ++--
 .../commons/collections4/bidimap/TreeBidiMap.java      |  8 ++++----
 .../collections4/collection/CompositeCollection.java   |  4 ++--
 .../collection/SynchronizedCollection.java             |  2 +-
 .../collection/UnmodifiableBoundedCollection.java      |  2 +-
 .../collections4/comparators/ComparatorChain.java      |  6 +++---
 .../comparators/TransformingComparator.java            |  4 ++--
 .../iterators/AbstractListIteratorDecorator.java       |  2 +-
 .../iterators/AbstractMapIteratorDecorator.java        |  2 +-
 .../iterators/AbstractOrderedMapIteratorDecorator.java |  2 +-
 .../iterators/AbstractUntypedIteratorDecorator.java    |  2 +-
 .../commons/collections4/iterators/IteratorChain.java  | 10 +++++-----
 .../collections4/iterators/NodeListIterator.java       |  2 +-
 .../iterators/ObjectArrayListIterator.java             |  2 +-
 .../keyvalue/AbstractMapEntryDecorator.java            |  2 +-
 .../commons/collections4/list/PredicatedList.java      |  4 ++--
 .../commons/collections4/list/TransformedList.java     |  4 ++--
 .../map/AbstractInputCheckedMapDecorator.java          |  4 ++--
 .../commons/collections4/map/UnmodifiableEntrySet.java |  2 +-
 .../commons/collections4/set/ListOrderedSet.java       |  8 ++++----
 22 files changed, 40 insertions(+), 40 deletions(-)

diff --git a/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java b/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java
index eec71e1f0..26c6a2561 100644
--- a/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java
+++ b/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java
@@ -78,7 +78,7 @@ public class SynchronizedBag<E> extends SynchronizedCollection<E> implements Bag
      * @return the decorated bag
      */
     protected Bag<E> getBag() {
-        return (Bag<E>) collection;
+        return (Bag<E>) decorated();
     }
     
     //-----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/bag/SynchronizedSortedBag.java b/src/main/java/org/apache/commons/collections4/bag/SynchronizedSortedBag.java
index ec98cd8cf..324272f25 100644
--- a/src/main/java/org/apache/commons/collections4/bag/SynchronizedSortedBag.java
+++ b/src/main/java/org/apache/commons/collections4/bag/SynchronizedSortedBag.java
@@ -78,7 +78,7 @@ public class SynchronizedSortedBag<E> extends SynchronizedBag<E> implements Sort
      * @return the decorated bag
      */
     protected SortedBag<E> getSortedBag() {
-        return (SortedBag<E>) collection;
+        return (SortedBag<E>) decorated();
     }
     
     //-----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java b/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java
index b3c0edbed..45c78a40d 100644
--- a/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java
+++ b/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java
@@ -59,10 +59,10 @@ public class DualTreeBidiMap<K, V> extends AbstractDualBidiMap<K, V>
     private static final long serialVersionUID = 721969328361809L;
 
     /** The key comparator to use */
-    protected final Comparator<? super K> comparator;
+    private final Comparator<? super K> comparator;
 
     /** The value comparator to use */
-    protected final Comparator<? super V> valueComparator;
+    private final Comparator<? super V> valueComparator;
     
     /**
      * Creates an empty <code>DualTreeBidiMap</code>
diff --git a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
index 7ef4782bc..c7c1a04aa 100644
--- a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
+++ b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
@@ -1610,13 +1610,13 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>>
     abstract class ViewIterator {
 
         /** Whether to return KEY or VALUE order. */
-        protected final DataElement orderType;
+        private final DataElement orderType;
         /** The last node returned by the iterator. */
-        protected Node<K, V> lastReturnedNode;
+        Node<K, V> lastReturnedNode;
         /** The next node to be returned by the iterator. */
-        protected Node<K, V> nextNode;
+        private Node<K, V> nextNode;
         /** The previous node in the sequence returned by the iterator. */
-        protected Node<K, V> previousNode;
+        private Node<K, V> previousNode;
         /** The modification count. */
         private int expectedModifications;
 
diff --git a/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java b/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java
index 8230b7c05..2c338faac 100644
--- a/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java
+++ b/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java
@@ -45,10 +45,10 @@ public class CompositeCollection<E> implements Collection<E>, Serializable {
     private static final long serialVersionUID = 8417515734108306801L;
 
     /** CollectionMutator to handle changes to the collection */
-    protected CollectionMutator<E> mutator;
+    private CollectionMutator<E> mutator;
 
     /** Collections in the composite */
-    protected List<Collection<E>> all = new ArrayList<Collection<E>>();
+    private final List<Collection<E>> all = new ArrayList<Collection<E>>();
 
     /**
      * Create an empty CompositeCollection.
diff --git a/src/main/java/org/apache/commons/collections4/collection/SynchronizedCollection.java b/src/main/java/org/apache/commons/collections4/collection/SynchronizedCollection.java
index b696a6a0a..c619a5084 100644
--- a/src/main/java/org/apache/commons/collections4/collection/SynchronizedCollection.java
+++ b/src/main/java/org/apache/commons/collections4/collection/SynchronizedCollection.java
@@ -44,7 +44,7 @@ public class SynchronizedCollection<E> implements Collection<E>, Serializable {
     private static final long serialVersionUID = 2412805092710877986L;
 
     /** The collection to decorate */
-    protected final Collection<E> collection;
+    private final Collection<E> collection;
     /** The object to lock on, needed for List/SortedSet views */
     protected final Object lock;
 
diff --git a/src/main/java/org/apache/commons/collections4/collection/UnmodifiableBoundedCollection.java b/src/main/java/org/apache/commons/collections4/collection/UnmodifiableBoundedCollection.java
index e3b426c3d..11a716595 100644
--- a/src/main/java/org/apache/commons/collections4/collection/UnmodifiableBoundedCollection.java
+++ b/src/main/java/org/apache/commons/collections4/collection/UnmodifiableBoundedCollection.java
@@ -82,7 +82,7 @@ public final class UnmodifiableBoundedCollection<E> extends AbstractCollectionDe
             if (coll instanceof AbstractCollectionDecorator) {
                 coll = ((AbstractCollectionDecorator<E>) coll).collection;
             } else if (coll instanceof SynchronizedCollection) {
-                coll = ((SynchronizedCollection<E>) coll).collection;
+                coll = ((SynchronizedCollection<E>) coll).decorated();
             }
         }
 
diff --git a/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java b/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java
index 7920434c3..18d57b159 100644
--- a/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java
+++ b/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java
@@ -53,11 +53,11 @@ public class ComparatorChain<E> implements Comparator<E>, Serializable {
     private static final long serialVersionUID = -721644942746081630L;
 
     /** The list of comparators in the chain. */
-    protected List<Comparator<E>> comparatorChain = null;
+    private final List<Comparator<E>> comparatorChain;
     /** Order - false (clear) = ascend; true (set) = descend. */
-    protected BitSet orderingBits = null;
+    private BitSet orderingBits = null;
    /** Whether the chain has been "locked". */
-    protected boolean isLocked = false;
+    private boolean isLocked = false;
 
     //-----------------------------------------------------------------------
     /**
diff --git a/src/main/java/org/apache/commons/collections4/comparators/TransformingComparator.java b/src/main/java/org/apache/commons/collections4/comparators/TransformingComparator.java
index 7a2f9b8b7..704961d96 100644
--- a/src/main/java/org/apache/commons/collections4/comparators/TransformingComparator.java
+++ b/src/main/java/org/apache/commons/collections4/comparators/TransformingComparator.java
@@ -41,9 +41,9 @@ public class TransformingComparator<I, O> implements Comparator<I>, Serializable
     private static final long serialVersionUID = 3456940356043606220L;
 
     /** The decorated comparator. */
-    protected final Comparator<O> decorated;
+    private final Comparator<O> decorated;
     /** The transformer being used. */    
-    protected final Transformer<? super I, ? extends O> transformer;
+    private final Transformer<? super I, ? extends O> transformer;
 
     //-----------------------------------------------------------------------
     /**
diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractListIteratorDecorator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractListIteratorDecorator.java
index bdb120e44..216492328 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/AbstractListIteratorDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractListIteratorDecorator.java
@@ -29,7 +29,7 @@ import java.util.ListIterator;
 public class AbstractListIteratorDecorator<E> implements ListIterator<E> {
 
     /** The iterator being decorated */
-    protected final ListIterator<E> iterator;
+    private final ListIterator<E> iterator;
 
     //-----------------------------------------------------------------------
     /**
diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractMapIteratorDecorator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractMapIteratorDecorator.java
index d65c7772f..ba83e4ec9 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/AbstractMapIteratorDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractMapIteratorDecorator.java
@@ -29,7 +29,7 @@ import org.apache.commons.collections4.MapIterator;
 public class AbstractMapIteratorDecorator<K, V> implements MapIterator<K, V> {
 
     /** The iterator being decorated */
-    protected final MapIterator<K, V> iterator;
+    private final MapIterator<K, V> iterator;
 
     //-----------------------------------------------------------------------
     /**
diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractOrderedMapIteratorDecorator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractOrderedMapIteratorDecorator.java
index f215036f6..681ecef88 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/AbstractOrderedMapIteratorDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractOrderedMapIteratorDecorator.java
@@ -29,7 +29,7 @@ import org.apache.commons.collections4.OrderedMapIterator;
 public class AbstractOrderedMapIteratorDecorator<K, V> implements OrderedMapIterator<K, V> {
 
     /** The iterator being decorated */
-    protected final OrderedMapIterator<K, V> iterator;
+    private final OrderedMapIterator<K, V> iterator;
 
     //-----------------------------------------------------------------------
     /**
diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractUntypedIteratorDecorator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractUntypedIteratorDecorator.java
index 29762e17b..017cd20e5 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/AbstractUntypedIteratorDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractUntypedIteratorDecorator.java
@@ -30,7 +30,7 @@ import java.util.Iterator;
 public abstract class AbstractUntypedIteratorDecorator<I, O> implements Iterator<O> {
 
     /** The iterator being decorated */
-    protected final Iterator<I> iterator;
+    private final Iterator<I> iterator;
 
     /**
      * Create a new AbstractUntypedIteratorDecorator.
diff --git a/src/main/java/org/apache/commons/collections4/iterators/IteratorChain.java b/src/main/java/org/apache/commons/collections4/iterators/IteratorChain.java
index d65a79b65..e9976b056 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/IteratorChain.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/IteratorChain.java
@@ -48,25 +48,25 @@ import org.apache.commons.collections4.list.UnmodifiableList;
 public class IteratorChain<E> implements Iterator<E> {
 
     /** The chain of iterators */
-    protected final List<Iterator<? extends E>> iteratorChain = new ArrayList<Iterator<? extends E>>();
+    private final List<Iterator<? extends E>> iteratorChain = new ArrayList<Iterator<? extends E>>();
 
     /** The index of the current iterator */
-    protected int currentIteratorIndex = 0;
+    private int currentIteratorIndex = 0;
 
     /** The current iterator */
-    protected Iterator<? extends E> currentIterator = null;
+    private Iterator<? extends E> currentIterator = null;
 
     /**
      * The "last used" Iterator is the Iterator upon which next() or hasNext()
      * was most recently called used for the remove() operation only
      */
-    protected Iterator<? extends E> lastUsedIterator = null;
+    private Iterator<? extends E> lastUsedIterator = null;
 
     /**
      * ComparatorChain is "locked" after the first time compare(Object,Object)
      * is called
      */
-    protected boolean isLocked = false;
+    private boolean isLocked = false;
 
     //-----------------------------------------------------------------------
     /**
diff --git a/src/main/java/org/apache/commons/collections4/iterators/NodeListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/NodeListIterator.java
index b33377c7a..b90811b2f 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/NodeListIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/NodeListIterator.java
@@ -35,7 +35,7 @@ public class NodeListIterator implements Iterator<Node> {
     /** the original NodeList instance */
     private final NodeList nodeList;
     /** The current iterator index */
-    protected int index = 0;
+    private int index = 0;
 
     /**
      * Convenience constructor, which creates a new NodeListIterator from 
diff --git a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java
index 873631712..41747e32e 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java
@@ -46,7 +46,7 @@ public class ObjectArrayListIterator<E> extends ObjectArrayIterator<E>
      * has yet been invoked. <code>lastItemIndex</code> is used to to implement the
      * {@link #set} method.
      */
-    protected int lastItemIndex = -1;
+    private int lastItemIndex = -1;
 
     /**
      * Constructor for use with <code>setArray</code>.
diff --git a/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntryDecorator.java b/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntryDecorator.java
index 57013e1bf..6e5fc5c3e 100644
--- a/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntryDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntryDecorator.java
@@ -30,7 +30,7 @@ import org.apache.commons.collections4.KeyValue;
 public abstract class AbstractMapEntryDecorator<K, V> implements Map.Entry<K, V>, KeyValue<K, V> {
     
     /** The <code>Map.Entry</code> to decorate */
-    protected final Map.Entry<K, V> entry;
+    private final Map.Entry<K, V> entry;
 
     /**
      * Constructor that wraps (not copies).
diff --git a/src/main/java/org/apache/commons/collections4/list/PredicatedList.java b/src/main/java/org/apache/commons/collections4/list/PredicatedList.java
index 31062b040..e0222070e 100644
--- a/src/main/java/org/apache/commons/collections4/list/PredicatedList.java
+++ b/src/main/java/org/apache/commons/collections4/list/PredicatedList.java
@@ -155,13 +155,13 @@ public class PredicatedList<E> extends PredicatedCollection<E> implements List<E
         @Override
         public void add(final E object) {
             validate(object);
-            iterator.add(object);
+            getListIterator().add(object);
         }
         
         @Override
         public void set(final E object) {
             validate(object);
-            iterator.set(object);
+            getListIterator().set(object);
         }
     }
 
diff --git a/src/main/java/org/apache/commons/collections4/list/TransformedList.java b/src/main/java/org/apache/commons/collections4/list/TransformedList.java
index a10f1899b..5cddb45f0 100644
--- a/src/main/java/org/apache/commons/collections4/list/TransformedList.java
+++ b/src/main/java/org/apache/commons/collections4/list/TransformedList.java
@@ -178,13 +178,13 @@ public class TransformedList<E> extends TransformedCollection<E> implements List
         @Override
         public void add(E object) {
             object = transform(object);
-            iterator.add(object);
+            getListIterator().add(object);
         }
 
         @Override
         public void set(E object) {
             object = transform(object);
-            iterator.set(object);
+            getListIterator().set(object);
         }
     }
 
diff --git a/src/main/java/org/apache/commons/collections4/map/AbstractInputCheckedMapDecorator.java b/src/main/java/org/apache/commons/collections4/map/AbstractInputCheckedMapDecorator.java
index 8e7dbbf81..8886db016 100644
--- a/src/main/java/org/apache/commons/collections4/map/AbstractInputCheckedMapDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/map/AbstractInputCheckedMapDecorator.java
@@ -178,7 +178,7 @@ abstract class AbstractInputCheckedMapDecorator<K, V>
 
         @Override
         public Map.Entry<K, V> next() {
-            final Map.Entry<K, V> entry = iterator.next();
+            final Map.Entry<K, V> entry = getIterator().next();
             return new MapEntry(entry, parent);
         }
     }
@@ -199,7 +199,7 @@ abstract class AbstractInputCheckedMapDecorator<K, V>
         @Override
         public V setValue(V value) {
             value = parent.checkSetValue(value);
-            return entry.setValue(value);
+            return getMapEntry().setValue(value);
         }
     }
 
diff --git a/src/main/java/org/apache/commons/collections4/map/UnmodifiableEntrySet.java b/src/main/java/org/apache/commons/collections4/map/UnmodifiableEntrySet.java
index 9355f4077..93d0f6672 100644
--- a/src/main/java/org/apache/commons/collections4/map/UnmodifiableEntrySet.java
+++ b/src/main/java/org/apache/commons/collections4/map/UnmodifiableEntrySet.java
@@ -154,7 +154,7 @@ public final class UnmodifiableEntrySet<K, V>
 
         @Override
         public Map.Entry<K, V> next() {
-            return new UnmodifiableEntry(iterator.next());
+            return new UnmodifiableEntry(getIterator().next());
         }
 
         @Override
diff --git a/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java b/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java
index 0d00c4fde..fdeb8b4d4 100644
--- a/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java
@@ -380,23 +380,23 @@ public class ListOrderedSet<E>
 
         @Override
         public E next() {
-            last = iterator.next();
+            last = getIterator().next();
             return last;
         }
 
         @Override
         public void remove() {
             set.remove(last);
-            iterator.remove();
+            getIterator().remove();
             last = null;
         }
 
         public boolean hasPrevious() {
-            return ((ListIterator<E>) iterator).hasPrevious();
+            return ((ListIterator<E>) getIterator()).hasPrevious();
         }
 
         public E previous() {
-            last = ((ListIterator<E>) iterator).previous();
+            last = ((ListIterator<E>) getIterator()).previous();
             return last;
         }
     }