com.gs.collections.impl.collection.mutable

Class CollectionAdapter<T>

java.lang.Object

com.gs.collections.impl.collection.mutable.AbstractCollectionAdapter<T>

com.gs.collections.impl.collection.mutable.CollectionAdapter<T>

All Implemented Interfaces:

com.gs.collections.api.collection.MutableCollection<T>, com.gs.collections.api.InternalIterable<T>, com.gs.collections.api.RichIterable<T>, java.io.Serializable, java.lang.Iterable<T>, java.util.Collection<T>

public final class CollectionAdapter<T>
extends AbstractCollectionAdapter<T>
implements java.io.Serializable

This class provides a MutableCollection interface wrapper around a JDK Collections Collection interface instance. All of the MutableCollection interface methods are supported in addition to the JDK Collection interface methods.

To create a new instance that wraps a collection with the MutableSet interface, use the wrapSet(Iterable) factory method. To create a new instance that wraps a collection with the MutableList interface, use the wrapList(Iterable) factory method. To wrap a collection with the MutableCollection interface alone, use the adapt(Collection) factory method.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CollectionAdapter(java.util.Collection<T> newDelegate)

Method Summary

Methods

Modifier and Type	Method and Description
static <E> com.gs.collections.api.collection.MutableCollection<E>	adapt(java.util.Collection<E> collection)
com.gs.collections.api.collection.MutableCollection<T>	asSynchronized() Returns a synchronized (thread-safe) collection backed by this collection.
com.gs.collections.api.collection.MutableCollection<T>	asUnmodifiable() Returns an unmodifiable view of this collection.
boolean	equals(java.lang.Object o)
protected java.util.Collection<T>	getDelegate()
int	hashCode()
com.gs.collections.api.collection.MutableCollection<T>	newEmpty() Deprecated. use FastList.newList() or UnifiedSet.newSet() instead
com.gs.collections.api.collection.ImmutableCollection<T>	toImmutable() Converts this MutableCollection to an ImmutableCollection.
CollectionAdapter<T>	with(T... elements)
CollectionAdapter<T>	with(T element) This method allows mutable and fixed size collections the ability to add elements to their existing elements.
CollectionAdapter<T>	withAll(java.lang.Iterable<? extends T> elements) This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements.
CollectionAdapter<T>	without(T element) This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
CollectionAdapter<T>	withoutAll(java.lang.Iterable<? extends T> elements) This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements.
static <E> com.gs.collections.api.list.MutableList<E>	wrapList(java.lang.Iterable<E> iterable)
static <E> com.gs.collections.api.set.MutableSet<E>	wrapSet(java.lang.Iterable<E> iterable)

Methods inherited from class com.gs.collections.impl.collection.mutable.AbstractCollectionAdapter

add, addAll, addAllIterable, aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, clear, collect, collect, collectBoolean, collectBoolean, collectByte, collectByte, collectChar, collectChar, collectDouble, collectDouble, collectFloat, collectFloat, collectIf, collectIf, collectInt, collectInt, collectLong, collectLong, collectShort, collectShort, collectWith, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, each, flatCollect, flatCollect, forEach, forEachWith, forEachWithIndex, getFirst, getLast, groupBy, groupBy, groupByEach, groupByEach, groupByUniqueKey, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, isEmpty, iterator, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, partition, partitionWith, reject, reject, rejectWith, rejectWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, select, select, selectAndRejectWith, selectInstancesOf, selectWith, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, tap, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, wrap, zip, zip, zipWithIndex, zipWithIndex

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CollectionAdapter

public CollectionAdapter(java.util.Collection<T> newDelegate)

Method Detail

getDelegate

protected java.util.Collection<T> getDelegate()

Specified by:

getDelegate in class AbstractCollectionAdapter<T>

asUnmodifiable

public com.gs.collections.api.collection.MutableCollection<T> asUnmodifiable()

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns an unmodifiable view of this collection. This method allows modules to provide users with "read-only" access to internal collections. Query operations on the returned collection "read through" to this collection, and attempts to modify the returned collection, whether direct or via its iterator, result in an UnsupportedOperationException.

The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.

The returned collection will be serializable if this collection is serializable.

Specified by:

asUnmodifiable in interface com.gs.collections.api.collection.MutableCollection<T>

Returns:

an unmodifiable view of this collection.

asSynchronized

public com.gs.collections.api.collection.MutableCollection<T> asSynchronized()

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Returns a synchronized (thread-safe) collection backed by this collection. In order to guarantee serial access, it is critical that all access to the backing collection is accomplished through the returned collection.

It is imperative that the user manually synchronize on the returned collection when iterating over it using the standard JDK iterator or JDK 5 for loop.

  MutableCollection collection = myCollection.asSynchronized();
     ...
  synchronized(collection)
  {
      Iterator i = c.iterator(); // Must be in the synchronized block
      while (i.hasNext())
         foo(i.next());
  }
 

Failure to follow this advice may result in non-deterministic behavior.

The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is properly synchronized internally.

  MutableCollection collection = myCollection.asSynchronized();
     ...
  collection.forEach(new Procedure()
  {
      public void value(Object each)
      {
          ...
      }
  });
 

The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.

The returned collection will be serializable if this collection is serializable.

Specified by:

asSynchronized in interface com.gs.collections.api.collection.MutableCollection<T>

Returns:

a synchronized view of this collection.

toImmutable

public com.gs.collections.api.collection.ImmutableCollection<T> toImmutable()

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Converts this MutableCollection to an ImmutableCollection.

Specified by:

toImmutable in interface com.gs.collections.api.collection.MutableCollection<T>

wrapSet

public static <E> com.gs.collections.api.set.MutableSet<E> wrapSet(java.lang.Iterable<E> iterable)

wrapList

public static <E> com.gs.collections.api.list.MutableList<E> wrapList(java.lang.Iterable<E> iterable)

adapt

public static <E> com.gs.collections.api.collection.MutableCollection<E> adapt(java.util.Collection<E> collection)

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Collection<T>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<T>

Overrides:

hashCode in class java.lang.Object

with

public CollectionAdapter<T> with(T... elements)

with

public CollectionAdapter<T> with(T element)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

This method allows mutable and fixed size collections the ability to add elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new element to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection list;
 list = list.with("1");
 list = list.with("2");
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by with, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling add on itself.

Specified by:

with in interface com.gs.collections.api.collection.MutableCollection<T>

See Also:

Collection.add(Object)

without

public CollectionAdapter<T> without(T element)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

This method allows mutable and fixed size collections the ability to remove elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned contaning the elements that would be left from the original collection after calling remove. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection list;
 list = list.without("1");
 list = list.without("2");
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by without, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling remove on itself.

Specified by:

without in interface com.gs.collections.api.collection.MutableCollection<T>

See Also:

Collection.remove(Object)

withAll

public CollectionAdapter<T> withAll(java.lang.Iterable<? extends T> elements)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new elements to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection list;
 list = list.withAll(FastList.newListWith("1", "2"));
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling addAll on itself.

Specified by:

withAll in interface com.gs.collections.api.collection.MutableCollection<T>

See Also:

Collection.addAll(Collection)

withoutAll

public CollectionAdapter<T> withoutAll(java.lang.Iterable<? extends T> elements)

Description copied from interface: com.gs.collections.api.collection.MutableCollection

This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned contaning the elements that would be left from the original collection after calling removeAll. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:

 MutableCollection list;
 list = list.withoutAll(FastList.newListWith("1", "2"));
 return list;
 

In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withoutAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling removeAll on itself.

Specified by:

withoutAll in interface com.gs.collections.api.collection.MutableCollection<T>

See Also:

Collection.removeAll(Collection)

newEmpty

@Deprecated
public com.gs.collections.api.collection.MutableCollection<T> newEmpty()

Deprecated. use FastList.newList() or UnifiedSet.newSet() instead

Description copied from interface: com.gs.collections.api.collection.MutableCollection

Creates a new empty mutable version of the same collection type. For example, if this instance is a FastList, this method will return a new empty FastList. If the class of this instance is immutable or fixed size (i.e. SingletonList) then a mutable alternative to the class will be provided.

Specified by:

newEmpty in interface com.gs.collections.api.collection.MutableCollection<T>