CompositeFastList (Goldman Sachs Collections

java.lang.Object
- com.gs.collections.impl.AbstractRichIterable<T>
- - com.gs.collections.impl.collection.mutable.AbstractMutableCollection<T>
  - - com.gs.collections.impl.list.mutable.AbstractMutableList<E>
    - - com.gs.collections.impl.list.mutable.CompositeFastList<E>

All Implemented Interfaces:

com.gs.collections.api.collection.MutableCollection<E>, com.gs.collections.api.InternalIterable<E>, com.gs.collections.api.list.ListIterable<E>, com.gs.collections.api.list.MutableList<E>, com.gs.collections.api.ordered.ReversibleIterable<E>, com.gs.collections.api.RichIterable<E>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>
```
public final class CompositeFastList<E>
extends AbstractMutableList<E>
implements java.io.Serializable
```
CompositeFastList behaves like a list, but is composed of at least one list. It is useful where you don't want the additional expense of appending several lists or allocating memory for a super list to add multiple sublists to.
Note: mutation operations (e.g. add and remove, sorting) will change the underlying lists - so be sure to only use a composite list where it will be the only reference to the sublists (for example, a composite list which contains multiple query results is OK as long as it is the only thing that references the lists)

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.gs.collections.impl.list.mutable.AbstractMutableList
  AbstractMutableList.SubList<T>

Constructor Summary

Constructors
Constructor and Description

CompositeFastList()

Constructors
Constructor and Description
`CompositeFastList()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(E object)`
`void`	`add(int index, E element)`
`boolean`	`addAll(java.util.Collection<? extends E> collection)`
`boolean`	`addAll(int index, java.util.Collection<? extends E> collection)`
`void`	`addComposited(java.util.Collection<? extends E> collection)`
`void`	`clear()`
`com.gs.collections.api.list.MutableList<E>`	`clone()`
`boolean`	`contains(java.lang.Object object)` Returns true if the iterable has an element which responds true to element.equals(object).
`boolean`	`containsAll(java.util.Collection<?> collection)` Returns true if all elements in source are contained in this collection.
`protected void`	`defaultSort(java.util.Comparator<? super E> comparator)` Override in subclasses where it can be optimized.
`boolean`	`equals(java.lang.Object other)` Follows the same general contract as `List.equals(Object)`.
`void`	`forEach(int fromIndex, int toIndex, com.gs.collections.api.block.procedure.Procedure<? super E> procedure)` Iterates over the section of the list covered by the specified inclusive indexes.
`void`	`forEach(com.gs.collections.api.block.procedure.Procedure<? super E> procedure)` The procedure is executed for each element in the iterable.
`<P> void`	`forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super E,? super P> procedure2, P parameter)` The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
`void`	`forEachWithIndex(int fromIndex, int toIndex, com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super E> objectIntProcedure)` Iterates over the section of the list covered by the specified inclusive indexes.
`void`	`forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super E> objectIntProcedure)` Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
`E`	`get(int index)` Returns the item at the specified position in this list iterable.
`int`	`hashCode()` Follows the same general contract as `List.hashCode()`.
`int`	`indexOf(java.lang.Object o)` Returns the index of the first occurrence of the specified item in this list, or -1 if this list does not contain the item.
`boolean`	`isEmpty()` Returns true if this iterable has zero items.
`java.util.Iterator<E>`	`iterator()`
`int`	`lastIndexOf(java.lang.Object o)` Returns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.
`java.util.ListIterator<E>`	`listIterator()` a list iterator is a problem for a composite list as going back in the order of the list is an issue, as are the other methods like set() and add() (and especially, remove).
`java.util.ListIterator<E>`	`listIterator(int index)` a llst iterator is a problem for a composite list as going back in the order of the list is an issue, as are the other methods like set() and add() (and especially, remove).
`E`	`remove(int index)`
`boolean`	`remove(java.lang.Object object)`
`boolean`	`removeAll(java.util.Collection<?> collection)`
`boolean`	`retainAll(java.util.Collection<?> collection)`
`void`	`reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super E> procedure)` Evaluates the procedure for each element of the list iterating in reverse order.
`CompositeFastList<E>`	`reverseThis()` Mutates the current list by reversing its order and returns the current list as a result
`E`	`set(int index, E element)`
`int`	`size()` Returns the number of items in this iterable.
`java.lang.Object[]`	`toArray()` Converts this iterable to an array.
`java.lang.Object[]`	`toArray(java.lang.Object[] array)` Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.

Methods inherited from class com.gs.collections.impl.list.mutable.AbstractMutableList
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, asReversed, asSynchronized, asUnmodifiable, binarySearch, binarySearch, collect, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectIf, collectInt, collectLong, collectShort, collectWith, collectWith, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, distinct, dropWhile, flatCollect, flatCollect, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectIntoWith, max, max, maxBy, min, min, minBy, newEmpty, noneSatisfy, noneSatisfyWith, partition, partitionWhile, partitionWith, reject, reject, rejectWith, rejectWith, removeIf, removeIfWith, select, select, selectAndRejectWith, selectInstancesOf, selectWith, selectWith, sortThis, sortThis, sortThisBy, subList, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, takeWhile, toImmutable, toList, toReversed, toSet, toSortedList, toSortedList, toStack, with, withAll, without, withoutAll, zip, zipWithIndex

Methods inherited from class com.gs.collections.impl.collection.mutable.AbstractMutableCollection
addAllIterable, aggregateBy, aggregateInPlaceBy, chunk, removeAllIterable, retainAllIterable

Methods inherited from class com.gs.collections.impl.AbstractRichIterable
appendString, appendString, asLazy, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAllArguments, containsAllIterable, groupBy, groupByEach, injectInto, makeString, makeString, makeString, notEmpty, 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.collection.MutableCollection
addAllIterable, aggregateBy, aggregateInPlaceBy, removeAllIterable, retainAllIterable

Methods inherited from interface com.gs.collections.api.RichIterable
appendString, appendString, asLazy, chunk, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAllArguments, containsAllIterable, groupBy, groupByEach, injectInto, makeString, makeString, makeString, notEmpty, toBag, toMap, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

- Constructor Detail
  - CompositeFastList
```
public CompositeFastList()
```
- Method Detail
  - clone
```
public com.gs.collections.api.list.MutableList<E> clone()
```
    Specified by:
    
    clone in interface com.gs.collections.api.list.MutableList<E>
    
    Overrides:
    
    clone in class AbstractMutableList<E>
  - size
```
public int size()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the number of items in this iterable.
    
    Specified by:
    
    size in interface com.gs.collections.api.RichIterable<E>
    
    Specified by:
    
    size in interface java.util.Collection<E>
    
    Specified by:
    
    size in interface java.util.List<E>
  - reverseThis
```
public CompositeFastList<E> reverseThis()
```
    Description copied from interface: com.gs.collections.api.list.MutableList
    
    Mutates the current list by reversing its order and returns the current list as a result
    
    Specified by:
    
    reverseThis in interface com.gs.collections.api.list.MutableList<E>
    
    Overrides:
    
    reverseThis in class AbstractMutableList<E>
  - forEach
```
public void forEach(com.gs.collections.api.block.procedure.Procedure<? super E> procedure)
```
    Description copied from interface: com.gs.collections.api.InternalIterable
    The procedure is executed for each element in the iterable.
```
e.g.
 people.forEach(new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 
```
    Specified by:
    
    forEach in interface com.gs.collections.api.InternalIterable<E>
    
    Overrides:
    
    forEach in class AbstractMutableList<E>
  - forEachWithIndex
```
public void forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super E> objectIntProcedure)
```
    Description copied from interface: com.gs.collections.api.InternalIterable
    Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
```
e.g.
 people.forEachWithIndex(new ObjectIntProcedure()
 {
     public void value(Person person, int index)
     {
         LOGGER.info("Index: " + index + " person: " + person.getName());
     }
 });
 
```
    Specified by:
    
    forEachWithIndex in interface com.gs.collections.api.InternalIterable<E>
    
    Overrides:
    
    forEachWithIndex in class AbstractMutableList<E>
  - reverseForEach
```
public void reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super E> procedure)
```
    Description copied from interface: com.gs.collections.api.ordered.ReversibleIterable
    Evaluates the procedure for each element of the list iterating in reverse order.
```
e.g.
 people.reverseForEach(new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 
```
    Specified by:
    
    reverseForEach in interface com.gs.collections.api.ordered.ReversibleIterable<E>
    
    Overrides:
    
    reverseForEach in class AbstractMutableList<E>
  - forEach
```
public void forEach(int fromIndex,
           int toIndex,
           com.gs.collections.api.block.procedure.Procedure<? super E> procedure)
```
    Description copied from interface: com.gs.collections.api.list.ListIterable
    Iterates over the section of the list covered by the specified inclusive indexes. The indexes are both inclusive.
```
e.g.
 ListIterable people = FastList.newListWith(ted, mary, bob, sally)
 people.forEach(0, 1, new Procedure()
 {
     public void value(Person person)
     {
          LOGGER.info(person.getName());
     }
 });
 
```
    This code would output ted and mary's names.
    Specified by:
    
    forEach in interface com.gs.collections.api.list.ListIterable<E>
    
    Overrides:
    
    forEach in class AbstractMutableList<E>
  - forEachWithIndex
```
public void forEachWithIndex(int fromIndex,
                    int toIndex,
                    com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super E> objectIntProcedure)
```
    Description copied from interface: com.gs.collections.api.list.ListIterable
    Iterates over the section of the list covered by the specified inclusive indexes. The indexes are both inclusive.
```
e.g.
 ListIterable people = FastList.newListWith(ted, mary, bob, sally)
 people.forEachWithIndex(0, 1, new ObjectIntProcedure()
 {
     public void value(Person person, int index)
     {
          LOGGER.info(person.getName());
     }
 });
 
```
    This code would output ted and mary's names.
    Specified by:
    
    forEachWithIndex in interface com.gs.collections.api.list.ListIterable<E>
    
    Overrides:
    
    forEachWithIndex in class AbstractMutableList<E>
  - forEachWith
```
public <P> void forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super E,? super P> procedure2,
                   P parameter)
```
    Description copied from interface: com.gs.collections.api.InternalIterable
    The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
```
e.g.
 people.forEachWith(new Procedure2()
 {
     public void value(Person person, Person other)
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }
 }, fred);
 
```
    Specified by:
    
    forEachWith in interface com.gs.collections.api.InternalIterable<E>
    
    Overrides:
    
    forEachWith in class AbstractMutableList<E>
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns true if this iterable has zero items.
    
    Specified by:
    
    isEmpty in interface com.gs.collections.api.RichIterable<E>
    
    Specified by:
    
    isEmpty in interface java.util.Collection<E>
    
    Specified by:
    
    isEmpty in interface java.util.List<E>
    
    Overrides:
    
    isEmpty in class AbstractRichIterable<E>
  - contains
```
public boolean contains(java.lang.Object object)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns true if the iterable has an element which responds true to element.equals(object).
    
    Specified by:
    
    contains in interface com.gs.collections.api.RichIterable<E>
    
    Specified by:
    
    contains in interface java.util.Collection<E>
    
    Specified by:
    
    contains in interface java.util.List<E>
    
    Overrides:
    
    contains in class AbstractMutableList<E>
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Specified by:
    
    iterator in interface java.util.Collection<E>
    
    Specified by:
    
    iterator in interface java.util.List<E>
    
    Overrides:
    
    iterator in class AbstractMutableList<E>
  - toArray
```
public java.lang.Object[] toArray()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts this iterable to an array.
    
    Specified by:
    
    toArray in interface com.gs.collections.api.RichIterable<E>
    
    Specified by:
    
    toArray in interface java.util.Collection<E>
    
    Specified by:
    
    toArray in interface java.util.List<E>
    
    Overrides:
    
    toArray in class AbstractRichIterable<E>
    
    See Also:
    Collection.toArray()
  - add
```
public boolean add(E object)
```
    Specified by:
    
    add in interface java.util.Collection<E>
    
    Specified by:
    
    add in interface java.util.List<E>
    
    Overrides:
    
    add in class AbstractMutableCollection<E>
  - remove
```
public boolean remove(java.lang.Object object)
```
    Specified by:
    
    remove in interface java.util.Collection<E>
    
    Specified by:
    
    remove in interface java.util.List<E>
    
    Overrides:
    
    remove in class AbstractMutableCollection<E>
  - addAll
```
public boolean addAll(java.util.Collection<? extends E> collection)
```
    Specified by:
    
    addAll in interface java.util.Collection<E>
    
    Specified by:
    
    addAll in interface java.util.List<E>
    
    Overrides:
    
    addAll in class AbstractMutableCollection<E>
  - containsAll
```
public boolean containsAll(java.util.Collection<?> collection)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns true if all elements in source are contained in this collection.
    
    Specified by:
    
    containsAll in interface com.gs.collections.api.RichIterable<E>
    
    Specified by:
    
    containsAll in interface java.util.Collection<E>
    
    Specified by:
    
    containsAll in interface java.util.List<E>
    
    Overrides:
    
    containsAll in class AbstractMutableList<E>
    
    See Also:
    Collection.containsAll(Collection)
  - toArray
```
public java.lang.Object[] toArray(java.lang.Object[] array)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
    
    Specified by:
    
    toArray in interface com.gs.collections.api.RichIterable<E>
    
    Specified by:
    
    toArray in interface java.util.Collection<E>
    
    Specified by:
    
    toArray in interface java.util.List<E>
    
    Overrides:
    
    toArray in class AbstractRichIterable<E>
    
    See Also:
    Collection.toArray(Object[])
  - addComposited
```
public void addComposited(java.util.Collection<? extends E> collection)
```
  - addAll
```
public boolean addAll(int index,
             java.util.Collection<? extends E> collection)
```
    Specified by:
    
    addAll in interface java.util.List<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<E>
    
    Specified by:
    
    clear in interface java.util.List<E>
  - retainAll
```
public boolean retainAll(java.util.Collection<?> collection)
```
    Specified by:
    
    retainAll in interface java.util.Collection<E>
    
    Specified by:
    
    retainAll in interface java.util.List<E>
    
    Overrides:
    
    retainAll in class AbstractMutableList<E>
  - removeAll
```
public boolean removeAll(java.util.Collection<?> collection)
```
    Specified by:
    
    removeAll in interface java.util.Collection<E>
    
    Specified by:
    
    removeAll in interface java.util.List<E>
    
    Overrides:
    
    removeAll in class AbstractMutableList<E>
  - get
```
public E get(int index)
```
    Description copied from interface: com.gs.collections.api.list.ListIterable
    
    Returns the item at the specified position in this list iterable.
    
    Specified by:
    
    get in interface com.gs.collections.api.list.ListIterable<E>
    
    Specified by:
    
    get in interface java.util.List<E>
  - set
```
public E set(int index,
    E element)
```
    Specified by:
    
    set in interface java.util.List<E>
  - add
```
public void add(int index,
       E element)
```
    Specified by:
    
    add in interface java.util.List<E>
  - remove
```
public E remove(int index)
```
    Specified by:
    
    remove in interface java.util.List<E>
  - indexOf
```
public int indexOf(java.lang.Object o)
```
    Description copied from interface: com.gs.collections.api.ordered.ReversibleIterable
    
    Returns the index of the first occurrence of the specified item in this list, or -1 if this list does not contain the item.
    
    Specified by:
    
    indexOf in interface com.gs.collections.api.ordered.ReversibleIterable<E>
    
    Specified by:
    
    indexOf in interface java.util.List<E>
    
    Overrides:
    
    indexOf in class AbstractMutableList<E>
  - lastIndexOf
```
public int lastIndexOf(java.lang.Object o)
```
    Description copied from interface: com.gs.collections.api.list.ListIterable
    
    Returns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.
    
    Specified by:
    
    lastIndexOf in interface com.gs.collections.api.list.ListIterable<E>
    
    Specified by:
    
    lastIndexOf in interface java.util.List<E>
    
    Overrides:
    
    lastIndexOf in class AbstractMutableList<E>
  - listIterator
```
public java.util.ListIterator<E> listIterator()
```
    a list iterator is a problem for a composite list as going back in the order of the list is an issue, as are the other methods like set() and add() (and especially, remove). Convert the internal lists to one list (if not already just one list) and return that list's list iterator.
    AFAIK list iterator is only commonly used in sorting.
    
    Specified by:
    
    listIterator in interface com.gs.collections.api.list.ListIterable<E>
    
    Specified by:
    
    listIterator in interface java.util.List<E>
    
    Overrides:
    
    listIterator in class AbstractMutableList<E>
    
    Returns:
    a ListIterator for this, with internal state convertedto one list if needed.
    See Also:
    List.listIterator()
  - listIterator
```
public java.util.ListIterator<E> listIterator(int index)
```
    a llst iterator is a problem for a composite list as going back in the order of the list is an issue, as are the other methods like set() and add() (and especially, remove). Convert the internal lists to one list (if not already just one list) and return that list's list iterator.
    AFAIK list iterator is only commonly used in sorting.
    
    Specified by:
    
    listIterator in interface com.gs.collections.api.list.ListIterable<E>
    
    Specified by:
    
    listIterator in interface java.util.List<E>
    
    Overrides:
    
    listIterator in class AbstractMutableList<E>
    
    Returns:
    a ListIterator for this, with internal state convertedto one list if needed.
    See Also:
    List.listIterator(int)
  - defaultSort
```
protected void defaultSort(java.util.Comparator<? super E> comparator)
```
    Override in subclasses where it can be optimized.
    
    Overrides:
    
    defaultSort in class AbstractMutableList<E>
  - equals
```
public boolean equals(java.lang.Object other)
```
    Description copied from interface: com.gs.collections.api.list.ListIterable
    
    Follows the same general contract as List.equals(Object).
    
    Specified by:
    
    equals in interface com.gs.collections.api.list.ListIterable<E>
    
    Specified by:
    
    equals in interface java.util.Collection<E>
    
    Specified by:
    
    equals in interface java.util.List<E>
    
    Overrides:
    
    equals in class AbstractMutableList<E>
  - hashCode
```
public int hashCode()
```
    Description copied from interface: com.gs.collections.api.list.ListIterable
    
    Follows the same general contract as List.hashCode().
    
    Specified by:
    
    hashCode in interface com.gs.collections.api.list.ListIterable<E>
    
    Specified by:
    
    hashCode in interface java.util.Collection<E>
    
    Specified by:
    
    hashCode in interface java.util.List<E>
    
    Overrides:
    
    hashCode in class AbstractMutableList<E>

Class CompositeFastList<E>

Nested Class Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class com.gs.collections.impl.AbstractRichIterable

Methods inherited from class java.lang.Object

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

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

Constructor Detail

CompositeFastList

Method Detail

clone

size

reverseThis

forEach

forEachWithIndex

reverseForEach

forEach

forEachWithIndex

forEachWith

isEmpty

contains

iterator

toArray

add

remove

addAll

containsAll

toArray

addComposited

addAll

clear

retainAll

removeAll

get

set

add

remove

indexOf

lastIndexOf

listIterator

listIterator

defaultSort

equals

hashCode