com.gs.collections.impl.list.fixed

Class ArrayAdapter<T>

java.lang.Object

java.util.AbstractCollection<T>

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

com.gs.collections.impl.list.mutable.AbstractMutableList<T>

com.gs.collections.impl.list.fixed.AbstractArrayAdapter<T>

com.gs.collections.impl.list.fixed.ArrayAdapter<T>

All Implemented Interfaces:

com.gs.collections.api.collection.FixedSizeCollection<T>, com.gs.collections.api.collection.MutableCollection<T>, com.gs.collections.api.InternalIterable<T>, com.gs.collections.api.list.FixedSizeList<T>, com.gs.collections.api.list.ListIterable<T>, com.gs.collections.api.list.MutableList<T>, com.gs.collections.api.RichIterable<T>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>, java.util.RandomAccess

public final class ArrayAdapter<T>
extends AbstractArrayAdapter<T>
implements java.io.Serializable, com.gs.collections.api.list.FixedSizeList<T>

This class provides a MutableList wrapper around an array. All of the internal iteration methods of the MutableList interface as well as the JDK Collections List iterface are provided. However, the pre-determined fixed-sized semantics of an array are maintained and thus mutating List interface methods such as AbstractArrayAdapter.add(Object), AbstractArrayAdapter.addAll(Collection), AbstractArrayAdapter.remove(Object), AbstractArrayAdapter.removeAll(Collection), etc. are not supported and will throw an UnsupportedOperationException. In addition, the mutating iteration methods AbstractArrayAdapter.removeIf(Predicate) and AbstractArrayAdapter.removeIfWith(Predicate2, Object) are not supported and will also throw an UnsupportedOperationException.

The with(Object) method is not an exception to the above restrictions, as it will create a new instance of this class with the existing contents plus the new item.

To create a wrapper around an existing array, use the adapt(Object[]) factory method. To wrap the contents of an existing Collection instance, use the newArray(Iterable) or newArrayWithItem(Iterable, Object) factory methods. To wrap existing objects in a new array, use one of the newArrayWith(Object) factory methods.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gs.collections.impl.list.mutable.AbstractMutableList

AbstractMutableList.SubList<T>

Field Summary

Fields inherited from class com.gs.collections.impl.list.fixed.AbstractArrayAdapter

items

Method Summary

Methods

Modifier and Type	Method and Description
static <E> ArrayAdapter<E>	adapt(E[] array)
ArrayAdapter<T>	clone()
static <E> ArrayAdapter<E>	newArray()
static <E> ArrayAdapter<E>	newArray(java.lang.Iterable<? extends E> source)
static <E> ArrayAdapter<E>	newArrayWith(E... elements)
static <E> ArrayAdapter<E>	newArrayWith(E one)
static <E> ArrayAdapter<E>	newArrayWith(E one, E two)
static <E> ArrayAdapter<E>	newArrayWith(E one, E two, E three)
static <E> ArrayAdapter<E>	newArrayWith(E one, E two, E three, E four)
static <E> ArrayAdapter<E>	newArrayWith(E one, E two, E three, E four, E five)
static <E> ArrayAdapter<E>	newArrayWith(E one, E two, E three, E four, E five, E six)
static <E> ArrayAdapter<E>	newArrayWith(E one, E two, E three, E four, E five, E six, E seven)
static <E> ArrayAdapter<E>	newArrayWithItem(java.lang.Iterable<? extends E> iterable, E itemToAdd)
T	set(int index, T element)
ArrayAdapter<T>	sortThis(java.util.Comparator<? super T> comparator) Sorts the internal data structure of this list and returns the list itself as a convenience.
com.gs.collections.api.list.MutableList<T>	toReversed() Returns a new MutableList in reverse order
ArrayAdapter<T>	with(T value) This method allows mutable and fixed size collections the ability to add elements to their existing elements.
ArrayAdapter<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.
ArrayAdapter<T>	without(T element) This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
ArrayAdapter<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.

Methods inherited from class com.gs.collections.impl.list.fixed.AbstractArrayAdapter

abstractArrayAdapterEquals, add, add, addAll, addAll, addAllIterable, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, clear, collect, collect, collectIf, collectIf, collectWith, collectWith, contains, containsAll, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, distinct, equals, flatCollect, flatCollect, forEach, forEach, forEachWith, forEachWithIndex, forEachWithIndex, get, getFirst, getLast, hashCode, indexOf, injectInto, injectIntoWith, isEmpty, iterator, lastIndexOf, listIterator, notEmpty, reject, reject, rejectWith, rejectWith, remove, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, select, select, selectAndRejectWith, selectWith, selectWith, size, subList, toArray, toArray

Methods inherited from class com.gs.collections.impl.list.mutable.AbstractMutableList

asReversed, asSynchronized, asUnmodifiable, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, defaultSort, dropWhile, groupBy, groupByEach, injectInto, injectInto, injectInto, listIterator, max, max, maxBy, min, min, minBy, newEmpty, noneSatisfy, noneSatisfyWith, partition, partitionWhile, reverseForEach, reverseThis, selectInstancesOf, sortThis, sortThisBy, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, takeWhile, toImmutable, toList, toSet, toSortedList, toSortedList, toStack, zip, zipWithIndex

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

aggregateBy, aggregateInPlaceBy, appendString, appendString, asLazy, chunk, containsAllArguments, containsAllIterable, groupBy, groupByEach, injectInto, makeString, makeString, makeString, toBag, toMap, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gs.collections.api.list.MutableList

asSynchronized, asUnmodifiable, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, distinct, dropWhile, flatCollect, groupBy, groupByEach, newEmpty, partition, partitionWhile, reject, rejectWith, reverseThis, select, selectInstancesOf, selectWith, sortThis, sortThisBy, subList, takeWhile, toImmutable, zip, zipWithIndex

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface com.gs.collections.api.list.ListIterable

equals, forEach, forEachWithIndex, get, getFirst, getLast, hashCode, indexOf, lastIndexOf, listIterator, listIterator, reverseForEach, size, toStack

Methods inherited from interface com.gs.collections.api.collection.FixedSizeCollection

add, addAll, addAllIterable, clear, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable

Methods inherited from interface com.gs.collections.api.collection.MutableCollection

aggregateBy, aggregateInPlaceBy, allSatisfyWith, anySatisfyWith, countWith, detectWith, detectWithIfNone, injectIntoWith, noneSatisfyWith, selectAndRejectWith

Methods inherited from interface com.gs.collections.api.RichIterable

allSatisfy, anySatisfy, appendString, appendString, appendString, asLazy, chunk, collect, collectIf, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, detect, detectIfNone, flatCollect, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, notEmpty, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable

forEach, forEachWith, forEachWithIndex

Method Detail

adapt

public static <E> ArrayAdapter<E> adapt(E[] array)

newArray

public static <E> ArrayAdapter<E> newArray()

newArray

public static <E> ArrayAdapter<E> newArray(java.lang.Iterable<? extends E> source)

newArrayWithItem

public static <E> ArrayAdapter<E> newArrayWithItem(java.lang.Iterable<? extends E> iterable,
                                   E itemToAdd)

newArrayWith

public static <E> ArrayAdapter<E> newArrayWith(E one)

newArrayWith

public static <E> ArrayAdapter<E> newArrayWith(E one,
                               E two)

newArrayWith

public static <E> ArrayAdapter<E> newArrayWith(E one,
                               E two,
                               E three)

newArrayWith

public static <E> ArrayAdapter<E> newArrayWith(E one,
                               E two,
                               E three,
                               E four)

newArrayWith

public static <E> ArrayAdapter<E> newArrayWith(E one,
                               E two,
                               E three,
                               E four,
                               E five)

newArrayWith

public static <E> ArrayAdapter<E> newArrayWith(E one,
                               E two,
                               E three,
                               E four,
                               E five,
                               E six)

newArrayWith

public static <E> ArrayAdapter<E> newArrayWith(E one,
                               E two,
                               E three,
                               E four,
                               E five,
                               E six,
                               E seven)

newArrayWith

public static <E> ArrayAdapter<E> newArrayWith(E... elements)

set

public T set(int index,
    T element)

Specified by:

set in interface java.util.List<T>

with

public ArrayAdapter<T> with(T value)

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.FixedSizeCollection<T>

Specified by:

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

Specified by:

with in interface com.gs.collections.api.list.MutableList<T>

Overrides:

with in class AbstractMutableList<T>

See Also:

Collection.add(Object)

without

public ArrayAdapter<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.FixedSizeCollection<T>

Specified by:

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

Specified by:

without in interface com.gs.collections.api.list.MutableList<T>

Overrides:

without in class AbstractMutableList<T>

See Also:

Collection.remove(Object)

withAll

public ArrayAdapter<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.FixedSizeCollection<T>

Specified by:

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

Specified by:

withAll in interface com.gs.collections.api.list.MutableList<T>

Overrides:

withAll in class AbstractMutableList<T>

See Also:

Collection.addAll(Collection)

withoutAll

public ArrayAdapter<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.FixedSizeCollection<T>

Specified by:

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

Specified by:

withoutAll in interface com.gs.collections.api.list.MutableList<T>

Overrides:

withoutAll in class AbstractMutableList<T>

See Also:

Collection.removeAll(Collection)

clone

public ArrayAdapter<T> clone()

Specified by:

clone in interface com.gs.collections.api.list.MutableList<T>

Overrides:

clone in class AbstractMutableList<T>

sortThis

public ArrayAdapter<T> sortThis(java.util.Comparator<? super T> comparator)

Description copied from interface: com.gs.collections.api.list.MutableList

Sorts the internal data structure of this list and returns the list itself as a convenience.

Specified by:

sortThis in interface com.gs.collections.api.list.MutableList<T>

Overrides:

sortThis in class AbstractMutableList<T>

toReversed

public com.gs.collections.api.list.MutableList<T> toReversed()

Description copied from interface: com.gs.collections.api.list.MutableList

Returns a new MutableList in reverse order

Specified by:

toReversed in interface com.gs.collections.api.list.MutableList<T>

Overrides:

toReversed in class AbstractMutableList<T>