You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2013/04/30 16:15:54 UTC
svn commit: r1477647 - in
/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4:
bidimap/ collection/ iterators/ list/ map/ splitmap/ trie/
Author: sebb
Date: Tue Apr 30 14:15:54 2013
New Revision: 1477647
URL: http://svn.apache.org/r1477647
Log:
Add comment markers for remaining classes where fields could perhaps be privatised
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/AbstractMapDecorator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/trie/AbstractTrie.java
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java?rev=1477647&r1=1477646&r2=1477647&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java Tue Apr 30 14:15:54 2013
@@ -41,6 +41,8 @@ import org.apache.commons.collections4.k
*/
public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> {
+ // TODO privatise fields?
+
/**
* Normal delegate map.
*/
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java?rev=1477647&r1=1477646&r2=1477647&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java Tue Apr 30 14:15:54 2013
@@ -45,6 +45,8 @@ public abstract class AbstractCollection
/** 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;
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java?rev=1477647&r1=1477646&r2=1477647&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java Tue Apr 30 14:15:54 2013
@@ -37,6 +37,8 @@ import org.apache.commons.collections4.R
*/
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 */
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java?rev=1477647&r1=1477646&r2=1477647&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java Tue Apr 30 14:15:54 2013
@@ -36,6 +36,8 @@ import org.apache.commons.collections4.R
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 */
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java?rev=1477647&r1=1477646&r2=1477647&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java Tue Apr 30 14:15:54 2013
@@ -54,6 +54,8 @@ public abstract class AbstractLinkedList
* - 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
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java?rev=1477647&r1=1477646&r2=1477647&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java Tue Apr 30 14:15:54 2013
@@ -62,7 +62,7 @@ import org.apache.commons.collections4.i
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<
*/
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;
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/AbstractMapDecorator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/AbstractMapDecorator.java?rev=1477647&r1=1477646&r2=1477647&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/AbstractMapDecorator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/AbstractMapDecorator.java Tue Apr 30 14:15:54 2013
@@ -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.
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java?rev=1477647&r1=1477646&r2=1477647&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java Tue Apr 30 14:15:54 2013
@@ -30,6 +30,9 @@ import org.apache.commons.collections4.R
* @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;
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java?rev=1477647&r1=1477646&r2=1477647&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java Tue Apr 30 14:15:54 2013
@@ -34,7 +34,7 @@ import org.apache.commons.collections4.m
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.
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/trie/AbstractTrie.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/trie/AbstractTrie.java?rev=1477647&r1=1477646&r2=1477647&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/trie/AbstractTrie.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections4/trie/AbstractTrie.java Tue Apr 30 14:15:54 2013
@@ -33,7 +33,9 @@ abstract class AbstractTrie<K, V> extend
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}.