commons-collections git commit: Javadoc nits.

[ggregory]

Repository: commons-collections
Updated Branches:
  refs/heads/master b5585aaa6 -> d8fd53176


Javadoc nits.

Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/d8fd5317
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/d8fd5317
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/d8fd5317

Branch: refs/heads/master
Commit: d8fd53176635bf531184bbb16701d779e096b490
Parents: b5585aa
Author: Gary Gregory 
Authored: Thu Nov 1 14:10:30 2018 -0600
Committer: Gary Gregory 
Committed: Thu Nov 1 14:10:30 2018 -0600

--
 .../java/org/apache/commons/collections4/BoundedCollection.java  | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/d8fd5317/src/main/java/org/apache/commons/collections4/BoundedCollection.java
--
diff --git 
a/src/main/java/org/apache/commons/collections4/BoundedCollection.java 
b/src/main/java/org/apache/commons/collections4/BoundedCollection.java
index 2431cd5..9b534e5 100644
--- a/src/main/java/org/apache/commons/collections4/BoundedCollection.java
+++ b/src/main/java/org/apache/commons/collections4/BoundedCollection.java
@@ -36,14 +36,14 @@ public interface BoundedCollection extends Collection 
{
 /**
  * Returns true if this collection is full and no new elements can be 
added.
  *
- * @return true if the collection is full
+ * @return true if the collection is full.
  */
 boolean isFull();
 
 /**
  * Gets the maximum size of the collection (the bound).
  *
- * @return the maximum number of elements the collection can hold
+ * @return the maximum number of elements the collection can hold.
  */
 int maxSize();
 

commons-collections git commit: Javadoc fixes. Closes #43.

[ggregory]

Repository: commons-collections
Updated Branches:
  refs/heads/master 8f9e66fbf -> 775886ba0


Javadoc fixes. Closes #43.

Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/775886ba
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/775886ba
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/775886ba

Branch: refs/heads/master
Commit: 775886ba0cb54d700268f236796c86603037951d
Parents: 8f9e66f
Author: Stephan Fuhrmann 
Authored: Fri Jun 15 16:26:27 2018 -0600
Committer: Gary Gregory 
Committed: Fri Jun 15 16:26:27 2018 -0600

--
 .../commons/collections4/IterableUtils.java |  2 +-
 .../collections4/bidimap/TreeBidiMap.java   | 93 +---
 .../collections4/functors/FunctorUtils.java |  3 +-
 .../iterators/LazyIteratorChain.java|  2 +-
 .../commons/collections4/map/Flat3Map.java  |  2 +-
 5 files changed, 64 insertions(+), 38 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/775886ba/src/main/java/org/apache/commons/collections4/IterableUtils.java
--
diff --git a/src/main/java/org/apache/commons/collections4/IterableUtils.java 
b/src/main/java/org/apache/commons/collections4/IterableUtils.java
index 104f4d1..05613c5 100644
--- a/src/main/java/org/apache/commons/collections4/IterableUtils.java
+++ b/src/main/java/org/apache/commons/collections4/IterableUtils.java
@@ -1074,7 +1074,7 @@ public class IterableUtils {
 /**
  * Fail-fast check for null arguments.
  *
- * @param iterable  the iterable to check
+ * @param iterables  the iterables to check
  * @throws NullPointerException if the argument or any of its contents is 
null
  */
 static void checkNotNull(final Iterable... iterables) {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/775886ba/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
--
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 c281f94..33d1943 100644
--- a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
+++ b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
@@ -579,7 +579,8 @@ public class TreeBidiMap, V extends 
Comparable>
  * do the actual lookup of a piece of data
  *
  * @param data the key or value to be looked up
- * @param index  the KEY or VALUE int
+ * @param dataElement  either {@link DataElement#KEY} key}
+ * or the {@link DataElement#VALUE value}.
  * @return the desired Node, or null if there is no mapping of the
  * specified data
  */
@@ -612,7 +613,8 @@ public class TreeBidiMap, V extends 
Comparable>
  * get the next larger node from the specified node
  *
  * @param node the node to be searched from
- * @param index  the KEY or VALUE int
+ * @param dataElement  either {@link DataElement#KEY} key}
+ * or the {@link DataElement#VALUE value}.
  * @return the specified node
  */
 private Node nextGreater(final Node node, final DataElement 
dataElement) {
@@ -646,7 +648,8 @@ public class TreeBidiMap, V extends 
Comparable>
  * get the next larger node from the specified node
  *
  * @param node the node to be searched from
- * @param index  the KEY or VALUE int
+ * @param dataElement  either {@link DataElement#KEY} key}
+ * or the {@link DataElement#VALUE value}.
  * @return the specified node
  */
 private Node nextSmaller(final Node node, final DataElement 
dataElement) {
@@ -695,7 +698,8 @@ public class TreeBidiMap, V extends 
Comparable>
  * Find the least node from a given node.
  *
  * @param node  the node from which we will start searching
- * @param index  the KEY or VALUE int
+ * @param dataElement  either {@link DataElement#KEY} key}
+ * or the {@link DataElement#VALUE value}.
  * @return the smallest node, from the specified node, in the
  * specified mapping
  */
@@ -713,7 +717,8 @@ public class TreeBidiMap, V extends 
Comparable>
  * Find the greatest node from a given node.
  *
  * @param node  the node from which we will start searching
- * @param index  the KEY or VALUE int
+ * @param dataElement  either {@link DataElement#KEY} key}
+ * or the {@link DataElement#VALUE value}.
  * @return the greatest node, from the specified node
  */
 private Node greatestNode(final Node 

commons-collections git commit: Javadoc nit.

[ggregory]

Repository: commons-collections
Updated Branches:
  refs/heads/master 68747912d -> 8accf274b


Javadoc nit.

Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/8accf274
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/8accf274
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/8accf274

Branch: refs/heads/master
Commit: 8accf274ba10b7ed0a6659c7f34bb45d72d7c4ce
Parents: 6874791
Author: Gary Gregory 
Authored: Thu Feb 22 13:30:12 2018 -0700
Committer: Gary Gregory 
Committed: Thu Feb 22 13:30:12 2018 -0700

--
 .../java/org/apache/commons/collections4/IteratorUtilsTest.java | 1 -
 1 file changed, 1 deletion(-)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8accf274/src/test/java/org/apache/commons/collections4/IteratorUtilsTest.java
--
diff --git 
a/src/test/java/org/apache/commons/collections4/IteratorUtilsTest.java 
b/src/test/java/org/apache/commons/collections4/IteratorUtilsTest.java
index 5f966b9..a8eb7b4 100644
--- a/src/test/java/org/apache/commons/collections4/IteratorUtilsTest.java
+++ b/src/test/java/org/apache/commons/collections4/IteratorUtilsTest.java
@@ -55,7 +55,6 @@ import org.w3c.dom.NodeList;
 
 /**
  * Tests for IteratorUtils.
- *
  */
 public class IteratorUtilsTest {
 

commons-collections git commit: Javadoc nit.

[ggregory]

Repository: commons-collections
Updated Branches:
  refs/heads/master dee97c3ff -> 68747912d


Javadoc nit.

Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/68747912
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/68747912
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/68747912

Branch: refs/heads/master
Commit: 68747912d250cdb8813b941ed65356a0bcc92135
Parents: dee97c3
Author: Gary Gregory 
Authored: Thu Feb 22 13:29:31 2018 -0700
Committer: Gary Gregory 
Committed: Thu Feb 22 13:29:31 2018 -0700

--
 .../apache/commons/collections4/iterators/PeekingIteratorTest.java  | 1 -
 1 file changed, 1 deletion(-)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/68747912/src/test/java/org/apache/commons/collections4/iterators/PeekingIteratorTest.java
--
diff --git 
a/src/test/java/org/apache/commons/collections4/iterators/PeekingIteratorTest.java
 
b/src/test/java/org/apache/commons/collections4/iterators/PeekingIteratorTest.java
index 66be1d8..6a3cf98 100644
--- 
a/src/test/java/org/apache/commons/collections4/iterators/PeekingIteratorTest.java
+++ 
b/src/test/java/org/apache/commons/collections4/iterators/PeekingIteratorTest.java
@@ -29,7 +29,6 @@ import org.junit.Test;
 
 /**
  * Tests the PeekingIterator.
- *
  */
 public class PeekingIteratorTest extends AbstractIteratorTest {
 

commons-collections git commit: Javadoc.

[ggregory]

Repository: commons-collections
Updated Branches:
  refs/heads/master 22daa5f1d -> 1e6435ec1


Javadoc.

Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/1e6435ec
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/1e6435ec
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/1e6435ec

Branch: refs/heads/master
Commit: 1e6435ec103c1d52b119602a3aa48bfa5775d01d
Parents: 22daa5f
Author: Gary Gregory 
Authored: Fri Jan 12 11:03:43 2018 -0700
Committer: Gary Gregory 
Committed: Fri Jan 12 11:03:43 2018 -0700

--
 .../org/apache/commons/collections4/IterableUtils.java   |  4 
 .../org/apache/commons/collections4/IteratorUtils.java   | 11 +++
 2 files changed, 11 insertions(+), 4 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/1e6435ec/src/main/java/org/apache/commons/collections4/IterableUtils.java
--
diff --git a/src/main/java/org/apache/commons/collections4/IterableUtils.java 
b/src/main/java/org/apache/commons/collections4/IterableUtils.java
index d5cb444..104f4d1 100644
--- a/src/main/java/org/apache/commons/collections4/IterableUtils.java
+++ b/src/main/java/org/apache/commons/collections4/IterableUtils.java
@@ -775,10 +775,14 @@ public class IterableUtils {
 }
 
 /**
+ * Shortcut for {@code get(iterator, 0)}.
+ * 
  * Returns the first value in the iterable's 
{@link Iterator}, throwing
  * IndexOutOfBoundsException if there is no such element.
+ * 
  * 
  * If the {@link Iterable} is a {@link List}, then it will use {@link 
List#get(int)}.
+ * 
  *
  * @param  the type of object in the {@link Iterable}.
  * @param iterable  the {@link Iterable} to get a value from, may be null

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/1e6435ec/src/main/java/org/apache/commons/collections4/IteratorUtils.java
--
diff --git a/src/main/java/org/apache/commons/collections4/IteratorUtils.java 
b/src/main/java/org/apache/commons/collections4/IteratorUtils.java
index 86a2c09..79ce159 100644
--- a/src/main/java/org/apache/commons/collections4/IteratorUtils.java
+++ b/src/main/java/org/apache/commons/collections4/IteratorUtils.java
@@ -1413,14 +1413,17 @@ public class IteratorUtils {
 }
 
 /**
+ * Shortcut for {@code get(iterator, 0)}.
+ * 
  * Returns the first value in {@link Iterator}, throwing
  * IndexOutOfBoundsException if there is no such element.
+ * 
  * 
- * The Iterator is advanced to index (or to the end, if
- * index exceeds the number of entries) as a side effect of 
this method.
- *
+ * The Iterator is advanced to 0 (or to the end, if
+ * 0 exceeds the number of entries) as a side effect of this 
method.
+ * 
  * @param  the type of object in the {@link Iterator}
- * @param iterator  the iterator to get a value from
+ * @param iterator the iterator to get a value from
  * @return the first object
  * @throws IndexOutOfBoundsException if the request is invalid
  * @since 4.2

commons-collections git commit: Javadoc: Add missing @param tags for generics.

[ggregory]

Repository: commons-collections
Updated Branches:
  refs/heads/master 36d33722c -> 6044892b8


Javadoc: Add missing @param tags for generics.

Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/6044892b
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/6044892b
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/6044892b

Branch: refs/heads/master
Commit: 6044892b8817841714cb79200b944611a9c22944
Parents: 36d3372
Author: Gary Gregory 
Authored: Thu Dec 28 13:56:04 2017 -0700
Committer: Gary Gregory 
Committed: Thu Dec 28 13:56:04 2017 -0700

--
 src/main/java/org/apache/commons/collections4/Get.java   | 4 +++-
 src/main/java/org/apache/commons/collections4/IterableGet.java   | 4 +++-
 src/main/java/org/apache/commons/collections4/Put.java   | 4 +++-
 .../apache/commons/collections4/bidimap/AbstractDualBidiMap.java | 3 +++
 .../org/apache/commons/collections4/bidimap/DualHashBidiMap.java | 3 +++
 .../commons/collections4/bidimap/DualLinkedHashBidiMap.java  | 3 +++
 .../commons/collections4/comparators/ComparableComparator.java   | 3 ++-
 .../apache/commons/collections4/comparators/ComparatorChain.java | 1 +
 .../commons/collections4/comparators/FixedOrderComparator.java   | 1 +
 .../apache/commons/collections4/comparators/NullComparator.java  | 1 +
 .../commons/collections4/comparators/ReverseComparator.java  | 3 ++-
 .../commons/collections4/comparators/TransformingComparator.java | 3 +++
 .../java/org/apache/commons/collections4/map/CompositeMap.java   | 3 +++
 .../commons/collections4/map/EntrySetToMapIteratorAdapter.java   | 3 +++
 .../java/org/apache/commons/collections4/map/ReferenceMap.java   | 4 +++-
 .../apache/commons/collections4/map/UnmodifiableEntrySet.java| 3 +++
 .../commons/collections4/multiset/AbstractMapMultiSet.java   | 1 +
 .../apache/commons/collections4/multiset/AbstractMultiSet.java   | 1 +
 .../commons/collections4/multiset/AbstractMultiSetDecorator.java | 1 +
 .../org/apache/commons/collections4/multiset/HashMultiSet.java   | 1 +
 .../apache/commons/collections4/multiset/PredicatedMultiSet.java | 1 +
 .../commons/collections4/multiset/SynchronizedMultiSet.java  | 1 +
 .../commons/collections4/multiset/UnmodifiableMultiSet.java  | 1 +
 .../org/apache/commons/collections4/queue/PredicatedQueue.java   | 1 +
 .../org/apache/commons/collections4/queue/TransformedQueue.java  | 1 +
 .../org/apache/commons/collections4/queue/UnmodifiableQueue.java | 1 +
 .../collections4/set/AbstractSerializableSetDecorator.java   | 1 +
 .../apache/commons/collections4/set/AbstractSetDecorator.java| 2 +-
 .../java/org/apache/commons/collections4/set/CompositeSet.java   | 1 +
 .../java/org/apache/commons/collections4/set/ListOrderedSet.java | 1 +
 .../java/org/apache/commons/collections4/set/MapBackedSet.java   | 2 ++
 .../apache/commons/collections4/set/PredicatedNavigableSet.java  | 1 +
 .../java/org/apache/commons/collections4/set/PredicatedSet.java  | 1 +
 .../org/apache/commons/collections4/set/PredicatedSortedSet.java | 1 +
 .../apache/commons/collections4/set/TransformedNavigableSet.java | 1 +
 .../java/org/apache/commons/collections4/set/TransformedSet.java | 1 +
 .../apache/commons/collections4/set/TransformedSortedSet.java| 1 +
 .../commons/collections4/set/UnmodifiableNavigableSet.java   | 1 +
 .../org/apache/commons/collections4/set/UnmodifiableSet.java | 1 +
 .../apache/commons/collections4/set/UnmodifiableSortedSet.java   | 1 +
 .../collections4/splitmap/AbstractIterableGetMapDecorator.java   | 2 ++
 .../commons/collections4/splitmap/TransformedSplitMap.java   | 4 
 .../java/org/apache/commons/collections4/trie/KeyAnalyzer.java   | 1 +
 43 files changed, 72 insertions(+), 7 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/Get.java
--
diff --git a/src/main/java/org/apache/commons/collections4/Get.java 
b/src/main/java/org/apache/commons/collections4/Get.java
index b414f8f..431155d 100644
--- a/src/main/java/org/apache/commons/collections4/Get.java
+++ b/src/main/java/org/apache/commons/collections4/Get.java
@@ -22,8 +22,10 @@ import java.util.Set;
 /**
  * The "read" subset of the {@link java.util.Map} interface.
  *
+ * @param  the type of the keys in this map
+ * @param  the type of the values in this map
+ * 
  * @since 4.0
- *
  * @see Put
  */
 public interface Get {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/6044892b/src/main/java/org/apache/commons/collections4/IterableGet.java

commons-collections git commit: Javadoc: Add missing @param tags for generics.

[ggregory]

Repository: commons-collections
Updated Branches:
  refs/heads/master 5d756cebd -> 36d33722c


Javadoc: Add missing @param tags for generics.

Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/36d33722
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/36d33722
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/36d33722

Branch: refs/heads/master
Commit: 36d33722c37417b2fba57106fee185a5e422ee47
Parents: 5d756ce
Author: Gary Gregory 
Authored: Thu Dec 28 13:37:20 2017 -0700
Committer: Gary Gregory 
Committed: Thu Dec 28 13:37:20 2017 -0700

--
 src/main/java/org/apache/commons/collections4/ArrayStack.java  | 1 +
 src/main/java/org/apache/commons/collections4/ListValuedMap.java   | 2 ++
 src/main/java/org/apache/commons/collections4/MultiValuedMap.java  | 2 ++
 src/main/java/org/apache/commons/collections4/SetValuedMap.java| 2 ++
 .../commons/collections4/multimap/AbstractListValuedMap.java   | 2 ++
 .../commons/collections4/multimap/AbstractMultiValuedMap.java  | 2 ++
 .../apache/commons/collections4/multimap/AbstractSetValuedMap.java | 2 ++
 .../commons/collections4/multimap/ArrayListValuedHashMap.java  | 2 ++
 .../apache/commons/collections4/multimap/HashSetValuedHashMap.java | 2 ++
 .../commons/collections4/multimap/TransformedMultiValuedMap.java   | 2 ++
 10 files changed, 19 insertions(+)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/ArrayStack.java
--
diff --git a/src/main/java/org/apache/commons/collections4/ArrayStack.java 
b/src/main/java/org/apache/commons/collections4/ArrayStack.java
index 5a6e1f4..1a8c40c 100644
--- a/src/main/java/org/apache/commons/collections4/ArrayStack.java
+++ b/src/main/java/org/apache/commons/collections4/ArrayStack.java
@@ -36,6 +36,7 @@ import java.util.EmptyStackException;
  * Note: From version 4.0 onwards, this class does not implement the
  * removed {@code Buffer} interface anymore.
  *
+ * @param  the type of elements in this list
  * @see java.util.Stack
  * @since 1.0
  * @deprecated use {@link java.util.ArrayDeque} instead (available from Java 
1.6)

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/ListValuedMap.java
--
diff --git a/src/main/java/org/apache/commons/collections4/ListValuedMap.java 
b/src/main/java/org/apache/commons/collections4/ListValuedMap.java
index f01da1f..1ebc322 100644
--- a/src/main/java/org/apache/commons/collections4/ListValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/ListValuedMap.java
@@ -27,6 +27,8 @@ import java.util.List;
  *   Getting a value will return a {@link List}, holding all the values 
put to that key.
  * 
  *
+ * @param  the type of the keys in this map
+ * @param  the type of the values in this map
  * @since 4.1
  */
 public interface ListValuedMap extends MultiValuedMap {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
--
diff --git a/src/main/java/org/apache/commons/collections4/MultiValuedMap.java 
b/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
index 0cb3cf7..b4ce38d 100644
--- a/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
@@ -42,6 +42,8 @@ import java.util.Set;
  * coll will be a collection containing "A", "B", "C".
  * 
  *
+ * @param  the type of the keys in this map
+ * @param  the type of the values in this map
  * @since 4.1
  */
 public interface MultiValuedMap {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/36d33722/src/main/java/org/apache/commons/collections4/SetValuedMap.java
--
diff --git a/src/main/java/org/apache/commons/collections4/SetValuedMap.java 
b/src/main/java/org/apache/commons/collections4/SetValuedMap.java
index 4b06103..b289e24 100644
--- a/src/main/java/org/apache/commons/collections4/SetValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/SetValuedMap.java
@@ -27,6 +27,8 @@ import java.util.Set;
  *   Getting a value will return a {@link Set}, holding all the values put 
to that key.
  * 
  *
+ * @param  the type of the keys in this map
+ * @param  the type of the values in this map
  * @since 4.1
  */
 public interface SetValuedMap extends MultiValuedMap {

commons-collections git commit: Javadoc: Add missing @param tags for generics.

[ggregory]

Repository: commons-collections
Updated Branches:
  refs/heads/master 8e09f5f53 -> 5d756cebd


Javadoc: Add missing @param tags for generics.

Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/5d756ceb
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/5d756ceb
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/5d756ceb

Branch: refs/heads/master
Commit: 5d756cebd7b99af057133befc90ad33d7f89b316
Parents: 8e09f5f
Author: Gary Gregory 
Authored: Thu Dec 28 13:32:52 2017 -0700
Committer: Gary Gregory 
Committed: Thu Dec 28 13:32:52 2017 -0700

--
 .../java/org/apache/commons/collections4/BoundedCollection.java | 1 +
 src/main/java/org/apache/commons/collections4/BoundedMap.java   | 2 ++
 src/main/java/org/apache/commons/collections4/IterableMap.java  | 5 +++--
 src/main/java/org/apache/commons/collections4/MultiMap.java | 3 +++
 src/main/java/org/apache/commons/collections4/Trie.java | 2 ++
 .../commons/collections4/bidimap/AbstractBidiMapDecorator.java  | 2 ++
 .../collections4/bidimap/AbstractOrderedBidiMapDecorator.java   | 2 ++
 .../collections4/bidimap/AbstractSortedBidiMapDecorator.java| 2 ++
 .../apache/commons/collections4/bidimap/DualTreeBidiMap.java| 2 ++
 .../org/apache/commons/collections4/bidimap/TreeBidiMap.java| 3 +++
 .../commons/collections4/bidimap/UnmodifiableBidiMap.java   | 2 ++
 .../collections4/bidimap/UnmodifiableOrderedBidiMap.java| 2 ++
 .../commons/collections4/bidimap/UnmodifiableSortedBidiMap.java | 2 ++
 .../collections4/collection/UnmodifiableBoundedCollection.java  | 1 +
 .../org/apache/commons/collections4/list/FixedSizeList.java | 1 +
 .../org/apache/commons/collections4/map/AbstractHashedMap.java  | 2 ++
 .../apache/commons/collections4/map/AbstractIterableMap.java| 2 ++
 .../org/apache/commons/collections4/map/AbstractLinkedMap.java  | 2 ++
 .../commons/collections4/map/AbstractOrderedMapDecorator.java   | 2 ++
 .../apache/commons/collections4/map/AbstractReferenceMap.java   | 3 +++
 .../org/apache/commons/collections4/map/CaseInsensitiveMap.java | 2 ++
 .../java/org/apache/commons/collections4/map/CompositeMap.java  | 2 ++
 .../java/org/apache/commons/collections4/map/DefaultedMap.java  | 4 +++-
 .../java/org/apache/commons/collections4/map/FixedSizeMap.java  | 2 ++
 .../org/apache/commons/collections4/map/FixedSizeSortedMap.java | 2 ++
 src/main/java/org/apache/commons/collections4/map/Flat3Map.java | 2 ++
 .../java/org/apache/commons/collections4/map/HashedMap.java | 2 ++
 src/main/java/org/apache/commons/collections4/map/LRUMap.java   | 2 ++
 src/main/java/org/apache/commons/collections4/map/LazyMap.java  | 2 ++
 .../java/org/apache/commons/collections4/map/LazySortedMap.java | 2 ++
 .../java/org/apache/commons/collections4/map/LinkedMap.java | 2 ++
 .../org/apache/commons/collections4/map/ListOrderedMap.java | 2 ++
 .../java/org/apache/commons/collections4/map/MultiKeyMap.java   | 2 ++
 .../java/org/apache/commons/collections4/map/MultiValueMap.java | 2 ++
 .../org/apache/commons/collections4/map/PassiveExpiringMap.java | 4 ++--
 .../java/org/apache/commons/collections4/map/PredicatedMap.java | 2 ++
 .../apache/commons/collections4/map/PredicatedSortedMap.java| 2 ++
 .../apache/commons/collections4/map/ReferenceIdentityMap.java   | 4 +++-
 .../java/org/apache/commons/collections4/map/SingletonMap.java  | 2 ++
 .../org/apache/commons/collections4/map/StaticBucketMap.java| 2 ++
 .../org/apache/commons/collections4/map/TransformedMap.java | 5 -
 .../apache/commons/collections4/map/TransformedSortedMap.java   | 2 ++
 .../org/apache/commons/collections4/map/UnmodifiableMap.java| 2 ++
 .../apache/commons/collections4/map/UnmodifiableOrderedMap.java | 2 ++
 .../apache/commons/collections4/map/UnmodifiableSortedMap.java  | 2 ++
 .../apache/commons/collections4/queue/CircularFifoQueue.java| 1 +
 .../apache/commons/collections4/trie/AbstractBitwiseTrie.java   | 2 ++
 .../java/org/apache/commons/collections4/trie/PatriciaTrie.java | 2 ++
 .../org/apache/commons/collections4/trie/UnmodifiableTrie.java  | 2 ++
 .../bidimap/AbstractOrderedBidiMapDecoratorTest.java| 2 ++
 .../java/org/apache/commons/collections4/map/IdentityMap.java   | 2 ++
 51 files changed, 106 insertions(+), 7 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/5d756ceb/src/main/java/org/apache/commons/collections4/BoundedCollection.java
--
diff --git 
a/src/main/java/org/apache/commons/collections4/BoundedCollection.java 
b/src/main/java/org/apache/commons/collections4/BoundedCollection.java
index e047219..2431cd5 

commons-collections git commit: Javadoc: Add missing @param tags for generics.

[ggregory]

Repository: commons-collections
Updated Branches:
  refs/heads/master 8b66a577f -> 8e09f5f53


Javadoc: Add missing @param tags for generics.

Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/8e09f5f5
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/8e09f5f5
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/8e09f5f5

Branch: refs/heads/master
Commit: 8e09f5f538db789ba72b52b39c56e7b111f142d5
Parents: 8b66a57
Author: Gary Gregory 
Authored: Thu Dec 28 13:22:24 2017 -0700
Committer: Gary Gregory 
Committed: Thu Dec 28 13:22:24 2017 -0700

--
 src/main/java/org/apache/commons/collections4/Bag.java | 2 +-
 src/main/java/org/apache/commons/collections4/SortedBag.java   | 2 +-
 .../org/apache/commons/collections4/bag/AbstractBagDecorator.java  | 1 +
 .../java/org/apache/commons/collections4/bag/AbstractMapBag.java   | 1 +
 .../commons/collections4/bag/AbstractSortedBagDecorator.java   | 1 +
 .../java/org/apache/commons/collections4/bag/CollectionBag.java| 2 +-
 .../org/apache/commons/collections4/bag/CollectionSortedBag.java   | 1 +
 src/main/java/org/apache/commons/collections4/bag/HashBag.java | 1 +
 .../java/org/apache/commons/collections4/bag/PredicatedBag.java| 1 +
 .../org/apache/commons/collections4/bag/PredicatedSortedBag.java   | 1 +
 .../java/org/apache/commons/collections4/bag/SynchronizedBag.java  | 1 +
 .../org/apache/commons/collections4/bag/SynchronizedSortedBag.java | 1 +
 .../java/org/apache/commons/collections4/bag/TransformedBag.java   | 1 +
 .../org/apache/commons/collections4/bag/TransformedSortedBag.java  | 1 +
 src/main/java/org/apache/commons/collections4/bag/TreeBag.java | 1 +
 .../java/org/apache/commons/collections4/bag/UnmodifiableBag.java  | 1 +
 .../org/apache/commons/collections4/bag/UnmodifiableSortedBag.java | 1 +
 17 files changed, 17 insertions(+), 3 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/Bag.java
--
diff --git a/src/main/java/org/apache/commons/collections4/Bag.java 
b/src/main/java/org/apache/commons/collections4/Bag.java
index 96c1943..c6d9781 100644
--- a/src/main/java/org/apache/commons/collections4/Bag.java
+++ b/src/main/java/org/apache/commons/collections4/Bag.java
@@ -38,7 +38,7 @@ import java.util.Set;
  * In an ideal world, the interface would be changed to fix the problems, 
however
  * it has been decided to maintain backwards compatibility instead.
  *
- * @param  the type held in the bag
+ * @param  the type of elements in this bag
  * @since 2.0
  */
 public interface Bag extends Collection {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/SortedBag.java
--
diff --git a/src/main/java/org/apache/commons/collections4/SortedBag.java 
b/src/main/java/org/apache/commons/collections4/SortedBag.java
index 15c5feb..24324b0 100644
--- a/src/main/java/org/apache/commons/collections4/SortedBag.java
+++ b/src/main/java/org/apache/commons/collections4/SortedBag.java
@@ -22,7 +22,7 @@ import java.util.Comparator;
  * Defines a type of Bag that maintains a sorted order among
  * its unique representative members.
  *
- * @param  the type to iterate over
+ * @param  the type of elements in this bag
  * @since 2.0
  */
 public interface SortedBag extends Bag {

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java
--
diff --git 
a/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java 
b/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java
index 3c952af..99e4d6d 100644
--- 
a/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java
+++ 
b/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java
@@ -26,6 +26,7 @@ import 
org.apache.commons.collections4.collection.AbstractCollectionDecorator;
  * 
  * Methods are forwarded directly to the decorated bag.
  *
+ * @param  the type of elements in this bag
  * @since 3.0
  */
 public abstract class AbstractBagDecorator

http://git-wip-us.apache.org/repos/asf/commons-collections/blob/8e09f5f5/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java
--
diff --git 
a/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java 

[61/77] [abbrv] commons-collections git commit: javadoc

[chtompki]

javadoc

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


Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/df940e08
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/df940e08
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/df940e08

Branch: refs/heads/collections_jdk5_branch
Commit: df940e08fb179603eec565bc12a3c22d48bac23d
Parents: a68a932
Author: Matthew Jason Benson 
Authored: Fri Sep 11 17:03:40 2009 +
Committer: Matthew Jason Benson 
Committed: Fri Sep 11 17:03:40 2009 +

--
 .../apache/commons/collections/IndexedCollection.java  | 13 +
 1 file changed, 9 insertions(+), 4 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/df940e08/src/java/org/apache/commons/collections/IndexedCollection.java
--
diff --git a/src/java/org/apache/commons/collections/IndexedCollection.java 
b/src/java/org/apache/commons/collections/IndexedCollection.java
index 92d8bd7..0b8b2f7 100644
--- a/src/java/org/apache/commons/collections/IndexedCollection.java
+++ b/src/java/org/apache/commons/collections/IndexedCollection.java
@@ -16,7 +16,7 @@ import 
org.apache.commons.collections.collection.AbstractCollectionDecorator;
  * If modification to the decorated {@link Collection} is unavoidable, then a
  * call to {@link #reindex()} will update the index to the current contents of
  * the {@link Collection}.
- * 
+ *
  * @param K the type of object in the index.
  * @param C the type of object in the collection.
  * @author Stephen Kestle
@@ -31,7 +31,7 @@ public class IndexedCollection extends 
AbstractCollectionDecorator {
 
 /**
  * Create an {@link IndexedCollection} for a unique index.
- * 
+ *
  * @param  the index object type.
  * @param  the collection type.
  * @param coll the decorated {@link Collection}.
@@ -54,7 +54,7 @@ public class IndexedCollection extends 
AbstractCollectionDecorator {
 
 /**
  * Create a {@link IndexedCollection} for a unique index.
- * 
+ *
  * @param coll the decorated {@link Collection}.
  * @param keyTransformer the {@link Transformer} for generating index keys.
  * @return the created {@link IndexedCollection}.
@@ -100,7 +100,7 @@ public class IndexedCollection extends 
AbstractCollectionDecorator {
 
 /**
  * Provides checking for adding the index.
- * 
+ *
  * @param object the object to index.
  */
 private void addIndex(C object) {
@@ -110,6 +110,11 @@ public class IndexedCollection extends 
AbstractCollectionDecorator {
 }
 }
 
+/**
+ * Get the element associated with the given key.
+ * @param key to look up
+ * @return element found
+ */
 public C get(K key) {
 return index.get(key);
 }

[69/77] [abbrv] commons-collections git commit: Javadoc typos; fix internal raw types

[chtompki]

Javadoc typos; fix internal raw types

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


Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/2b056936
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/2b056936
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/2b056936

Branch: refs/heads/collections_jdk5_branch
Commit: 2b056936e6cea3f1ed37fcd52b38fdad247e8aca
Parents: c673ab5
Author: Sebastian Bazley 
Authored: Fri Sep 11 22:25:29 2009 +
Committer: Sebastian Bazley 
Committed: Fri Sep 11 22:25:29 2009 +

--
 .../commons/collections/CollectionUtils.java| 38 ++--
 1 file changed, 19 insertions(+), 19 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/2b056936/src/java/org/apache/commons/collections/CollectionUtils.java
--
diff --git a/src/java/org/apache/commons/collections/CollectionUtils.java 
b/src/java/org/apache/commons/collections/CollectionUtils.java
index 4d26462..1d674f5 100644
--- a/src/java/org/apache/commons/collections/CollectionUtils.java
+++ b/src/java/org/apache/commons/collections/CollectionUtils.java
@@ -386,10 +386,10 @@ public class CollectionUtils {
  * @return the the number of occurrences of obj in coll
  */
 public static  int cardinality(O obj, final Iterable coll) {
-if (coll instanceof Set) {
+if (coll instanceof Set) {
 return (((Set) coll).contains(obj) ? 1 : 0);
 }
-if (coll instanceof Bag) {
+if (coll instanceof Bag) {
 return ((Bag) coll).getCount(obj);
 }
 int count = 0;
@@ -492,7 +492,7 @@ public class CollectionUtils {
 public static  void transform(Collection collection,
 Transformer transformer) {
 if (collection != null && transformer != null) {
-if (collection instanceof List) {
+if (collection instanceof List) {
 List list = (List) collection;
 for (ListIterator it = list.listIterator(); it.hasNext();) {
 it.set(transformer.transform(it.next()));
@@ -703,7 +703,7 @@ public class CollectionUtils {
  * @param outputCollection  the collection to output into, may not be null
  * @param  the type of object in the input collection
  * @param  the type of object in the output collection
- * @param  the output type of the transformer - this extends O.
+ * @param  the output type of the transformer - this extends O.
  * @return the outputCollection with the transformed input added
  * @throws NullPointerException if the output collection is null
  */
@@ -727,7 +727,7 @@ public class CollectionUtils {
  * @param outputCollection  the collection to output into, may not be null
  * @param  the type of object in the input collection
  * @param  the type of object in the output collection
- * @param  the output type of the transformer - this extends O.
+ * @param  the output type of the transformer - this extends O.
  * @return the outputCollection with the transformed input added
  * @throws NullPointerException if the output collection is null
  */
@@ -772,7 +772,7 @@ public class CollectionUtils {
  * if the collection or iterator is null
  */
 public static  boolean addAll(Collection collection, Iterable iterable) {
-if (iterable instanceof Collection) {
+if (iterable instanceof Collection) {
 return collection.addAll((Collection) iterable);
 }
 return addAll(collection, iterable.iterator());
@@ -879,7 +879,7 @@ public class CollectionUtils {
  */
 public static  T get(Iterable iterable, int index) {
 checkIndexBounds(index);
-if (iterable instanceof List) {
+if (iterable instanceof List) {
 return ((List) iterable).get(index);
 }
 return get(iterable.iterator(), index);
@@ -920,13 +920,13 @@ public class CollectionUtils {
 if (i < 0) {
 throw new IndexOutOfBoundsException("Index cannot be negative: " + 
i);
 }
-if (object instanceof Map) {
+if (object instanceof Map) {
 Map map = (Map) object;
 Iterator iterator = map.entrySet().iterator();
 return get(iterator, i);
 } else if (object instanceof Object[]) {
 return ((Object[]) object)[i];
-} else if (object instanceof Iterator) {
+} else if (object instanceof Iterator) {
 Iterator it = (Iterator) 

[49/77] [abbrv] commons-collections git commit: javadoc + extension point

[chtompki]

javadoc + extension point

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


Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/783aa51f
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/783aa51f
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/783aa51f

Branch: refs/heads/collections_jdk5_branch
Commit: 783aa51f14cf9dd79826401f0e627ad2a47331da
Parents: 4306110
Author: Matthew Jason Benson 
Authored: Mon Mar 9 22:06:27 2009 +
Committer: Matthew Jason Benson 
Committed: Mon Mar 9 22:06:27 2009 +

--
 .../map/EntrySetToMapIteratorAdapter.java   | 16 
 1 file changed, 12 insertions(+), 4 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/783aa51f/src/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java
--
diff --git 
a/src/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java 
b/src/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java
index a9d3f43..e69ca9d 100644
--- 
a/src/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java
+++ 
b/src/java/org/apache/commons/collections/map/EntrySetToMapIteratorAdapter.java
@@ -33,10 +33,14 @@ import org.apache.commons.collections.ResettableIterator;
  * @author Matt Benson
  */
 public class EntrySetToMapIteratorAdapter implements MapIterator, 
ResettableIterator {
-private Set> entrySet;
+/** The adapted Map entry Set. */
+protected Set> entrySet;
 
-private transient Iterator> iterator;
-private transient Map.Entry entry;
+/** The resettable iterator in use. */
+protected transient Iterator> iterator;
+
+/** The currently positioned Map entry. */
+protected transient Map.Entry entry;
 
 /**
  * Create a new EntrySetToMapIteratorAdapter.
@@ -97,7 +101,11 @@ public class EntrySetToMapIteratorAdapter implements 
MapIterator, Re
 entry = null;
 }
 
-private synchronized Map.Entry current() {
+/**
+ * Get the currently active entry.
+ * @return Map.Entry
+ */
+protected synchronized Map.Entry current() { 
 if (entry == null) {
 throw new IllegalStateException();
 }

[29/50] [abbrv] commons-collections git commit: Javadoc nit.

[chtompki]

Javadoc nit.

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


Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/5187b217
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/5187b217
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/5187b217

Branch: refs/heads/master
Commit: 5187b217882875dcd593538eee5e985b3b9a7ffd
Parents: 930015a
Author: Gary D. Gregory 
Authored: Fri May 20 22:40:13 2016 +
Committer: Gary D. Gregory 
Committed: Fri May 20 22:40:13 2016 +

--
 src/main/java/org/apache/commons/collections4/CollectionUtils.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/5187b217/src/main/java/org/apache/commons/collections4/CollectionUtils.java
--
diff --git a/src/main/java/org/apache/commons/collections4/CollectionUtils.java 
b/src/main/java/org/apache/commons/collections4/CollectionUtils.java
index c53b4c3..9a9bfdc 100644
--- a/src/main/java/org/apache/commons/collections4/CollectionUtils.java
+++ b/src/main/java/org/apache/commons/collections4/CollectionUtils.java
@@ -1313,7 +1313,7 @@ public class CollectionUtils {
  *
  * @param object  the object to get the size of, may be null
  * @return the size of the specified collection or 0 if the object was null
- * @throws IllegalArgumentException thrown if object is not recognised
+ * @throws IllegalArgumentException thrown if object is not recognized
  * @since 3.1
  */
 public static int size(final Object object) {

[25/50] [abbrv] commons-collections git commit: Javadoc nit.

[chtompki]

Javadoc nit.

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


Project: http://git-wip-us.apache.org/repos/asf/commons-collections/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/commons-collections/commit/979a93d7
Tree: http://git-wip-us.apache.org/repos/asf/commons-collections/tree/979a93d7
Diff: http://git-wip-us.apache.org/repos/asf/commons-collections/diff/979a93d7

Branch: refs/heads/master
Commit: 979a93d7b67e794f92a94a3ee776e5e553c21696
Parents: b4207ef
Author: Gary D. Gregory 
Authored: Fri Mar 11 23:51:22 2016 +
Committer: Gary D. Gregory 
Committed: Fri Mar 11 23:51:22 2016 +

--
 .../apache/commons/collections4/iterators/ObjectArrayIterator.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
--


http://git-wip-us.apache.org/repos/asf/commons-collections/blob/979a93d7/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java
--
diff --git 
a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java
 
b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java
index 33a957f..6163e0f 100644
--- 
a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java
+++ 
b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java
@@ -21,7 +21,7 @@ import java.util.NoSuchElementException;
 import org.apache.commons.collections4.ResettableIterator;
 
 /**
- * An {@link Iterator} over an array of objects.
+ * An {@link java.util.Iterator Iterator} over an array of objects.
  * 
  * This iterator does not support {@link #remove}, as the object array cannot 
be
  * structurally modified.