Add comment markers for remaining classes where fields could perhaps be privatised

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1477647 13f79535-47bb-0310-9956-ffa450edef68

src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java

@@ -41,6 +41,8 @@ import org.apache.commons.collections4.keyvalue.AbstractMapEntryDecorator;
  */
 public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> {
 
+    // TODO privatise fields?
+
     /**
      * Normal delegate map.
      */

src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java

@@ -45,6 +45,8 @@ public abstract class AbstractCollectionDecorator<E>
     /** Serialization version */
     private static final long serialVersionUID = 6249888059822088500L;
 
+    // TODO privatise field? read-only access - could use decorated() - apart from deserialisation
+
     /** The collection being decorated */
     protected Collection<E> collection;
 

src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java

@@ -37,6 +37,8 @@ import org.apache.commons.collections4.ResettableIterator;
  */
 public class ArrayIterator<E> implements ResettableIterator<E> {
 
+    // TODO Privatise fields? Mainly read-only access
+
     /** The array to iterate over */    
     protected Object array;
     /** The start index to loop from */

src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java

@@ -36,6 +36,8 @@ import org.apache.commons.collections4.ResettableIterator;
 public class ObjectArrayIterator<E>
         implements Iterator<E>, ResettableIterator<E> {
 
+    // TODO Privatise fields? Mainly read-only access
+
     /** The array */
     protected E[] array = null;
     /** The start index to loop from */

src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java

@@ -54,6 +54,8 @@ public abstract class AbstractLinkedList<E> implements List<E> {
      * - respects {@link AbstractList#modCount}
      */
 
+    // TODO Privatise fields?
+
     /**
      * A {@link Node} which indicates the start and end of the list and does not
      * hold a value. The value of <code>next</code> is the first item in the

src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java

@@ -62,7 +62,7 @@ import org.apache.commons.collections4.iterators.EmptyOrderedMapIterator;
 public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> implements OrderedMap<K, V> {
     
     /** Header in the linked list */
-    protected transient LinkEntry<K, V> header;
+    protected transient LinkEntry<K, V> header; // TODO Privatise?
 
     /**
      * Constructor only used in deserialization, do not use otherwise.
@@ -501,7 +501,7 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im
      */
     protected static class LinkEntry<K, V> extends HashEntry<K, V> {
         /** The entry before this one in the order */
-        protected LinkEntry<K, V> before;
+        protected LinkEntry<K, V> before; // TODO Privatise?
         /** The entry after this one in the order */
         protected LinkEntry<K, V> after;
 

src/main/java/org/apache/commons/collections4/map/AbstractMapDecorator.java

@@ -41,7 +41,7 @@ import java.util.Set;
 public abstract class AbstractMapDecorator<K, V> extends AbstractIterableMap<K, V> {
 
     /** The map to decorate */
-    protected transient Map<K, V> map;
+    protected transient Map<K, V> map; // TODO Privatise? Only write access is for deserialisation
 
     /**
      * Constructor only used in deserialization, do not use otherwise.

src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java

@@ -30,6 +30,9 @@ import org.apache.commons.collections4.ResettableIterator;
  * @version $Id$
  */
 public class EntrySetToMapIteratorAdapter<K, V> implements MapIterator<K, V>, ResettableIterator<K> {
+
+    // TODO Privatise fields?
+
     /** The adapted Map entry Set. */
     protected Set<Map.Entry<K, V>> entrySet;
 

src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java

@@ -34,7 +34,7 @@ import org.apache.commons.collections4.map.EntrySetToMapIteratorAdapter;
 public class AbstractIterableGetMapDecorator<K, V> implements IterableGet<K, V> {
 
     /** The map to decorate */
-    protected transient Map<K, V> map;
+    protected transient Map<K, V> map; // TODO Privatise? only external access is for deserialisation
 
     /**
      * Create a new AbstractSplitMapDecorator.

src/main/java/org/apache/commons/collections4/trie/AbstractTrie.java

@@ -33,7 +33,9 @@ abstract class AbstractTrie<K, V> extends AbstractMap<K, V>
         implements Trie<K, V>, Serializable {
     
     private static final long serialVersionUID = 5826987063535505652L;
-    
+
+    // TODO Privatise fields?
+
     /**
      * The {@link KeyAnalyzer} that's being used to build the 
      * PATRICIA {@link Trie}.