This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-collections.git
The following commit(s) were added to refs/heads/master by this push:
new 29b780d9e Javadoc
29b780d9e is described below
commit 29b780d9e47fa20bee11c80d324f739457f08b10
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri Jul 12 10:40:41 2024 -0400
Javadoc
---
.../commons/collections4/list/AbstractLinkedListForJava21.java | 3 +++
.../commons/collections4/list/AbstractListDecorator.java | 5 ++---
.../collections4/list/AbstractSerializableListDecorator.java | 4 ++--
.../apache/commons/collections4/list/CursorableLinkedList.java | 1 +
.../java/org/apache/commons/collections4/list/GrowthList.java | 1 +
.../java/org/apache/commons/collections4/list/LazyList.java | 1 +
.../commons/collections4/list/NodeCachingLinkedList.java | 1 +
.../org/apache/commons/collections4/list/PredicatedList.java | 1 +
.../org/apache/commons/collections4/list/SetUniqueList.java | 1 +
.../org/apache/commons/collections4/list/TransformedList.java | 1 +
.../java/org/apache/commons/collections4/list/TreeList.java | 1 +
.../org/apache/commons/collections4/list/UnmodifiableList.java | 1 +
.../commons/collections4/multiset/AbstractMapMultiSet.java | 9 ++++++++-
.../apache/commons/collections4/multiset/AbstractMultiSet.java | 7 +++++++
.../apache/commons/collections4/sequence/CommandVisitor.java | 1 +
.../apache/commons/collections4/sequence/DeleteCommand.java | 2 +-
.../org/apache/commons/collections4/sequence/EditCommand.java | 2 +-
.../org/apache/commons/collections4/sequence/EditScript.java | 2 +-
.../apache/commons/collections4/sequence/InsertCommand.java | 2 +-
.../org/apache/commons/collections4/sequence/KeepCommand.java | 2 +-
.../commons/collections4/sequence/ReplacementsFinder.java | 10 +++++-----
.../commons/collections4/sequence/ReplacementsHandler.java | 5 ++++-
.../commons/collections4/sequence/SequencesComparator.java | 2 +-
.../java/org/apache/commons/collections4/set/CompositeSet.java | 2 ++
24 files changed, 49 insertions(+), 18 deletions(-)
diff --git
a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListForJava21.java
b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListForJava21.java
index b6563597d..e1f854f3c 100644
---
a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListForJava21.java
+++
b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListForJava21.java
@@ -404,6 +404,9 @@ public abstract class AbstractLinkedListForJava21<E>
implements List<E> {
* <p>
* From Commons Collections 3.1, all access to the {@code value} property
* is via the methods on this class.
+ * </p>
+ *
+ * @param <E> the type of the node value.
*/
protected static class Node<E> {
diff --git
a/src/main/java/org/apache/commons/collections4/list/AbstractListDecorator.java
b/src/main/java/org/apache/commons/collections4/list/AbstractListDecorator.java
index d29f214d6..086f94f6c 100644
---
a/src/main/java/org/apache/commons/collections4/list/AbstractListDecorator.java
+++
b/src/main/java/org/apache/commons/collections4/list/AbstractListDecorator.java
@@ -28,11 +28,10 @@ import
org.apache.commons.collections4.collection.AbstractCollectionDecorator;
* Methods are forwarded directly to the decorated list.
* </p>
*
- * @param <E> the type of the elements in the list
+ * @param <E> the type of the elements in the list.
* @since 3.0
*/
-public abstract class AbstractListDecorator<E> extends
AbstractCollectionDecorator<E>
- implements List<E> {
+public abstract class AbstractListDecorator<E> extends
AbstractCollectionDecorator<E> implements List<E> {
/** Serialization version--necessary in an abstract class? */
private static final long serialVersionUID = 4500739654952315623L;
diff --git
a/src/main/java/org/apache/commons/collections4/list/AbstractSerializableListDecorator.java
b/src/main/java/org/apache/commons/collections4/list/AbstractSerializableListDecorator.java
index 890bb00d1..b3afa870a 100644
---
a/src/main/java/org/apache/commons/collections4/list/AbstractSerializableListDecorator.java
+++
b/src/main/java/org/apache/commons/collections4/list/AbstractSerializableListDecorator.java
@@ -25,10 +25,10 @@ import java.util.List;
/**
* Serializable subclass of AbstractListDecorator.
*
+ * @param <E> the type of the elements in the list.
* @since 3.1
*/
-public abstract class AbstractSerializableListDecorator<E>
- extends AbstractListDecorator<E> {
+public abstract class AbstractSerializableListDecorator<E> extends
AbstractListDecorator<E> {
/** Serialization version */
private static final long serialVersionUID = 2684959196747496299L;
diff --git
a/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java
b/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java
index cb91d79ba..285098ff7 100644
---
a/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java
+++
b/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java
@@ -55,6 +55,7 @@ import java.util.ListIterator;
* <b>Note that this implementation is not synchronized.</b>
* </p>
*
+ * @param <E> the type of the elements in the list.
* @see java.util.LinkedList
* @since 1.0
* @deprecated parent {@link AbstractLinkedList} is source incompatible with
List methods added in Java 21
diff --git a/src/main/java/org/apache/commons/collections4/list/GrowthList.java
b/src/main/java/org/apache/commons/collections4/list/GrowthList.java
index b42d16e78..9880e7591 100644
--- a/src/main/java/org/apache/commons/collections4/list/GrowthList.java
+++ b/src/main/java/org/apache/commons/collections4/list/GrowthList.java
@@ -54,6 +54,7 @@ import java.util.List;
* can be used together by decorating twice.
* </p>
*
+ * @param <E> the type of the elements in the list.
* @see LazyList
* @since 3.2
*/
diff --git a/src/main/java/org/apache/commons/collections4/list/LazyList.java
b/src/main/java/org/apache/commons/collections4/list/LazyList.java
index 70ccd78d9..fe92de692 100644
--- a/src/main/java/org/apache/commons/collections4/list/LazyList.java
+++ b/src/main/java/org/apache/commons/collections4/list/LazyList.java
@@ -61,6 +61,7 @@ import org.apache.commons.collections4.Transformer;
* This class is Serializable from Commons Collections 3.1.
* </p>
*
+ * @param <E> the type of the elements in the list.
* @see GrowthList
* @since 3.0
*/
diff --git
a/src/main/java/org/apache/commons/collections4/list/NodeCachingLinkedList.java
b/src/main/java/org/apache/commons/collections4/list/NodeCachingLinkedList.java
index d267737cb..57945b0b1 100644
---
a/src/main/java/org/apache/commons/collections4/list/NodeCachingLinkedList.java
+++
b/src/main/java/org/apache/commons/collections4/list/NodeCachingLinkedList.java
@@ -39,6 +39,7 @@ import java.util.Collection;
* <b>Note that this implementation is not synchronized.</b>
* </p>
*
+ * @param <E> the type of the elements in the list.
* @since 3.0
* @deprecated parent {@link AbstractLinkedList} is source incompatible with
List methods added in Java 21
*/
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 aa7a5e3d8..f8c0f191a 100644
--- a/src/main/java/org/apache/commons/collections4/list/PredicatedList.java
+++ b/src/main/java/org/apache/commons/collections4/list/PredicatedList.java
@@ -45,6 +45,7 @@ import
org.apache.commons.collections4.iterators.AbstractListIteratorDecorator;
* This class is Serializable from Commons Collections 3.1.
* </p>
*
+ * @param <E> the type of the elements in the list.
* @since 3.0
*/
public class PredicatedList<E> extends PredicatedCollection<E> implements
List<E> {
diff --git
a/src/main/java/org/apache/commons/collections4/list/SetUniqueList.java
b/src/main/java/org/apache/commons/collections4/list/SetUniqueList.java
index ff9a9f68c..2f7d318f9 100644
--- a/src/main/java/org/apache/commons/collections4/list/SetUniqueList.java
+++ b/src/main/java/org/apache/commons/collections4/list/SetUniqueList.java
@@ -51,6 +51,7 @@ import org.apache.commons.collections4.set.UnmodifiableSet;
* This class is Serializable from Commons Collections 3.1.
* </p>
*
+ * @param <E> the type of the elements in the list.
* @since 3.0
*/
public class SetUniqueList<E> extends AbstractSerializableListDecorator<E> {
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 e1860fb3a..8826695d0 100644
--- a/src/main/java/org/apache/commons/collections4/list/TransformedList.java
+++ b/src/main/java/org/apache/commons/collections4/list/TransformedList.java
@@ -36,6 +36,7 @@ import
org.apache.commons.collections4.iterators.AbstractListIteratorDecorator;
* This class is Serializable from Commons Collections 3.1.
* </p>
*
+ * @param <E> the type of the elements in the list.
* @since 3.0
*/
public class TransformedList<E> extends TransformedCollection<E> implements
List<E> {
diff --git a/src/main/java/org/apache/commons/collections4/list/TreeList.java
b/src/main/java/org/apache/commons/collections4/list/TreeList.java
index e5760db53..82abbe640 100644
--- a/src/main/java/org/apache/commons/collections4/list/TreeList.java
+++ b/src/main/java/org/apache/commons/collections4/list/TreeList.java
@@ -59,6 +59,7 @@ import org.apache.commons.collections4.OrderedIterator;
* does use slightly more memory.
* </p>
*
+ * @param <E> the type of the elements in the list.
* @since 3.1
*/
public class TreeList<E> extends AbstractList<E> {
diff --git
a/src/main/java/org/apache/commons/collections4/list/UnmodifiableList.java
b/src/main/java/org/apache/commons/collections4/list/UnmodifiableList.java
index 291f22410..9aadb13b7 100644
--- a/src/main/java/org/apache/commons/collections4/list/UnmodifiableList.java
+++ b/src/main/java/org/apache/commons/collections4/list/UnmodifiableList.java
@@ -35,6 +35,7 @@ import
org.apache.commons.collections4.iterators.UnmodifiableListIterator;
* Attempts to modify it will result in an UnsupportedOperationException.
* </p>
*
+ * @param <E> the type of the elements in the list.
* @since 3.0
*/
public final class UnmodifiableList<E>
diff --git
a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
index 65e01b171..0d9cd2805 100644
---
a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
+++
b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
@@ -36,13 +36,15 @@ import
org.apache.commons.collections4.iterators.AbstractIteratorDecorator;
* number of occurrences of that element in the multiset.
* </p>
*
- * @param <E> the type held in the multiset
+ * @param <E> the type held in the multiset.
* @since 4.1
*/
public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> {
/**
* Inner class EntrySetIterator.
+ *
+ * @param <E> the element type.
*/
protected static class EntrySetIterator<E> implements Iterator<Entry<E>> {
@@ -154,8 +156,11 @@ public abstract class AbstractMapMultiSet<E> extends
AbstractMultiSet<E> {
canRemove = false;
}
}
+
/**
* Inner class MultiSetEntry.
+ *
+ * @param <E> the key type.
*/
protected static class MultiSetEntry<E> extends AbstractEntry<E> {
@@ -211,6 +216,8 @@ public abstract class AbstractMapMultiSet<E> extends
AbstractMultiSet<E> {
/**
* Inner class UniqueSetIterator.
+ *
+ * @param <E> the element type.
*/
protected static class UniqueSetIterator<E> extends
AbstractIteratorDecorator<E> {
diff --git
a/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java
b/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java
index 822da4a64..88695f80a 100644
---
a/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java
+++
b/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java
@@ -41,6 +41,8 @@ public abstract class AbstractMultiSet<E> extends
AbstractCollection<E> implemen
/**
* Inner class AbstractEntry.
+ *
+ * @param <E> the element type.
*/
protected abstract static class AbstractEntry<E> implements Entry<E> {
@@ -68,8 +70,11 @@ public abstract class AbstractMultiSet<E> extends
AbstractCollection<E> implemen
return String.format("%s:%d", getElement(), getCount());
}
}
+
/**
* Inner class EntrySet.
+ *
+ * @param <E> the element type.
*/
protected static class EntrySet<E> extends AbstractSet<Entry<E>> {
@@ -180,6 +185,8 @@ public abstract class AbstractMultiSet<E> extends
AbstractCollection<E> implemen
/**
* Inner class UniqueSet.
+ *
+ * @param <E> the element type.
*/
protected static class UniqueSet<E> extends AbstractSet<E> {
diff --git
a/src/main/java/org/apache/commons/collections4/sequence/CommandVisitor.java
b/src/main/java/org/apache/commons/collections4/sequence/CommandVisitor.java
index 001b4d42b..e0535f856 100644
--- a/src/main/java/org/apache/commons/collections4/sequence/CommandVisitor.java
+++ b/src/main/java/org/apache/commons/collections4/sequence/CommandVisitor.java
@@ -118,6 +118,7 @@ package org.apache.commons.collections4.sequence;
* }
* </pre>
*
+ * @param <T> the type of the input to the visit operations.
* @since 4.0
*/
public interface CommandVisitor<T> {
diff --git
a/src/main/java/org/apache/commons/collections4/sequence/DeleteCommand.java
b/src/main/java/org/apache/commons/collections4/sequence/DeleteCommand.java
index 9af8cebb5..26fbdb778 100644
--- a/src/main/java/org/apache/commons/collections4/sequence/DeleteCommand.java
+++ b/src/main/java/org/apache/commons/collections4/sequence/DeleteCommand.java
@@ -26,9 +26,9 @@ package org.apache.commons.collections4.sequence;
* these type of commands always come from the first sequence.
* </p>
*
+ * @param <T> the type of object to apply this command.
* @see SequencesComparator
* @see EditScript
- *
* @since 4.0
*/
public class DeleteCommand<T> extends EditCommand<T> {
diff --git
a/src/main/java/org/apache/commons/collections4/sequence/EditCommand.java
b/src/main/java/org/apache/commons/collections4/sequence/EditCommand.java
index 8c64893ab..f32c029d2 100644
--- a/src/main/java/org/apache/commons/collections4/sequence/EditCommand.java
+++ b/src/main/java/org/apache/commons/collections4/sequence/EditCommand.java
@@ -41,9 +41,9 @@ package org.apache.commons.collections4.sequence;
* and the {@code equals} method is specialized.
* </p>
*
+ * @param <T> the type of object to apply this command.
* @see SequencesComparator
* @see EditScript
- *
* @since 4.0
*/
public abstract class EditCommand<T> {
diff --git
a/src/main/java/org/apache/commons/collections4/sequence/EditScript.java
b/src/main/java/org/apache/commons/collections4/sequence/EditScript.java
index 81fe66ce8..f941fbe6c 100644
--- a/src/main/java/org/apache/commons/collections4/sequence/EditScript.java
+++ b/src/main/java/org/apache/commons/collections4/sequence/EditScript.java
@@ -37,11 +37,11 @@ import java.util.List;
* method is specialized.
* </p>
*
+ * @param <T> the type of object to apply commands.
* @see SequencesComparator
* @see EditCommand
* @see CommandVisitor
* @see ReplacementsHandler
- *
* @since 4.0
*/
public class EditScript<T> {
diff --git
a/src/main/java/org/apache/commons/collections4/sequence/InsertCommand.java
b/src/main/java/org/apache/commons/collections4/sequence/InsertCommand.java
index 4afb30bd6..b9ba2b145 100644
--- a/src/main/java/org/apache/commons/collections4/sequence/InsertCommand.java
+++ b/src/main/java/org/apache/commons/collections4/sequence/InsertCommand.java
@@ -26,9 +26,9 @@ package org.apache.commons.collections4.sequence;
* these type of commands always come from the second sequence.
* </p>
*
+ * @param <T> the type of object to apply this command.
* @see SequencesComparator
* @see EditScript
- *
* @since 4.0
*/
public class InsertCommand<T> extends EditCommand<T> {
diff --git
a/src/main/java/org/apache/commons/collections4/sequence/KeepCommand.java
b/src/main/java/org/apache/commons/collections4/sequence/KeepCommand.java
index c259d0e3f..2e5cad6fb 100644
--- a/src/main/java/org/apache/commons/collections4/sequence/KeepCommand.java
+++ b/src/main/java/org/apache/commons/collections4/sequence/KeepCommand.java
@@ -26,9 +26,9 @@ package org.apache.commons.collections4.sequence;
* these type of commands always come from the first sequence.
* </p>
*
+ * @param <T> the type of object to apply this command.
* @see SequencesComparator
* @see EditScript
- *
* @since 4.0
*/
public class KeepCommand<T> extends EditCommand<T> {
diff --git
a/src/main/java/org/apache/commons/collections4/sequence/ReplacementsFinder.java
b/src/main/java/org/apache/commons/collections4/sequence/ReplacementsFinder.java
index f4ba2a60e..d0f62f2e9 100644
---
a/src/main/java/org/apache/commons/collections4/sequence/ReplacementsFinder.java
+++
b/src/main/java/org/apache/commons/collections4/sequence/ReplacementsFinder.java
@@ -43,17 +43,17 @@ import java.util.List;
* interface to process the sub-sequences.
* </p>
*
+ * @param <T> the type of the input to the visit operations.
* @see ReplacementsHandler
* @see EditScript
* @see SequencesComparator
- *
* @since 4.0
*/
public class ReplacementsFinder<T> implements CommandVisitor<T> {
private final List<T> pendingInsertions;
private final List<T> pendingDeletions;
- private int skipped;
+ private int skipped;
/** Handler to call when synchronized sequences are found. */
private final ReplacementsHandler<T> handler;
@@ -65,9 +65,9 @@ public class ReplacementsFinder<T> implements
CommandVisitor<T> {
*/
public ReplacementsFinder(final ReplacementsHandler<T> handler) {
pendingInsertions = new ArrayList<>();
- pendingDeletions = new ArrayList<>();
- skipped = 0;
- this.handler = handler;
+ pendingDeletions = new ArrayList<>();
+ skipped = 0;
+ this.handler = handler;
}
/**
diff --git
a/src/main/java/org/apache/commons/collections4/sequence/ReplacementsHandler.java
b/src/main/java/org/apache/commons/collections4/sequence/ReplacementsHandler.java
index 318f1792a..f9159b990 100644
---
a/src/main/java/org/apache/commons/collections4/sequence/ReplacementsHandler.java
+++
b/src/main/java/org/apache/commons/collections4/sequence/ReplacementsHandler.java
@@ -21,6 +21,7 @@ import java.util.List;
/**
* This interface is devoted to handle synchronized replacement sequences.
*
+ * @param <T> the type of elements in the lists.
* @see ReplacementsFinder
* @since 4.0
*/
@@ -28,7 +29,7 @@ import java.util.List;
public interface ReplacementsHandler<T> {
/**
- * Handle two synchronized sequences.
+ * Handles two synchronized sequences.
* <p>
* This method is called by a {@link ReplacementsFinder ReplacementsFinder}
* instance when it has synchronized two sub-sequences of object arrays
@@ -36,9 +37,11 @@ public interface ReplacementsHandler<T> {
* sequences are synchronized, the objects before the two sub-sequences are
* equals (if they exist). This property also holds for the objects after
* the two sub-sequences.
+ * </p>
* <p>
* The replacement is defined as replacing the {@code from}
* sub-sequence into the {@code to} sub-sequence.
+ * </p>
*
* @param skipped number of tokens skipped since the last call (i.e.
number of
* tokens that were in both sequences), this number should be strictly
positive
diff --git
a/src/main/java/org/apache/commons/collections4/sequence/SequencesComparator.java
b/src/main/java/org/apache/commons/collections4/sequence/SequencesComparator.java
index 3a1fc25b0..8d8a8de42 100644
---
a/src/main/java/org/apache/commons/collections4/sequence/SequencesComparator.java
+++
b/src/main/java/org/apache/commons/collections4/sequence/SequencesComparator.java
@@ -52,10 +52,10 @@ import
org.apache.commons.collections4.functors.DefaultEquator;
* needed to transform the first sequence into the second one.
* </p>
*
+ * @param <T> the type of elements in the lists.
* @see EditScript
* @see EditCommand
* @see CommandVisitor
- *
* @since 4.0
*/
public class SequencesComparator<T> {
diff --git
a/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
b/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
index 54cca165c..6816278c4 100644
--- a/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
@@ -54,6 +54,8 @@ public class CompositeSet<E> implements Set<E>, Serializable {
/**
* Defines callbacks for mutation operations.
+ *
+ * @param <E> the type of the elements in this instance.
*/
public interface SetMutator<E> extends Serializable {
