Cleanup of main package.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1361710 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Thomas Neidhart
parent
44bc5d5851
commit
6b73b4d72d
|
|
@ -36,11 +36,7 @@ import java.util.EmptyStackException;
|
|||
*
|
||||
* @see java.util.Stack
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Craig R. McClanahan
|
||||
* @author Paul Jack
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public class ArrayStack<E> extends ArrayList<E> implements Buffer<E> {
|
||||
|
||||
|
|
|
|||
|
|
@ -40,10 +40,7 @@ import java.util.Set;
|
|||
*
|
||||
* @param <E> the type held in the bag
|
||||
* @since 2.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Chuck Burdick
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface Bag<E> extends Collection<E> {
|
||||
|
||||
|
|
|
|||
|
|
@ -28,17 +28,10 @@ import org.apache.commons.collections.bag.UnmodifiableBag;
|
|||
import org.apache.commons.collections.bag.UnmodifiableSortedBag;
|
||||
|
||||
/**
|
||||
* Provides utility methods and decorators for {@link Bag} and {@link SortedBag}
|
||||
* instances.
|
||||
* Provides utility methods and decorators for {@link Bag} and {@link SortedBag} instances.
|
||||
*
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
* 2007) $
|
||||
*
|
||||
* @author Paul Jack
|
||||
* @author Stephen Colebourne
|
||||
* @author Andrew Freeman
|
||||
* @author Matthew Hawthorne
|
||||
* @version $Id$
|
||||
*/
|
||||
public class BagUtils {
|
||||
|
||||
|
|
|
|||
|
|
@ -37,9 +37,7 @@ package org.apache.commons.collections;
|
|||
* @param <V> the type of the values in the map
|
||||
*
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface BidiMap<K, V> extends IterableMap<K, V> {
|
||||
|
||||
|
|
|
|||
|
|
@ -29,10 +29,7 @@ import java.util.Collection;
|
|||
* @see CollectionUtils#maxSize
|
||||
*
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Herve Quiroz
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface BoundedCollection<E> extends Collection<E> {
|
||||
|
||||
|
|
|
|||
|
|
@ -24,9 +24,7 @@ package org.apache.commons.collections;
|
|||
* associated with the maximum number of elements.
|
||||
*
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface BoundedMap<K, V> extends IterableMap<K, V> {
|
||||
|
||||
|
|
|
|||
|
|
@ -37,12 +37,7 @@ import java.util.Collection;
|
|||
*
|
||||
* @param <E> the type of the elements in the buffer
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Avalon
|
||||
* @author Berin Loritsch
|
||||
* @author Paul Jack
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface Buffer<E> extends Collection<E> {
|
||||
|
||||
|
|
|
|||
|
|
@ -21,13 +21,7 @@ package org.apache.commons.collections;
|
|||
* exceeded.
|
||||
*
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Avalon
|
||||
* @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
|
||||
* @author <a href="mailto:jefft@apache.org">Jeff Turner</a>
|
||||
* @author Paul Jack
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public class BufferOverflowException extends RuntimeException {
|
||||
|
||||
|
|
|
|||
|
|
@ -24,13 +24,7 @@ import java.util.NoSuchElementException;
|
|||
* NOTE: From version 3.0, this exception extends NoSuchElementException.
|
||||
*
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Avalon
|
||||
* @author Berin Loritsch
|
||||
* @author Jeff Turner
|
||||
* @author Paul Jack
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public class BufferUnderflowException extends NoSuchElementException {
|
||||
|
||||
|
|
|
|||
|
|
@ -27,10 +27,7 @@ import org.apache.commons.collections.buffer.UnmodifiableBuffer;
|
|||
* Provides utility methods and decorators for {@link Buffer} instances.
|
||||
*
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Paul Jack
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public class BufferUtils {
|
||||
|
||||
|
|
|
|||
|
|
@ -27,11 +27,7 @@ package org.apache.commons.collections;
|
|||
*
|
||||
* @param <T> the type that the closure acts on
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author James Strachan
|
||||
* @author Nicola Ken Barozzi
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface Closure<T> {
|
||||
|
||||
|
|
|
|||
|
|
@ -48,10 +48,7 @@ import org.apache.commons.collections.functors.WhileClosure;
|
|||
* All the supplied closures are Serializable.
|
||||
*
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author Matt Benson
|
||||
* @version $Id$
|
||||
*/
|
||||
public class ClosureUtils {
|
||||
|
||||
|
|
@ -206,7 +203,7 @@ public class ClosureUtils {
|
|||
* @throws IllegalArgumentException if the closures array is null
|
||||
* @throws IllegalArgumentException if any closure in the array is null
|
||||
*/
|
||||
public static <E> Closure<E> chainedClosure(Closure<? super E>[] closures) {
|
||||
public static <E> Closure<E> chainedClosure(Closure<? super E>... closures) {
|
||||
return ChainedClosure.chainedClosure(closures);
|
||||
}
|
||||
|
||||
|
|
@ -257,7 +254,9 @@ public class ClosureUtils {
|
|||
* @throws IllegalArgumentException if the predicate is null
|
||||
* @throws IllegalArgumentException if either closure is null
|
||||
*/
|
||||
public static <E> Closure<E> ifClosure(Predicate<? super E> predicate, Closure<? super E> trueClosure, Closure<? super E> falseClosure) {
|
||||
public static <E> Closure<E> ifClosure(Predicate<? super E> predicate,
|
||||
Closure<? super E> trueClosure,
|
||||
Closure<? super E> falseClosure) {
|
||||
return IfClosure.<E>ifClosure(predicate, trueClosure, falseClosure);
|
||||
}
|
||||
|
||||
|
|
@ -301,7 +300,9 @@ public class ClosureUtils {
|
|||
* @throws IllegalArgumentException if any element in the arrays is null
|
||||
* @throws IllegalArgumentException if the arrays are different sizes
|
||||
*/
|
||||
public static <E> Closure<E> switchClosure(Predicate<? super E>[] predicates, Closure<? super E>[] closures, Closure<? super E> defaultClosure) {
|
||||
public static <E> Closure<E> switchClosure(Predicate<? super E>[] predicates,
|
||||
Closure<? super E>[] closures,
|
||||
Closure<? super E> defaultClosure) {
|
||||
return SwitchClosure.<E>switchClosure(predicates, closures, defaultClosure);
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -41,22 +41,7 @@ import org.apache.commons.collections.functors.TruePredicate;
|
|||
* Method parameters will take {@link Iterable} objects when possible.
|
||||
*
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Rodney Waldhoff
|
||||
* @author Paul Jack
|
||||
* @author Stephen Colebourne
|
||||
* @author Steve Downey
|
||||
* @author Herve Quiroz
|
||||
* @author Peter KoBek
|
||||
* @author Matthew Hawthorne
|
||||
* @author Janek Bogucki
|
||||
* @author Phil Steitz
|
||||
* @author Steven Melzer
|
||||
* @author Jon Schewe
|
||||
* @author Neil O'Toole
|
||||
* @author Stephen Smith
|
||||
* @author Stephen Kestle
|
||||
* @version $Id$
|
||||
*/
|
||||
//TODO - note generic types for review in wiki - especially <?> ones
|
||||
//TODO - doc Cardinality Helpers
|
||||
|
|
|
|||
|
|
@ -36,10 +36,7 @@ import org.apache.commons.collections.comparators.TransformingComparator;
|
|||
* in the <code>comparators</code> subpackage.
|
||||
*
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Paul Jack
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public class ComparatorUtils {
|
||||
|
||||
|
|
@ -54,7 +51,7 @@ public class ComparatorUtils {
|
|||
*
|
||||
* @see ComparableComparator#comparableComparator()
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
@SuppressWarnings({ "unchecked", "rawtypes" })
|
||||
public static final Comparator NATURAL_COMPARATOR = ComparableComparator.<Comparable>comparableComparator();
|
||||
|
||||
/**
|
||||
|
|
@ -79,7 +76,8 @@ public class ComparatorUtils {
|
|||
* @see ComparatorChain
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
public static <E extends Comparable<? super E>> Comparator<E> chainedComparator(Comparator<E> comparator1, Comparator<E> comparator2) {
|
||||
public static <E extends Comparable<? super E>> Comparator<E> chainedComparator(Comparator<E> comparator1,
|
||||
Comparator<E> comparator2) {
|
||||
return chainedComparator(new Comparator[] {comparator1, comparator2});
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -28,8 +28,6 @@ import org.apache.commons.collections.iterators.EnumerationIterator;
|
|||
*
|
||||
* @since 3.0
|
||||
* @version $Id$
|
||||
*
|
||||
* @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
|
||||
*/
|
||||
public class EnumerationUtils {
|
||||
|
||||
|
|
@ -56,7 +54,8 @@ public class EnumerationUtils {
|
|||
/**
|
||||
* Override toList(Enumeration) for StringTokenizer as it implements Enumeration<String>
|
||||
* for the sake of backward compatibility.
|
||||
* @param stringTokenizer
|
||||
*
|
||||
* @param stringTokenizer the tokenizer to convert to a {@link List(String)}
|
||||
* @return List<String>
|
||||
*/
|
||||
public static List<String> toList(StringTokenizer stringTokenizer) {
|
||||
|
|
|
|||
|
|
@ -130,22 +130,7 @@ import java.util.Vector;
|
|||
* it, go ahead and tune it up!
|
||||
*
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author <a href="mailto:stefano@apache.org">Stefano Mazzocchi</a>
|
||||
* @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>
|
||||
* @author <a href="mailto:daveb@miceda-data">Dave Bryson</a>
|
||||
* @author <a href="mailto:jvanzyl@periapt.com">Jason van Zyl</a>
|
||||
* @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
|
||||
* @author <a href="mailto:leon@opticode.co.za">Leon Messerschmidt</a>
|
||||
* @author <a href="mailto:kjohnson@transparent.com">Kent Johnson</a>
|
||||
* @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
|
||||
* @author <a href="mailto:ipriha@surfeu.fi">Ilkka Priha</a>
|
||||
* @author Janek Bogucki
|
||||
* @author Mohan Kishore
|
||||
* @author Stephen Colebourne
|
||||
* @author Shinobu Kawai
|
||||
* @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
|
||||
* @version $Id$
|
||||
*/
|
||||
public class ExtendedProperties extends Hashtable<String, Object> {
|
||||
|
||||
|
|
|
|||
|
|
@ -29,10 +29,7 @@ package org.apache.commons.collections;
|
|||
* @param <T> the type that the factory creates
|
||||
*
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Arron Bates
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface Factory<T> {
|
||||
|
||||
|
|
|
|||
|
|
@ -34,9 +34,7 @@ import org.apache.commons.collections.functors.PrototypeFactory;
|
|||
* All the supplied factories are Serializable.
|
||||
*
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public class FactoryUtils {
|
||||
|
||||
|
|
|
|||
|
|
@ -21,9 +21,7 @@ package org.apache.commons.collections;
|
|||
* If required, a root cause error can be wrapped within this one.
|
||||
*
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public class FunctorException extends RuntimeException {
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,9 @@ import org.apache.commons.collections.collection.AbstractCollectionDecorator;
|
|||
*
|
||||
* @param <K> the type of object in the index.
|
||||
* @param <C> the type of object in the collection.
|
||||
* @author Stephen Kestle
|
||||
*
|
||||
* @since 4.0
|
||||
* @version $Id$
|
||||
*/
|
||||
// TODO support MultiMap/non-unique index behavior
|
||||
// TODO add support for remove and clear
|
||||
|
|
@ -54,7 +56,8 @@ public class IndexedCollection<K, C> extends AbstractCollectionDecorator<C> {
|
|||
* @param keyTransformer the {@link Transformer} for generating index keys.
|
||||
* @return the created {@link IndexedCollection}.
|
||||
*/
|
||||
public static <K, C> IndexedCollection<K, C> uniqueIndexedCollection(final Collection<C> coll, final Transformer<C, K> keyTransformer) {
|
||||
public static <K, C> IndexedCollection<K, C> uniqueIndexedCollection(final Collection<C> coll,
|
||||
final Transformer<C, K> keyTransformer) {
|
||||
return new IndexedCollection<K, C>(coll, keyTransformer, new HashMap<K, C>());
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -16,8 +16,6 @@
|
|||
*/
|
||||
package org.apache.commons.collections;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* The "read" subset of the {@link Map} interface.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -37,9 +37,7 @@ import java.util.Map;
|
|||
* @param <V> the type of the values in the map
|
||||
*
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface IterableMap<K, V> extends Map<K, V>, Put<K, V>, IterableGet<K, V> {
|
||||
}
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ import org.apache.commons.collections.iterators.UnmodifiableMapIterator;
|
|||
* Provides static utility methods and decorators for {@link Iterator}
|
||||
* instances. The implementations are provided in the iterators subpackage.
|
||||
* <p>
|
||||
* WARNING: Due to human error certain binary incompatabilities were introduced
|
||||
* WARNING: Due to human error certain binary incompatibilities were introduced
|
||||
* between Commons Collections 2.1 and 3.0. The class remained source and test
|
||||
* compatible, so if you can recompile all your classes and dependencies
|
||||
* everything is OK. Those methods which are binary incompatible are marked as
|
||||
|
|
@ -68,10 +68,7 @@ import org.apache.commons.collections.iterators.UnmodifiableMapIterator;
|
|||
* against versions 2.1.1 and 3.1.
|
||||
*
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author Phil Steitz
|
||||
* @version $Id$
|
||||
*/
|
||||
public class IteratorUtils {
|
||||
// validation is done in this class in certain cases because the
|
||||
|
|
@ -81,7 +78,7 @@ public class IteratorUtils {
|
|||
* An iterator over no elements.
|
||||
* <p>
|
||||
* WARNING: This constant is binary incompatible with Commons Collections 2.1 and 2.1.1.
|
||||
* Use <code>EmptyIterator.INSTANCE</code> for compatability with Commons Collections 2.1.1.
|
||||
* Use <code>EmptyIterator.INSTANCE</code> for compatibility with Commons Collections 2.1.1.
|
||||
*/
|
||||
public static final ResettableIterator<Object> EMPTY_ITERATOR = EmptyIterator.RESETTABLE_INSTANCE;
|
||||
|
||||
|
|
@ -89,7 +86,7 @@ public class IteratorUtils {
|
|||
* A list iterator over no elements.
|
||||
* <p>
|
||||
* WARNING: This constant is binary incompatible with Commons Collections 2.1 and 2.1.1.
|
||||
* Use <code>EmptyListIterator.INSTANCE</code> for compatability with Commons Collections 2.1.1.
|
||||
* Use <code>EmptyListIterator.INSTANCE</code> for compatibility with Commons Collections 2.1.1.
|
||||
*/
|
||||
public static final ResettableListIterator<Object> EMPTY_LIST_ITERATOR = EmptyListIterator.RESETTABLE_INSTANCE;
|
||||
|
||||
|
|
@ -123,7 +120,7 @@ public class IteratorUtils {
|
|||
* nothing.
|
||||
* <p>
|
||||
* WARNING: This method is binary incompatible with Commons Collections 2.1 and 2.1.1.
|
||||
* Use <code>EmptyIterator.INSTANCE</code> for compatability with Commons Collections 2.1.1.
|
||||
* Use <code>EmptyIterator.INSTANCE</code> for compatibility with Commons Collections 2.1.1.
|
||||
*
|
||||
* @return an iterator over nothing
|
||||
*/
|
||||
|
|
@ -138,7 +135,7 @@ public class IteratorUtils {
|
|||
* over nothing.
|
||||
* <p>
|
||||
* WARNING: This method is binary incompatible with Commons Collections 2.1 and 2.1.1.
|
||||
* Use <code>EmptyListIterator.INSTANCE</code> for compatability with Commons Collections 2.1.1.
|
||||
* Use <code>EmptyListIterator.INSTANCE</code> for compatibility with Commons Collections 2.1.1.
|
||||
*
|
||||
* @return a list iterator over nothing
|
||||
*/
|
||||
|
|
@ -191,7 +188,7 @@ public class IteratorUtils {
|
|||
* the specified object.
|
||||
* <p>
|
||||
* WARNING: This method is binary incompatible with Commons Collections 2.1 and 2.1.1.
|
||||
* Use <code>new SingletonIterator(object)</code> for compatability.
|
||||
* Use <code>new SingletonIterator(object)</code> for compatibility.
|
||||
*
|
||||
* @param object the single object over which to iterate
|
||||
* @return a singleton iterator over the object
|
||||
|
|
@ -219,7 +216,7 @@ public class IteratorUtils {
|
|||
* Gets an iterator over an object array.
|
||||
* <p>
|
||||
* WARNING: This method is binary incompatible with Commons Collections 2.1 and 2.1.1.
|
||||
* Use <code>new ArrayIterator(array)</code> for compatability.
|
||||
* Use <code>new ArrayIterator(array)</code> for compatibility.
|
||||
*
|
||||
* @param array the array over which to iterate
|
||||
* @return an iterator over the array
|
||||
|
|
@ -248,7 +245,7 @@ public class IteratorUtils {
|
|||
* Gets an iterator over the end part of an object array.
|
||||
* <p>
|
||||
* WARNING: This method is binary incompatible with Commons Collections 2.1 and 2.1.1.
|
||||
* Use <code>new ArrayIterator(array,start)</code> for compatability.
|
||||
* Use <code>new ArrayIterator(array,start)</code> for compatibility.
|
||||
*
|
||||
* @param array the array over which to iterate
|
||||
* @param start the index to start iterating at
|
||||
|
|
@ -283,7 +280,7 @@ public class IteratorUtils {
|
|||
* Gets an iterator over part of an object array.
|
||||
* <p>
|
||||
* WARNING: This method is binary incompatible with Commons Collections 2.1 and 2.1.1.
|
||||
* Use <code>new ArrayIterator(array,start,end)</code> for compatability.
|
||||
* Use <code>new ArrayIterator(array,start,end)</code> for compatibility.
|
||||
*
|
||||
* @param array the array over which to iterate
|
||||
* @param start the index to start iterating at
|
||||
|
|
|
|||
|
|
@ -26,9 +26,7 @@ package org.apache.commons.collections;
|
|||
* @param <K> the type of the key
|
||||
* @param <V> the type of the value
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface KeyValue<K, V> {
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,6 @@
|
|||
package org.apache.commons.collections;
|
||||
|
||||
import java.util.Iterator;
|
||||
import java.util.NoSuchElementException;
|
||||
|
||||
/**
|
||||
* Defines an iterator that operates over a <code>Map</code>.
|
||||
|
|
@ -44,9 +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 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface MapIterator<K, V> extends Iterator<K> {
|
||||
|
||||
|
|
@ -61,7 +58,7 @@ public interface MapIterator<K, V> extends Iterator<K> {
|
|||
* Gets the next <em>key</em> from the <code>Map</code>.
|
||||
*
|
||||
* @return the next key in the iteration
|
||||
* @throws NoSuchElementException if the iteration is finished
|
||||
* @throws java.util.NoSuchElementException if the iteration is finished
|
||||
*/
|
||||
K next();
|
||||
|
||||
|
|
|
|||
|
|
@ -71,20 +71,7 @@ import org.apache.commons.collections.map.UnmodifiableSortedMap;
|
|||
* </ul>
|
||||
*
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
|
||||
* @author <a href="mailto:nissim@nksystems.com">Nissim Karpenstein</a>
|
||||
* @author <a href="mailto:knielsen@apache.org">Kasper Nielsen</a>
|
||||
* @author Paul Jack
|
||||
* @author Stephen Colebourne
|
||||
* @author Matthew Hawthorne
|
||||
* @author Arun Mammen Thomas
|
||||
* @author Janek Bogucki
|
||||
* @author Max Rydahl Andersen
|
||||
* @author <a href="mailto:equinus100@hotmail.com">Ashwin S</a>
|
||||
* @author <a href="mailto:jcarman@apache.org">James Carman</a>
|
||||
* @author Neil O'Toole
|
||||
* @version $Id$
|
||||
*/
|
||||
public class MapUtils {
|
||||
|
||||
|
|
|
|||
|
|
@ -40,11 +40,7 @@ import java.util.Collection;
|
|||
* as they were defined in the superinterface <code>Map</code> anyway.
|
||||
*
|
||||
* @since 2.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Christopher Berry
|
||||
* @author James Strachan
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface MultiMap<K, V> extends IterableMap<K, Object> {
|
||||
|
||||
|
|
|
|||
|
|
@ -27,9 +27,7 @@ package org.apache.commons.collections;
|
|||
* @param <V> the type of the values in the map
|
||||
*
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface OrderedBidiMap<K, V> extends BidiMap<K, V>, OrderedMap<K, V> {
|
||||
|
||||
|
|
|
|||
|
|
@ -17,8 +17,6 @@
|
|||
package org.apache.commons.collections;
|
||||
|
||||
import java.util.Iterator;
|
||||
import java.util.ListIterator;
|
||||
import java.util.NoSuchElementException;
|
||||
|
||||
/**
|
||||
* Defines an iterator that operates over an ordered container. Subset of {@link ListIterator}.
|
||||
|
|
@ -27,9 +25,7 @@ import java.util.NoSuchElementException;
|
|||
*
|
||||
* @param <E> the type to iterate over
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface OrderedIterator<E> extends Iterator<E> {
|
||||
|
||||
|
|
@ -44,7 +40,7 @@ public interface OrderedIterator<E> extends Iterator<E> {
|
|||
* Gets the previous element from the container.
|
||||
*
|
||||
* @return the previous element in the iteration
|
||||
* @throws NoSuchElementException if the iteration is finished
|
||||
* @throws java.util.NoSuchElementException if the iteration is finished
|
||||
*/
|
||||
E previous();
|
||||
|
||||
|
|
|
|||
|
|
@ -24,9 +24,7 @@ package org.apache.commons.collections;
|
|||
* @param <V> the type of the values in the map
|
||||
*
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface OrderedMap<K, V> extends IterableMap<K, V> {
|
||||
|
||||
|
|
|
|||
|
|
@ -16,8 +16,6 @@
|
|||
*/
|
||||
package org.apache.commons.collections;
|
||||
|
||||
import java.util.NoSuchElementException;
|
||||
|
||||
/**
|
||||
* Defines an iterator that operates over an ordered <code>Map</code>.
|
||||
* <p>
|
||||
|
|
@ -26,9 +24,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 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface OrderedMapIterator<K, V> extends MapIterator<K, V>, OrderedIterator<K> {
|
||||
|
||||
|
|
@ -43,7 +39,7 @@ public interface OrderedMapIterator<K, V> extends MapIterator<K, V>, OrderedIter
|
|||
* Gets the previous <em>key</em> from the <code>Map</code>.
|
||||
*
|
||||
* @return the previous key in the iteration
|
||||
* @throws NoSuchElementException if the iteration is finished
|
||||
* @throws java.util.NoSuchElementException if the iteration is finished
|
||||
*/
|
||||
K previous();
|
||||
|
||||
|
|
|
|||
|
|
@ -31,10 +31,7 @@ package org.apache.commons.collections;
|
|||
* @param <T> the type that the predicate queries
|
||||
*
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author James Strachan
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface Predicate<T> {
|
||||
|
||||
|
|
|
|||
|
|
@ -25,9 +25,7 @@ import java.util.Iterator;
|
|||
*
|
||||
* @param <E> the type to iterate over
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface ResettableIterator<E> extends Iterator<E> {
|
||||
|
||||
|
|
|
|||
|
|
@ -25,9 +25,7 @@ import java.util.ListIterator;
|
|||
*
|
||||
* @param <E> the type to iterate over
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface ResettableListIterator<E> extends ListIterator<E>, ResettableIterator<E>, OrderedIterator<E> {
|
||||
|
||||
|
|
|
|||
|
|
@ -37,12 +37,7 @@ import org.apache.commons.collections.set.UnmodifiableSortedSet;
|
|||
* {@link Set} and {@link SortedSet} instances.
|
||||
*
|
||||
* @since 2.1
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Paul Jack
|
||||
* @author Stephen Colebourne
|
||||
* @author Neil O'Toole
|
||||
* @author Matthew Hawthorne
|
||||
* @version $Id$
|
||||
*/
|
||||
public class SetUtils {
|
||||
|
||||
|
|
|
|||
|
|
@ -24,9 +24,7 @@ import java.util.Comparator;
|
|||
*
|
||||
* @param <E> the type to iterate over
|
||||
* @since 2.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Chuck Burdick
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface SortedBag<E> extends Bag<E> {
|
||||
|
||||
|
|
|
|||
|
|
@ -29,9 +29,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 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface SortedBidiMap<K, V> extends OrderedBidiMap<K, V>, SortedMap<K, V> {
|
||||
|
||||
|
|
|
|||
|
|
@ -33,10 +33,7 @@ package org.apache.commons.collections;
|
|||
* @param <O> the output type from the transformer
|
||||
*
|
||||
* @since 1.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author James Strachan
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface Transformer<I, O> {
|
||||
|
||||
|
|
|
|||
|
|
@ -57,10 +57,7 @@ import org.apache.commons.collections.functors.SwitchTransformer;
|
|||
* All the supplied transformers are Serializable.
|
||||
*
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author James Carman
|
||||
* @version $Id$
|
||||
*/
|
||||
public class TransformerUtils {
|
||||
|
||||
|
|
|
|||
|
|
@ -27,13 +27,11 @@ package org.apache.commons.collections;
|
|||
* // now we know coll is modifiable
|
||||
* </pre>
|
||||
* Of course all this only works if you use the Unmodifiable classes defined
|
||||
* in this library. If you use the JDK unmodifiable class via java util Collections
|
||||
* in this library. If you use the JDK unmodifiable class via {@code java.util Collections}
|
||||
* then the interface won't be there.
|
||||
*
|
||||
* @since 3.0
|
||||
* @version $Revision$
|
||||
*
|
||||
* @author Stephen Colebourne
|
||||
* @version $Id$
|
||||
*/
|
||||
public interface Unmodifiable {
|
||||
// marker interface - no methods to implement
|
||||
|
|
|
|||
|
|
@ -0,0 +1,28 @@
|
|||
/*
|
||||
* Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
* contributor license agreements. See the NOTICE file distributed with
|
||||
* this work for additional information regarding copyright ownership.
|
||||
* The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
* (the "License"); you may not use this file except in compliance with
|
||||
* the License. You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
/**
|
||||
* This package contains the interfaces and utilities shared across all the subpackages of this component.
|
||||
* <p>
|
||||
* The following collection implementations are provided in the package:
|
||||
* <ul>
|
||||
* <li>ArrayStack - a non synchronized Stack that follows the same API as {@code java.util Stack}
|
||||
* <li>ExtendedProperties - extends the Properties class to add extra functionality
|
||||
* </ul>
|
||||
*
|
||||
* @version $Id$
|
||||
*/
|
||||
package org.apache.commons.collections;
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
<!-- $Id$ -->
|
||||
<!--
|
||||
Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
contributor license agreements. See the NOTICE file distributed with
|
||||
this work for additional information regarding copyright ownership.
|
||||
The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
(the "License"); you may not use this file except in compliance with
|
||||
the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
<body>
|
||||
<p>
|
||||
This package contains the interfaces and utilities shared across all the subpackages of this component.
|
||||
</p>
|
||||
<p>
|
||||
The following collection implementations are provided in the package:
|
||||
<ul>
|
||||
<li>ArrayStack - a non synchronized Stack that follows the same API as java util Stack
|
||||
<li>ExtendedProperties - extends the Properties class to add extra functionality
|
||||
</ul>
|
||||
<p>
|
||||
|
||||
</body>
|
||||
Loading…
Reference in New Issue