Fix @since tag: remove redundant Commons Collections, change 5 to 4.0 where applicable.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1361689 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Thomas Neidhart
parent
3c233e4caf
commit
eb1e54d991
|
|
@ -35,7 +35,7 @@ import java.util.EmptyStackException;
|
|||
* Unlike <code>Stack</code>, <code>ArrayStack</code> accepts null entries.
|
||||
*
|
||||
* @see java.util.Stack
|
||||
* @since Commons Collections 1.0
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Craig R. McClanahan
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ import java.util.Set;
|
|||
* it has been decided to maintain backwards compatibility instead.
|
||||
*
|
||||
* @param <E> the type held in the bag
|
||||
* @since Commons Collections 2.0
|
||||
* @since 2.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Chuck Burdick
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ import org.apache.commons.collections.bag.UnmodifiableSortedBag;
|
|||
* Provides utility methods and decorators for {@link Bag} and {@link SortedBag}
|
||||
* instances.
|
||||
*
|
||||
* @since Commons Collections 2.1
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
* 2007) $
|
||||
*
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ package org.apache.commons.collections;
|
|||
* @param <K> the type of the keys in the map
|
||||
* @param <V> the type of the values in the map
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ import java.util.Collection;
|
|||
* @see CollectionUtils#isFull
|
||||
* @see CollectionUtils#maxSize
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Herve Quiroz
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ package org.apache.commons.collections;
|
|||
* maximum number of elements. This interface allows the querying of details
|
||||
* associated with the maximum number of elements.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ import java.util.Collection;
|
|||
* {@link Bag}.
|
||||
*
|
||||
* @param <E> the type of the elements in the buffer
|
||||
* @since Commons Collections 2.1
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Avalon
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ package org.apache.commons.collections;
|
|||
* The BufferOverflowException is used when the buffer's capacity has been
|
||||
* exceeded.
|
||||
*
|
||||
* @since Commons Collections 2.1
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Avalon
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ import java.util.NoSuchElementException;
|
|||
* <p>
|
||||
* NOTE: From version 3.0, this exception extends NoSuchElementException.
|
||||
*
|
||||
* @since Commons Collections 2.1
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Avalon
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ import org.apache.commons.collections.buffer.UnmodifiableBuffer;
|
|||
/**
|
||||
* Provides utility methods and decorators for {@link Buffer} instances.
|
||||
*
|
||||
* @since Commons Collections 2.1
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Paul Jack
|
||||
|
|
@ -101,7 +101,7 @@ public class BufferUtils {
|
|||
* @param timeoutMillis the timeout value in milliseconds, zero or less for no timeout
|
||||
* @return a blocking buffer backed by that buffer
|
||||
* @throws IllegalArgumentException if the Buffer is null
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static <E> Buffer<E> blockingBuffer(Buffer<E> buffer, long timeoutMillis) {
|
||||
return BlockingBuffer.blockingBuffer(buffer, timeoutMillis);
|
||||
|
|
@ -119,7 +119,7 @@ public class BufferUtils {
|
|||
* @param maximumSize the maximum size
|
||||
* @return a bounded buffer backed by the given buffer
|
||||
* @throws IllegalArgumentException if the given buffer is null
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static <E> Buffer<E> boundedBuffer(Buffer<E> buffer, int maximumSize) {
|
||||
return BoundedBuffer.boundedBuffer(buffer, maximumSize);
|
||||
|
|
@ -138,7 +138,7 @@ public class BufferUtils {
|
|||
* @param timeoutMillis the timeout value in milliseconds, zero or less for no timeout
|
||||
* @return a bounded buffer backed by the given buffer
|
||||
* @throws IllegalArgumentException if the given buffer is null
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static <E> Buffer<E> boundedBuffer(Buffer<E> buffer, int maximumSize, long timeoutMillis) {
|
||||
return BoundedBuffer.boundedBuffer(buffer, maximumSize, timeoutMillis);
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ package org.apache.commons.collections;
|
|||
* {@link ClosureUtils}. These include method invocation and for/while loops.
|
||||
*
|
||||
* @param <T> the type that the closure acts on
|
||||
* @since Commons Collections 1.0
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author James Strachan
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ import org.apache.commons.collections.functors.WhileClosure;
|
|||
* </ul>
|
||||
* All the supplied closures are Serializable.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
@ -238,7 +238,7 @@ public class ClosureUtils {
|
|||
* @return the <code>if</code> closure
|
||||
* @throws IllegalArgumentException if the predicate is null
|
||||
* @throws IllegalArgumentException if the closure is null
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static <E> Closure<E> ifClosure(Predicate<? super E> predicate, Closure<? super E> trueClosure) {
|
||||
return IfClosure.<E>ifClosure(predicate, trueClosure);
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ import org.apache.commons.collections.functors.TruePredicate;
|
|||
* Provides utility methods and decorators for {@link Collection} instances.
|
||||
* Method parameters will take {@link Iterable} objects when possible.
|
||||
*
|
||||
* @since Commons Collections 1.0
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Rodney Waldhoff
|
||||
|
|
@ -793,7 +793,7 @@ public class CollectionUtils {
|
|||
* @param object the object to add, if null it will not be added
|
||||
* @return true if the collection changed
|
||||
* @throws NullPointerException if the collection is null
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static <T> boolean addIgnoreNull(Collection<T> collection, T object) {
|
||||
if (collection == null) {
|
||||
|
|
@ -1037,7 +1037,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
|
||||
* @since Commons Collections 3.1
|
||||
* @since 3.1
|
||||
*/
|
||||
public static int size(Object object) {
|
||||
if (object == null) {
|
||||
|
|
@ -1090,7 +1090,7 @@ public class CollectionUtils {
|
|||
* @param object the object to get the size of, may be null
|
||||
* @return true if empty or null
|
||||
* @throws IllegalArgumentException thrown if object is not recognised
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static boolean sizeIsEmpty(Object object) {
|
||||
if (object == null) {
|
||||
|
|
@ -1122,7 +1122,7 @@ public class CollectionUtils {
|
|||
*
|
||||
* @param coll the collection to check, may be null
|
||||
* @return true if empty or null
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static boolean isEmpty(Collection<?> coll) {
|
||||
return (coll == null || coll.isEmpty());
|
||||
|
|
@ -1135,7 +1135,7 @@ public class CollectionUtils {
|
|||
*
|
||||
* @param coll the collection to check, may be null
|
||||
* @return true if non-null and non-empty
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static boolean isNotEmpty(Collection<?> coll) {
|
||||
return !isEmpty(coll);
|
||||
|
|
@ -1237,7 +1237,7 @@ public class CollectionUtils {
|
|||
* @return a <code>Collection</code> containing all the elements of <code>collection</code>
|
||||
* that occur at least once in <code>retain</code>.
|
||||
* @throws NullPointerException if either parameter is null
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static <C> Collection<C> retainAll(Collection<C> collection, Collection<?> retain) {
|
||||
return ListUtils.retainAll(collection, retain);
|
||||
|
|
@ -1257,7 +1257,7 @@ public class CollectionUtils {
|
|||
* @return a <code>Collection</code> containing all the elements of <code>collection</code> except
|
||||
* any elements that also occur in <code>remove</code>.
|
||||
* @throws NullPointerException if either parameter is null
|
||||
* @since Commons Collections 3.3 (method existed in 3.2 but was completely broken)
|
||||
* @since 3.3 (method existed in 3.2 but was completely broken)
|
||||
*/
|
||||
public static <E> Collection<E> removeAll(Collection<E> collection, Collection<?> remove) {
|
||||
return ListUtils.removeAll(collection, remove);
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ import org.apache.commons.collections.comparators.TransformingComparator;
|
|||
* convenient central place if you have use for more than one class
|
||||
* in the <code>comparators</code> subpackage.
|
||||
*
|
||||
* @since Commons Collections 2.1
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Paul Jack
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ import org.apache.commons.collections.iterators.EnumerationIterator;
|
|||
/**
|
||||
* Provides utility methods for {@link Enumeration} instances.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*
|
||||
* @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
|
||||
|
|
|
|||
|
|
@ -129,7 +129,7 @@ import java.util.Vector;
|
|||
* much time to improve it), I wrote it this way. If you don't like
|
||||
* it, go ahead and tune it up!
|
||||
*
|
||||
* @since Commons Collections 1.0
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author <a href="mailto:stefano@apache.org">Stefano Mazzocchi</a>
|
||||
|
|
@ -1105,7 +1105,7 @@ public class ExtendedProperties extends Hashtable<String, Object> {
|
|||
* @return The associated List object.
|
||||
* @throws ClassCastException is thrown if the key maps to an
|
||||
* object that is not a List.
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public List<String> getList(String key) {
|
||||
return getList(key, null);
|
||||
|
|
@ -1122,7 +1122,7 @@ public class ExtendedProperties extends Hashtable<String, Object> {
|
|||
* @return The associated List.
|
||||
* @throws ClassCastException is thrown if the key maps to an
|
||||
* object that is not a List.
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public List<String> getList(String key, List<String> defaultValue) {
|
||||
Object value = get(key);
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ package org.apache.commons.collections;
|
|||
*
|
||||
* @param <T> the type that the factory creates
|
||||
*
|
||||
* @since Commons Collections 2.1
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Arron Bates
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ import org.apache.commons.collections.functors.PrototypeFactory;
|
|||
* </ul>
|
||||
* All the supplied factories are Serializable.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ package org.apache.commons.collections;
|
|||
* Runtime exception thrown from functors.
|
||||
* If required, a root cause error can be wrapped within this one.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ import java.util.Set;
|
|||
/**
|
||||
* The "read" subset of the {@link Map} interface.
|
||||
*
|
||||
* @since Commons Collections 4.0
|
||||
* @since 4.0
|
||||
* @version $Id$
|
||||
*
|
||||
* @see Put
|
||||
|
|
|
|||
|
|
@ -20,11 +20,11 @@ import java.util.Map;
|
|||
|
||||
/**
|
||||
* The "read" subset of the {@link Map} interface.
|
||||
* @since Commons Collections 5
|
||||
* TODO fix version
|
||||
* @version $Revision$
|
||||
*
|
||||
* @since 4.0
|
||||
* @version $Id$
|
||||
*
|
||||
* @see Put
|
||||
* @author Matt Benson
|
||||
*/
|
||||
public interface IterableGet<K, V> extends Get<K, V> {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ import java.util.Map;
|
|||
* @param <K> the type of the keys in the map
|
||||
* @param <V> the type of the values in the map
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -23,11 +23,9 @@ import java.util.SortedMap;
|
|||
*
|
||||
* @param <K> the type of the keys in the map
|
||||
* @param <V> the type of the values in the map
|
||||
* @since Commons Collections 5
|
||||
* TODO fix version
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Matt Benson
|
||||
* @since 4.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface IterableSortedMap<K, V> extends SortedMap<K, V>, OrderedMap<K, V> {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ import org.apache.commons.collections.iterators.UnmodifiableMapIterator;
|
|||
* such, together with alternate solutions that are binary compatible
|
||||
* against versions 2.1.1 and 3.1.
|
||||
*
|
||||
* @since Commons Collections 2.1
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
@ -601,7 +601,7 @@ public class IteratorUtils {
|
|||
* @param root the root object to start iterating from, null results in an empty iterator
|
||||
* @param transformer the transformer to use, see above, null uses no effect transformer
|
||||
* @return a new object graph iterator
|
||||
* @since Commons Collections 3.1
|
||||
* @since 3.1
|
||||
*/
|
||||
public static <E> Iterator<E> objectGraphIterator(E root, Transformer<? super E, ? extends E> transformer) {
|
||||
return new ObjectGraphIterator<E>(root, transformer);
|
||||
|
|
@ -703,7 +703,7 @@ public class IteratorUtils {
|
|||
* @param list the list to iterate over, not null
|
||||
* @return a new looping iterator
|
||||
* @throws NullPointerException if the list is null
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static <E> ResettableListIterator<E> loopingListIterator(List<E> list) {
|
||||
if (list == null) {
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ package org.apache.commons.collections;
|
|||
*
|
||||
* @param <K> the type of the key
|
||||
* @param <V> the type of the value
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ import org.apache.commons.collections.list.UnmodifiableList;
|
|||
/**
|
||||
* Provides utility methods and decorators for {@link List} instances.
|
||||
*
|
||||
* @since Commons Collections 1.0
|
||||
* @since 1.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class ListUtils {
|
||||
|
|
@ -237,7 +237,7 @@ public class ListUtils {
|
|||
* @return a <code>List</code> containing all the elements of <code>c</code>
|
||||
* that occur at least once in <code>retain</code>.
|
||||
* @throws NullPointerException if either parameter is null
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static <E> List<E> retainAll(Collection<E> collection, Collection<?> retain) {
|
||||
List<E> list = new ArrayList<E>(Math.min(collection.size(), retain.size()));
|
||||
|
|
@ -265,7 +265,7 @@ public class ListUtils {
|
|||
* @return a <code>List</code> containing all the elements of <code>c</code> except
|
||||
* any elements that also occur in <code>remove</code>.
|
||||
* @throws NullPointerException if either parameter is null
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static <E> List<E> removeAll(Collection<E> collection, Collection<?> remove) {
|
||||
List<E> list = new ArrayList<E>();
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ import java.util.NoSuchElementException;
|
|||
*
|
||||
* @param <K> the type of the keys in the map
|
||||
* @param <V> the type of the values in the map
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ import org.apache.commons.collections.map.UnmodifiableSortedMap;
|
|||
* <li>{@link #multiValueMap( Map, Factory )}
|
||||
* </ul>
|
||||
*
|
||||
* @since Commons Collections 1.0
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
|
||||
|
|
@ -1138,7 +1138,7 @@ public class MapUtils {
|
|||
* @throws IllegalArgumentException if sub-array or entry matching used and an
|
||||
* entry is invalid
|
||||
* @throws ClassCastException if the array contents is mixed
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
public static <K, V> Map<K, V> putAll(Map<K, V> map, Object[] array) {
|
||||
|
|
@ -1181,7 +1181,7 @@ public class MapUtils {
|
|||
*
|
||||
* @param map the map to check, may be null
|
||||
* @return true if empty or null
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static boolean isEmpty(Map<?,?> map) {
|
||||
return (map == null || map.isEmpty());
|
||||
|
|
@ -1194,7 +1194,7 @@ public class MapUtils {
|
|||
*
|
||||
* @param map the map to check, may be null
|
||||
* @return true if non-null and non-empty
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static boolean isNotEmpty(Map<?,?> map) {
|
||||
return !MapUtils.isEmpty(map);
|
||||
|
|
@ -1394,7 +1394,7 @@ public class MapUtils {
|
|||
* @param map the map to decorate
|
||||
* @return a multi-value map backed by the given map which returns ArrayLists of values.
|
||||
* @see MultiValueMap
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static <K, V> MultiValueMap<K, V> multiValueMap(Map<K, ? super Collection<V>> map) {
|
||||
return MultiValueMap.<K, V>multiValueMap(map);
|
||||
|
|
@ -1409,7 +1409,7 @@ public class MapUtils {
|
|||
* and extend Collection).
|
||||
* @return a multi-value map backed by the given map which returns collections of the specified type
|
||||
* @see MultiValueMap
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static <K, V, C extends Collection<V>> MultiValueMap<K, V> multiValueMap(Map<K, C> map, Class<C> collectionClass) {
|
||||
return MultiValueMap.multiValueMap(map, collectionClass);
|
||||
|
|
@ -1424,7 +1424,7 @@ public class MapUtils {
|
|||
* @return a multi-value map backed by the given map which returns collections
|
||||
* created by the specified collection factory
|
||||
* @see MultiValueMap
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static <K, V, C extends Collection<V>> MultiValueMap<K, V> multiValueMap(Map<K, C> map, Factory<C> collectionFactory) {
|
||||
return MultiValueMap.multiValueMap(map, collectionFactory);
|
||||
|
|
@ -1648,8 +1648,7 @@ public class MapUtils {
|
|||
* @param <V>
|
||||
* @param map to wrap if necessary.
|
||||
* @return IterableMap<K, V>
|
||||
* @since Commons Collections 5
|
||||
* TODO fix version
|
||||
* @since 4.0
|
||||
*/
|
||||
public static <K, V> IterableMap<K, V> iterableMap(Map<K, V> map) {
|
||||
if (map == null) {
|
||||
|
|
@ -1666,8 +1665,7 @@ public class MapUtils {
|
|||
* @param <V>
|
||||
* @param sortedMap to wrap if necessary
|
||||
* @return {@link IterableSortedMap}<K, V>
|
||||
* @since Commons Collections 5
|
||||
* TODO fix version
|
||||
* @since 4.0
|
||||
*/
|
||||
public static <K, V> IterableSortedMap<K, V> iterableSortedMap(SortedMap<K, V> sortedMap) {
|
||||
if (sortedMap == null) {
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ import java.util.Collection;
|
|||
* These were added solely for documentation purposes and do not change the interface
|
||||
* as they were defined in the superinterface <code>Map</code> anyway.
|
||||
*
|
||||
* @since Commons Collections 2.0
|
||||
* @since 2.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Christopher Berry
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ package org.apache.commons.collections;
|
|||
* @param <K> the type of the keys in the map
|
||||
* @param <V> the type of the values in the map
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ import java.util.NoSuchElementException;
|
|||
* This iterator allows both forward and reverse iteration through the container.
|
||||
*
|
||||
* @param <E> the type to iterate over
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ package org.apache.commons.collections;
|
|||
* @param <K> the type of the keys in the map
|
||||
* @param <V> the type of the values in the map
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ import java.util.NoSuchElementException;
|
|||
*
|
||||
* @param <K> the type of the keys in the map
|
||||
* @param <V> the type of the values in the map
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ package org.apache.commons.collections;
|
|||
*
|
||||
* @param <T> the type that the predicate queries
|
||||
*
|
||||
* @since Commons Collections 1.0
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author James Strachan
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ import org.apache.commons.collections.functors.UniquePredicate;
|
|||
* </ul>
|
||||
* All the supplied predicates are Serializable.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class PredicateUtils {
|
||||
|
|
@ -538,7 +538,7 @@ public class PredicateUtils {
|
|||
* @param predicate the predicate to call with the result of the transform
|
||||
* @return the predicate
|
||||
* @throws IllegalArgumentException if the transformer or the predicate is null
|
||||
* @since Commons Collections 3.1
|
||||
* @since 3.1
|
||||
*/
|
||||
public static <T> Predicate<T> transformedPredicate(
|
||||
Transformer<? super T, ? extends T> transformer, Predicate<? super T> predicate) {
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ import java.util.Map;
|
|||
/**
|
||||
* The "write" subset of the {@link Map} interface.
|
||||
*
|
||||
* @since Commons Collections 4.0
|
||||
* @since 4.0
|
||||
* @version $Id$
|
||||
*
|
||||
* @see Get
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ import java.util.Iterator;
|
|||
* This interface allows an iterator to be repeatedly reused.
|
||||
*
|
||||
* @param <E> the type to iterate over
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ import java.util.ListIterator;
|
|||
* This interface allows an iterator to be repeatedly reused.
|
||||
*
|
||||
* @param <E> the type to iterate over
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ import org.apache.commons.collections.set.UnmodifiableSortedSet;
|
|||
* Provides utility methods and decorators for
|
||||
* {@link Set} and {@link SortedSet} instances.
|
||||
*
|
||||
* @since Commons Collections 2.1
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Paul Jack
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ import java.util.Comparator;
|
|||
* its unique representative members.
|
||||
*
|
||||
* @param <E> the type to iterate over
|
||||
* @since Commons Collections 2.0
|
||||
* @since 2.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Chuck Burdick
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ import java.util.SortedMap;
|
|||
*
|
||||
* @param <K> the type of the keys in the map
|
||||
* @param <V> the type of the values in the map
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ import org.apache.commons.collections.set.UnmodifiableSet;
|
|||
* Utilities for working with "split maps:" objects that implement {@link Put}
|
||||
* and/or {@link Get} but not {@link Map}.
|
||||
*
|
||||
* @since Commons Collections 4.0
|
||||
* @since 4.0
|
||||
* @version $Id$
|
||||
*
|
||||
* @see Get
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ package org.apache.commons.collections;
|
|||
* @param <I> the input type to the transformer
|
||||
* @param <O> the output type from the transformer
|
||||
*
|
||||
* @since Commons Collections 1.0
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author James Strachan
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ import org.apache.commons.collections.functors.SwitchTransformer;
|
|||
* </ul>
|
||||
* All the supplied transformers are Serializable.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ package org.apache.commons.collections;
|
|||
* in this library. If you use the JDK unmodifiable class via java util Collections
|
||||
* then the interface won't be there.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ import org.apache.commons.collections.collection.AbstractCollectionDecorator;
|
|||
* <p>
|
||||
* Methods are forwarded directly to the decorated bag.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public abstract class AbstractBagDecorator<E>
|
||||
|
|
@ -37,7 +37,7 @@ public abstract class AbstractBagDecorator<E>
|
|||
|
||||
/**
|
||||
* Constructor only used in deserialization, do not use otherwise.
|
||||
* @since Commons Collections 3.1
|
||||
* @since 3.1
|
||||
*/
|
||||
protected AbstractBagDecorator() {
|
||||
super();
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ import org.apache.commons.collections.set.UnmodifiableSet;
|
|||
* map will be used to map bag elements to a number; the number represents the
|
||||
* number of occurrences of that element in the bag.
|
||||
*
|
||||
* @since Commons Collections 3.0 (previously DefaultMapBag v2.0)
|
||||
* @since 3.0 (previously DefaultMapBag v2.0)
|
||||
* @version $Id$
|
||||
*/
|
||||
public abstract class AbstractMapBag<E> implements Bag<E> {
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ import org.apache.commons.collections.SortedBag;
|
|||
* <p>
|
||||
* Methods are forwarded directly to the decorated bag.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public abstract class AbstractSortedBagDecorator<E>
|
||||
|
|
@ -36,7 +36,7 @@ public abstract class AbstractSortedBagDecorator<E>
|
|||
|
||||
/**
|
||||
* Constructor only used in deserialization, do not use otherwise.
|
||||
* @since Commons Collections 3.1
|
||||
* @since 3.1
|
||||
*/
|
||||
protected AbstractSortedBagDecorator() {
|
||||
super();
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ import org.apache.commons.collections.Bag;
|
|||
* interface javadoc carefully as several methods violate the
|
||||
* {@link Collection} interface specification.
|
||||
*
|
||||
* @since Commons Collections 3.0 (previously in main package v2.0)
|
||||
* @since 3.0 (previously in main package v2.0)
|
||||
* @version $Id$
|
||||
*/
|
||||
public class HashBag<E>
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ import org.apache.commons.collections.collection.PredicatedCollection;
|
|||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class PredicatedBag<E>
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ import org.apache.commons.collections.SortedBag;
|
|||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class PredicatedSortedBag<E>
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ import org.apache.commons.collections.set.SynchronizedSet;
|
|||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class SynchronizedBag<E>
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ import org.apache.commons.collections.SortedBag;
|
|||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class SynchronizedSortedBag<E>
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ import org.apache.commons.collections.set.TransformedSet;
|
|||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class TransformedBag<E>
|
||||
|
|
@ -71,7 +71,7 @@ public class TransformedBag<E>
|
|||
* @param transformer the transformer to use for conversion, must not be null
|
||||
* @return a new transformed Bag
|
||||
* @throws IllegalArgumentException if bag or transformer is null
|
||||
* @since Commons Collections 3.3
|
||||
* @since 3.3
|
||||
*/
|
||||
public static <E> Bag<E> transformedBag(Bag<E> bag, Transformer<? super E, ? extends E> transformer) {
|
||||
TransformedBag<E> decorated = new TransformedBag<E>(bag, transformer);
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ import org.apache.commons.collections.Transformer;
|
|||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class TransformedSortedBag<E>
|
||||
|
|
@ -70,7 +70,7 @@ public class TransformedSortedBag<E>
|
|||
* @param transformer the transformer to use for conversion, must not be null
|
||||
* @return a new transformed SortedBag
|
||||
* @throws IllegalArgumentException if bag or transformer is null
|
||||
* @since Commons Collections 3.3
|
||||
* @since 3.3
|
||||
*/
|
||||
public static <E> TransformedSortedBag<E> transformedSortedBag(SortedBag<E> bag,
|
||||
Transformer<? super E, ? extends E> transformer) {
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ import org.apache.commons.collections.SortedBag;
|
|||
* javadoc carefully as several methods violate the {@link Collection}
|
||||
* interface specification.
|
||||
*
|
||||
* @since Commons Collections 3.0 (previously in main package v2.0)
|
||||
* @since 3.0 (previously in main package v2.0)
|
||||
* @version $Id$
|
||||
*/
|
||||
public class TreeBag<E> extends AbstractMapBag<E> implements SortedBag<E>, Serializable {
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ import org.apache.commons.collections.set.UnmodifiableSet;
|
|||
* <p>
|
||||
* Attempts to modify it will result in an UnsupportedOperationException.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public final class UnmodifiableBag<E>
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ import org.apache.commons.collections.set.UnmodifiableSet;
|
|||
* <p>
|
||||
* Attempts to modify it will result in an UnsupportedOperationException.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public final class UnmodifiableSortedBag<E>
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ import org.apache.commons.collections.map.AbstractMapDecorator;
|
|||
* it would provide a loophole around the validation.
|
||||
* But, you might want that loophole, so this class is kept simple.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public abstract class AbstractBidiMapDecorator<K, V>
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ import org.apache.commons.collections.keyvalue.AbstractMapEntryDecorator;
|
|||
*
|
||||
* @see DualHashBidiMap
|
||||
* @see DualTreeBidiMap
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> {
|
||||
|
|
@ -94,7 +94,7 @@ public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> {
|
|||
*
|
||||
* @param normalMap the normal direction map
|
||||
* @param reverseMap the reverse direction map
|
||||
* @since Commons Collections 3.1
|
||||
* @since 3.1
|
||||
*/
|
||||
protected AbstractDualBidiMap(Map<K, V> normalMap, Map<V, K> reverseMap) {
|
||||
super();
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ import org.apache.commons.collections.OrderedMapIterator;
|
|||
* it would provide a loophole around the validation.
|
||||
* But, you might want that loophole, so this class is kept simple.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public abstract class AbstractOrderedBidiMapDecorator<K, V>
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ import org.apache.commons.collections.SortedBidiMap;
|
|||
* it would provide a loophole around the validation.
|
||||
* But, you might want that loophole, so this class is kept simple.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public abstract class AbstractSortedBidiMapDecorator<K, V>
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ import org.apache.commons.collections.BidiMap;
|
|||
* NOTE: From Commons Collections 3.1, all subclasses will use {@link HashMap}
|
||||
* and the flawed <code>createMap</code> method is ignored.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class DualHashBidiMap<K, V> extends AbstractDualBidiMap<K, V> implements Serializable {
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ import org.apache.commons.collections.map.AbstractSortedMapDecorator;
|
|||
* NOTE: From Commons Collections 3.1, all subclasses will use {@link TreeMap}
|
||||
* and the flawed <code>createMap</code> method is ignored.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class DualTreeBidiMap<K, V> extends AbstractDualBidiMap<K, V>
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ import static org.apache.commons.collections.bidimap.TreeBidiMap.DataElement.VAL
|
|||
* not allow setValue() and will throw an
|
||||
* UnsupportedOperationException on attempts to call that method.
|
||||
*
|
||||
* @since Commons Collections 3.0 (previously DoubleOrderedMap v2.0)
|
||||
* @since 3.0 (previously DoubleOrderedMap v2.0)
|
||||
* @version $Id$
|
||||
*/
|
||||
public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> implements OrderedBidiMap<K, V> {
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ import org.apache.commons.collections.set.UnmodifiableSet;
|
|||
* <p>
|
||||
* Attempts to modify it will result in an UnsupportedOperationException.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public final class UnmodifiableBidiMap<K, V>
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ import org.apache.commons.collections.set.UnmodifiableSet;
|
|||
* <p>
|
||||
* Attempts to modify it will result in an UnsupportedOperationException.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public final class UnmodifiableOrderedBidiMap<K, V>
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ import org.apache.commons.collections.set.UnmodifiableSet;
|
|||
* <p>
|
||||
* Attempts to modify it will result in an {@link UnsupportedOperationException}.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public final class UnmodifiableSortedBidiMap<K, V>
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ import org.apache.commons.collections.collection.AbstractCollectionDecorator;
|
|||
* Methods are forwarded directly to the decorated buffer.
|
||||
*
|
||||
* @param <E> the type of the elements in the buffer
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public abstract class AbstractBufferDecorator<E> extends AbstractCollectionDecorator<E>
|
||||
|
|
@ -36,7 +36,7 @@ public abstract class AbstractBufferDecorator<E> extends AbstractCollectionDecor
|
|||
|
||||
/**
|
||||
* Constructor only used in deserialization, do not use otherwise.
|
||||
* @since Commons Collections 3.1
|
||||
* @since 3.1
|
||||
*/
|
||||
protected AbstractBufferDecorator() {
|
||||
super();
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ import org.apache.commons.collections.BufferUnderflowException;
|
|||
*
|
||||
* @param <E> the type of the elements in the buffer
|
||||
* @version $Revision$
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
*/
|
||||
public class BlockingBuffer<E> extends SynchronizedBuffer<E> {
|
||||
|
||||
|
|
@ -72,7 +72,7 @@ public class BlockingBuffer<E> extends SynchronizedBuffer<E> {
|
|||
* @param timeoutMillis the timeout value in milliseconds, zero or less for no timeout
|
||||
* @return a new blocking buffer
|
||||
* @throws IllegalArgumentException if the buffer is null
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public static <E> BlockingBuffer<E> blockingBuffer(Buffer<E> buffer, long timeoutMillis) {
|
||||
return new BlockingBuffer<E>(buffer, timeoutMillis);
|
||||
|
|
@ -96,7 +96,7 @@ public class BlockingBuffer<E> extends SynchronizedBuffer<E> {
|
|||
* @param buffer the buffer to decorate, must not be null
|
||||
* @param timeoutMillis the timeout value in milliseconds, zero or less for no timeout
|
||||
* @throws IllegalArgumentException if the buffer is null
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
protected BlockingBuffer(Buffer<E> buffer, long timeoutMillis) {
|
||||
super(buffer);
|
||||
|
|
@ -158,7 +158,7 @@ public class BlockingBuffer<E> extends SynchronizedBuffer<E> {
|
|||
* @return the next object in the buffer
|
||||
* @throws BufferUnderflowException if an interrupt is received
|
||||
* @throws BufferUnderflowException if the timeout expires
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public E get(final long timeout) {
|
||||
synchronized (lock) {
|
||||
|
|
@ -217,7 +217,7 @@ public class BlockingBuffer<E> extends SynchronizedBuffer<E> {
|
|||
* @return the next object in the buffer, which is also removed
|
||||
* @throws BufferUnderflowException if an interrupt is received
|
||||
* @throws BufferUnderflowException if the timeout expires
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
*/
|
||||
public E remove(final long timeout) {
|
||||
synchronized (lock) {
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ import org.apache.commons.collections.iterators.AbstractIteratorDecorator;
|
|||
* With a timeout, the add methods will wait for up to the timeout period
|
||||
* to try and add the elements.
|
||||
*
|
||||
* @since Commons Collections 3.2
|
||||
* @since 3.2
|
||||
* @version $Id$
|
||||
*/
|
||||
public class BoundedBuffer<E> extends SynchronizedBuffer<E> implements BoundedCollection<E> {
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ import org.apache.commons.collections.BufferUnderflowException;
|
|||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @since Commons Collections 3.0 (previously in main package v2.1)
|
||||
* @since 3.0 (previously in main package v2.1)
|
||||
* @version $Id$
|
||||
*/
|
||||
public class BoundedFifoBuffer<E> extends AbstractCollection<E>
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ import java.util.Collection;
|
|||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class CircularFifoBuffer<E> extends BoundedFifoBuffer<E> {
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ import org.apache.commons.collections.collection.PredicatedCollection;
|
|||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class PredicatedBuffer<E> extends PredicatedCollection<E> implements Buffer<E> {
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ import org.apache.commons.collections.comparators.ComparableComparator;
|
|||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.2.
|
||||
*
|
||||
* @since Commons Collections 3.0 (previously BinaryHeap v1.0)
|
||||
* @since 3.0 (previously BinaryHeap v1.0)
|
||||
* @version $Id$
|
||||
*/
|
||||
public class PriorityBuffer<E> extends AbstractCollection<E> implements Buffer<E>, Serializable {
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ import org.apache.commons.collections.collection.SynchronizedCollection;
|
|||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @param <E> the type of the elements in the buffer
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class SynchronizedBuffer<E>
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ import org.apache.commons.collections.collection.TransformedCollection;
|
|||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class TransformedBuffer<E> extends TransformedCollection<E> implements Buffer<E> {
|
||||
|
|
@ -69,7 +69,7 @@ public class TransformedBuffer<E> extends TransformedCollection<E> implements Bu
|
|||
* @param transformer the transformer to use for conversion, must not be null
|
||||
* @return a new transformed Buffer
|
||||
* @throws IllegalArgumentException if buffer or transformer is null
|
||||
* @since Commons Collections 3.3
|
||||
* @since 3.3
|
||||
*/
|
||||
public static <E> TransformedBuffer<E> transformedBuffer(Buffer<E> buffer,
|
||||
Transformer<? super E, ? extends E> transformer) {
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ import org.apache.commons.collections.BufferUnderflowException;
|
|||
* <p>
|
||||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @since Commons Collections 3.0 (previously in main package v2.1)
|
||||
* @since 3.0 (previously in main package v2.1)
|
||||
* @version $Id$
|
||||
*/
|
||||
public class UnboundedFifoBuffer<E> extends AbstractCollection<E> implements Buffer<E>, Serializable {
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ import org.apache.commons.collections.iterators.UnmodifiableIterator;
|
|||
* <p>
|
||||
* Attempts to modify it will result in an UnsupportedOperationException.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public final class UnmodifiableBuffer<E>
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ import java.util.Iterator;
|
|||
* to write an unmodifiable implementation it might provide a loophole.
|
||||
*
|
||||
* @param <E> the type of the elements in the collection
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public abstract class AbstractCollectionDecorator<E>
|
||||
|
|
@ -50,7 +50,7 @@ public abstract class AbstractCollectionDecorator<E>
|
|||
|
||||
/**
|
||||
* Constructor only used in deserialization, do not use otherwise.
|
||||
* @since Commons Collections 3.1
|
||||
* @since 3.1
|
||||
*/
|
||||
protected AbstractCollectionDecorator() {
|
||||
super();
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ import java.util.Collection;
|
|||
*
|
||||
* @param <D> the type of the elements in the decorated collection
|
||||
* @param <E> the element type of the Collection implementation
|
||||
* @since Commons Collections 4.0
|
||||
* @since 4.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public abstract class AbstractUntypedCollectionDecorator<E, D> implements Collection<E>, Serializable {
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ import org.apache.commons.collections.list.UnmodifiableList;
|
|||
* strategy is provided then add and remove are unsupported.
|
||||
*
|
||||
* @param <E> the type of the elements in the collection
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class CompositeCollection<E> implements Collection<E>, Serializable {
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ import org.apache.commons.collections.Predicate;
|
|||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @param <E> the type of the elements in the collection
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class PredicatedCollection<E> extends AbstractCollectionDecorator<E> {
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ import java.util.Iterator;
|
|||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @param <E> the type of the elements in the collection
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class SynchronizedCollection<E> implements Collection<E>, Serializable {
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ import org.apache.commons.collections.Transformer;
|
|||
* This class is Serializable from Commons Collections 3.1.
|
||||
*
|
||||
* @param <E> the type of the elements in the collection
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class TransformedCollection<E> extends AbstractCollectionDecorator<E> {
|
||||
|
|
@ -75,7 +75,7 @@ public class TransformedCollection<E> extends AbstractCollectionDecorator<E> {
|
|||
* @param transformer the transformer to use for conversion, must not be null
|
||||
* @return a new transformed Collection
|
||||
* @throws IllegalArgumentException if collection or transformer is null
|
||||
* @since Commons Collections 3.3
|
||||
* @since 3.3
|
||||
*/
|
||||
public static <E> TransformedCollection<E> transformedCollection(Collection<E> collection,
|
||||
Transformer<? super E, ? extends E> transformer) {
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ import org.apache.commons.collections.iterators.UnmodifiableIterator;
|
|||
* <p>
|
||||
* Attempts to modify it will result in an UnsupportedOperationException.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public final class UnmodifiableBoundedCollection<E> extends AbstractCollectionDecorator<E>
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ import org.apache.commons.collections.iterators.UnmodifiableIterator;
|
|||
* Attempts to modify it will result in an UnsupportedOperationException.
|
||||
*
|
||||
* @param <E> the type of the elements in the collection
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public final class UnmodifiableCollection<E>
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ import java.util.Comparator;
|
|||
* @see #getFalseFirstComparator()
|
||||
* @see #booleanComparator(boolean)
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public final class BooleanComparator implements Comparator<Boolean>, Serializable {
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ import java.util.Comparator;
|
|||
* This is no longer the case. See {@link #compare(Object, Object) compare} for
|
||||
* details.
|
||||
*
|
||||
* @since Commons Collections 2.0
|
||||
* @since 2.0
|
||||
* @version $Id$
|
||||
*
|
||||
* @see java.util.Collections#reverseOrder()
|
||||
|
|
@ -98,7 +98,7 @@ public class ComparableComparator<E extends Comparable<? super E>> implements Co
|
|||
* {@link #equals(Object) equals}.
|
||||
*
|
||||
* @return a hash code for this comparator.
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
*/
|
||||
@Override
|
||||
public int hashCode() {
|
||||
|
|
@ -116,7 +116,7 @@ public class ComparableComparator<E extends Comparable<? super E>> implements Co
|
|||
*
|
||||
* @param object the object to compare with
|
||||
* @return {@code true} if equal
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
*/
|
||||
@Override
|
||||
public boolean equals(Object object) {
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ import java.util.List;
|
|||
* thread-safe at construction time, but it <i>is</i> thread-safe to perform
|
||||
* multiple comparisons after all the setup operations are complete.
|
||||
*
|
||||
* @since Commons Collections 2.0
|
||||
* @since 2.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class ComparatorChain<E> implements Comparator<E>, Serializable {
|
||||
|
|
@ -300,7 +300,7 @@ public class ComparatorChain<E> implements Comparator<E>, Serializable {
|
|||
* {@link #equals(Object) equals}.
|
||||
*
|
||||
* @return a suitable hash code
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
*/
|
||||
@Override
|
||||
public int hashCode() {
|
||||
|
|
@ -328,7 +328,7 @@ public class ComparatorChain<E> implements Comparator<E>, Serializable {
|
|||
*
|
||||
* @param object the object to compare with
|
||||
* @return true if equal
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
*/
|
||||
@Override
|
||||
public boolean equals(Object object) {
|
||||
|
|
|
|||
|
|
@ -40,14 +40,14 @@ import java.util.Map;
|
|||
* thread-safe at construction time, but it is thread-safe to perform
|
||||
* multiple comparisons after all the setup operations are complete.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class FixedOrderComparator<T> implements Comparator<T> {
|
||||
|
||||
/**
|
||||
* Unknown object behavior enum.
|
||||
* @since Commons Collections 4.0
|
||||
* @since 4.0
|
||||
*/
|
||||
public static enum UnknownObjectBehavior {
|
||||
BEFORE, AFTER, EXCEPTION;
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ import org.apache.commons.collections.ComparatorUtils;
|
|||
* A Comparator that will compare nulls to be either lower or higher than
|
||||
* other objects.
|
||||
*
|
||||
* @since Commons Collections 2.0
|
||||
* @since 2.0
|
||||
* @version $Id$
|
||||
*/
|
||||
public class NullComparator<E> implements Comparator<E>, Serializable {
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ import org.apache.commons.collections.ComparatorUtils;
|
|||
* Reverses the order of another comparator by reversing the arguments
|
||||
* to its {@link #compare(Object, Object) compare} method.
|
||||
*
|
||||
* @since Commons Collections 2.0
|
||||
* @since 2.0
|
||||
* @version $Id$
|
||||
*
|
||||
* @see java.util.Collections#reverseOrder()
|
||||
|
|
@ -83,7 +83,7 @@ public class ReverseComparator<E> implements Comparator<E>, Serializable {
|
|||
* {@link #equals(Object) equals}.
|
||||
*
|
||||
* @return a suitable hash code
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
*/
|
||||
@Override
|
||||
public int hashCode() {
|
||||
|
|
@ -104,7 +104,7 @@ public class ReverseComparator<E> implements Comparator<E>, Serializable {
|
|||
*
|
||||
* @param object the object to compare to
|
||||
* @return true if equal
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
*/
|
||||
@Override
|
||||
public boolean equals(Object object) {
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ import org.apache.commons.collections.Transformer;
|
|||
* return value from the transform operation will be passed to the decorated
|
||||
* {@link Comparator#compare(Object,Object) compare} method.
|
||||
*
|
||||
* @since Commons Collections 2.1
|
||||
* @since 2.1
|
||||
* @version $Id$
|
||||
*
|
||||
* @see org.apache.commons.collections.Transformer
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ import org.apache.commons.collections.Predicate;
|
|||
* NOTE: In versions prior to 3.2 an array size of zero or one
|
||||
* threw an exception.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
@ -123,7 +123,7 @@ public final class AllPredicate<T> implements Predicate<T>, PredicateDecorator<T
|
|||
* Gets the predicates, do not modify the array.
|
||||
*
|
||||
* @return the predicates
|
||||
* @since Commons Collections 3.1
|
||||
* @since 3.1
|
||||
*/
|
||||
public Predicate<? super T>[] getPredicates() {
|
||||
return iPredicates;
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ import org.apache.commons.collections.Predicate;
|
|||
/**
|
||||
* Predicate implementation that returns true if both the predicates return true.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
@ -80,7 +80,7 @@ public final class AndPredicate<T> implements Predicate<T>, PredicateDecorator<T
|
|||
* Gets the two predicates being decorated as an array.
|
||||
*
|
||||
* @return the predicates
|
||||
* @since Commons Collections 3.1
|
||||
* @since 3.1
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
public Predicate<? super T>[] getPredicates() {
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ import org.apache.commons.collections.Predicate;
|
|||
* NOTE: In versions prior to 3.2 an array size of zero or one
|
||||
* threw an exception.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
@ -119,7 +119,7 @@ public final class AnyPredicate<T> implements Predicate<T>, PredicateDecorator<T
|
|||
* Gets the predicates, do not modify the array.
|
||||
*
|
||||
* @return the predicates
|
||||
* @since Commons Collections 3.1
|
||||
* @since 3.1
|
||||
*/
|
||||
public Predicate<? super T>[] getPredicates() {
|
||||
return iPredicates;
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ import org.apache.commons.collections.FunctorException;
|
|||
* }
|
||||
* </pre>
|
||||
*
|
||||
* @since Commons Collections 4.0
|
||||
* @since 4.0
|
||||
* @version $Revision$
|
||||
*/
|
||||
public abstract class CatchAndRethrowClosure<E> implements Closure<E> {
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ import org.apache.commons.collections.Closure;
|
|||
/**
|
||||
* Closure implementation that chains the specified closures together.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
@ -106,7 +106,7 @@ public class ChainedClosure<E> implements Closure<E>, Serializable {
|
|||
/**
|
||||
* Gets the closures, do not modify the array.
|
||||
* @return the closures
|
||||
* @since Commons Collections 3.1
|
||||
* @since 3.1
|
||||
*/
|
||||
public Closure<? super E>[] getClosures() {
|
||||
return iClosures;
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ import org.apache.commons.collections.Transformer;
|
|||
* The input object is passed to the first transformer. The transformed result
|
||||
* is passed to the second transformer and so on.
|
||||
*
|
||||
* @since Commons Collections 3.0
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
|
|
@ -107,7 +107,7 @@ public class ChainedTransformer<T> implements Transformer<T, T>, Serializable {
|
|||
/**
|
||||
* Gets the transformers, do not modify the array.
|
||||
* @return the transformers
|
||||
* @since Commons Collections 3.1
|
||||
* @since 3.1
|
||||
*/
|
||||
public Transformer<? super T, ? extends T>[] getTransformers() {
|
||||
return iTransformers;
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue