Package one.microstream.collections

Class ArrayCollector<E>

java.lang.Object

one.microstream.collections.AbstractExtendedCollection<E>

one.microstream.collections.AbstractArrayCollection<E>

one.microstream.collections.AbstractSectionedArrayCollection<E>

one.microstream.collections.AbstractSimpleArrayCollection<E>

one.microstream.collections.ArrayCollector<E>

All Implemented Interfaces:

Iterable<E>, Consumer<E>, CapacityCarrying, CapacityExtendable, ConsolidatableCollection, ExtendedBag<E>, ExtendedCollection<E>, ExtendedList<E>, ExtendedSequence<E>, OptimizableCollection, ReleasingCollection<E>, Sized, Truncateable, Sortable<E>, SortableProcedure<E>, XAddGetCollection<E>, XAddingBag<E>, XAddingCollection<E>, XAddingList<E>, XAddingSequence<E>, XBag<E>, XBasicList<E>, XBasicSequence<E>, XCollection<E>, XDecreasingList<E>, XDecreasingSequence<E>, XExpandingList<E>, XExpandingSequence<E>, XExtendingList<E>, XExtendingSequence<E>, XGettingBag<E>, XGettingCollection<E>, XGettingList<E>, XGettingSequence<E>, XIncreasingList<E>, XIncreasingSequence<E>, XIndexIterable<E>, XInputtingList<E>, XInputtingSequence<E>, XInsertingSequence<E>, XIterable<E>, XJoinable<E>, XList<E>, XOrderingSequence<E>, XPrependingList<E>, XPrependingSequence<E>, XPreputtingList<E>, XPreputtingSequence<E>, XProcessingBag<E>, XProcessingCollection<E>, XProcessingList<E>, XProcessingSequence<E>, XPutGetBag<E>, XPutGetCollection<E>, XPutGetList<E>, XPutGetSequence<E>, XPuttingBag<E>, XPuttingCollection<E>, XPuttingList<E>, XPuttingSequence<E>, XRemovingBag<E>, XRemovingCollection<E>, XRemovingList<E>, XRemovingSequence<E>, XReplacingBag<E>, XReplacingCollection<E>, XSequence<E>, XSettingList<E>, XSettingSequence<E>, XSortableSequence<E>, Processable<E>, Clearable, Copyable

public final class ArrayCollector<E>
extends AbstractSimpleArrayCollection<E>
implements XList<E>

Full scale general purpose implementation of extended collection type XList.

This array-backed implementation is optimal for all needs of a list that do not require frequent structural modification (insert or remove) of single elements before the end of the list.
It is recommended to use this implementation as default list type until concrete performance deficiencies are identified. If used properly (e.g. always ensure enough capacity, make use of batch procedures like inputAll(long,Object...), removeRange(long,long), etc.), this implementation has equal or massively superior performance to linked-list implementation is most cases.

This implementation is NOT synchronized and thus should only be used by a single thread or in a thread-safe manner (i.e. read-only as soon as multiple threads access it).
See SynchList wrapper class to use a list in a synchronized manner.

Note that this List implementation does NOT keep track of modification count as JDK's collection implementations do (and thus never throws a ConcurrentModificationException), for two reasons:
1.) It is already explicitly declared thread-unsafe and for single-thread (or thread-safe) use only.
2.) The common modCount-concurrency exception behavior ("failfast") has buggy and inconsistent behavior by throwing ConcurrentModificationException even in single thread use, i.e. when iterating over a collection and removing more than one element of it without using the iterator's method.

Current conclusion is that the JDK's failfast implementations buy unneeded (and even unreliable as stated by official guides) concurrency modification recognition at the cost of performance loss and even a bug when already used in a thread-safe manner.

Also note that by being an extended collection, this implementation offers various functional and batch procedures to maximize internal iteration potential, eliminating the need to use the ill-conceived external iteration Iterator paradigm.

Version:

0.9, 2011-02-06

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArrayCollector.OldArrayCollector<E>

Nested classes/interfaces inherited from interface one.microstream.typing.Copyable

Copyable.Static

Nested classes/interfaces inherited from interface one.microstream.collections.interfaces.ExtendedCollection

ExtendedCollection.Creator<E,C extends ExtendedCollection<E>>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XBag

XBag.Factory<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XBasicSequence

XBasicSequence.Factory<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingList

XGettingList.Factory<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingSequence

XGettingSequence.Factory<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XInputtingList

XInputtingList.Factory<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable

XIterable.Executor<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XList

XList.Creator<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XProcessingList

XProcessingList.Factory<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XProcessingSequence

XProcessingSequence.Factory<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XPutGetList

XPutGetList.Factory<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XReplacingBag

XReplacingBag.Factory<E>

Constructor Summary

Constructors

Constructor	Description
ArrayCollector()
ArrayCollector(E... elements)
ArrayCollector(E[] elements, int size)
ArrayCollector(ArrayCollector<? extends E> original)

Method Summary

Modifier and Type	Method	Description
void	accept(E element)
boolean	add(E element)
ArrayCollector<E>	addAll(E... elements)
ArrayCollector<E>	addAll(E[] elements, int offset, int length)
ArrayCollector<E>	addAll(XGettingCollection<? extends E> elements)
boolean	applies(Predicate<? super E> predicate)
E	at(long index)
void	clear()	Clears all elements from the collection while leaving the capacity as it is.
long	consolidate()	Consolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore.
boolean	contains(E element)
boolean	containsAll(XGettingCollection<? extends E> elements)
boolean	containsId(E element)	Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic. This method has the same behavior as XGettingCollection.containsSearched(Predicate) with a Predicate implementation that checks for object identity.
boolean	containsSearched(Predicate<? super E> predicate)
ArrayCollector<E>	copy()	Creates a true copy of this collection which references the same elements as this collection does at the time the method is called.
<C extends Consumer<? super E>> C	copySelection(C target, long... indices)
<C extends Consumer<? super E>> C	copyTo(C target)
long	count(E element)
long	countBy(Predicate<? super E> predicate)
long	currentCapacity()	Returns the current amount of elements this instance can hold before a storage rebuild becomes necessary.
<C extends Consumer<? super E>> C	distinct(C target)
<C extends Consumer<? super E>> C	distinct(C target, Equalator<? super E> equalator)
ArrayCollector<E>	ensureCapacity(long minCapacity)
ArrayCollector<E>	ensureFreeCapacity(long requiredFreeCapacity)	Ensures that the next minimalFreeCapacity elements can be actually added in a fast way, meaning for example no internal storage rebuild will be necessary.
Equalator<? super E>	equality()
boolean	equals(Object o)	Deprecated.
boolean	equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)	Returns true if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator) yields true.
boolean	equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)	Returns true if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.
<C extends Consumer<? super E>> C	except(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
E	fetch()
ArrayCollector<E>	fill(long offset, long length, E element)
<C extends Consumer<? super E>> C	filterTo(C target, Predicate<? super E> predicate)
E	first()
E	get()	Gets one element from the collection.
E[]	getArray()
int	hashCode()	Deprecated.
boolean	hasVolatileElements()	Tells if this collection contains volatile elements. An element is volatile, if it can become no longer reachable by the collection without being removed from the collection.
XImmutableList<E>	immure()	Provides an instance of an immutable collection type with equal behavior and data as this instance.
long	indexBy(Predicate<? super E> predicate)
long	indexOf(E element)
boolean	input(long index, E element)
long	inputAll(long index, E... elements)
long	inputAll(long index, E[] elements, int offset, int length)
long	inputAll(long index, XGettingCollection<? extends E> elements)
boolean	insert(long index, E element)
long	insertAll(long index, E... elements)
long	insertAll(long index, E[] elements, int offset, int length)
long	insertAll(long index, XGettingCollection<? extends E> elements)
<C extends Consumer<? super E>> C	intersect(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
boolean	isEmpty()
boolean	isFull()	Returns true if the current capacity cannot be increased any more.
boolean	isSorted(Comparator<? super E> comparator)
<P extends Consumer<? super E>> P	iterate(P procedure)
<P extends IndexedAcceptor<? super E>> P	iterateIndexed(P procedure)
Iterator<E>	iterator()
<A> A	join(BiConsumer<? super E,? super A> joiner, A aggregate)
E	last()
long	lastIndexBy(Predicate<? super E> predicate)
long	lastIndexOf(E element)
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(long index)
E	max(Comparator<? super E> comparator)
long	maximumCapacity()	Returns the maximum amount of elements this carrier instance can contain. The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g.
long	maxIndex(Comparator<? super E> comparator)
E	min(Comparator<? super E> comparator)
long	minIndex(Comparator<? super E> comparator)
<C extends Consumer<? super E>> C	moveSelection(C target, long... indices)
<C extends Consumer<? super E>> C	moveTo(C target, Predicate<? super E> predicate)
boolean	nullAdd()
boolean	nullAllowed()
boolean	nullContained()
boolean	nullInput(long index)
boolean	nullInsert(long index)
boolean	nullPrepend()
boolean	nullPreput()
boolean	nullPut()
long	nullRemove()
ArrayCollector.OldArrayCollector<E>	old()
long	optimize()	Optimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.
E	peek()
E	pick()
E	pinch()
E	poll()
E	pop()
boolean	prepend(E element)
ArrayCollector<E>	prependAll(E... elements)
ArrayCollector<E>	prependAll(E[] elements, int srcStartIndex, int srcLength)
ArrayCollector<E>	prependAll(XGettingCollection<? extends E> elements)
boolean	preput(E element)
ArrayCollector<E>	preputAll(E... elements)
ArrayCollector<E>	preputAll(E[] elements, int offset, int length)
ArrayCollector<E>	preputAll(XGettingCollection<? extends E> elements)
<P extends Consumer<? super E>> P	process(P procedure)
boolean	put(E element)
ArrayCollector<E>	putAll(E... elements)
ArrayCollector<E>	putAll(E[] elements, int offset, int length)
ArrayCollector<E>	putAll(XGettingCollection<? extends E> elements)
SubList<E>	range(long fromIndex, long toIndex)
long	remainingCapacity()	Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.
long	remove(E element)
long	removeAll(XGettingCollection<? extends E> elements)
E	removeAt(long index)
long	removeBy(Predicate<? super E> predicate)
long	removeDuplicates()
long	removeDuplicates(Equalator<? super E> equalator)
boolean	removeOne(E element)
ArrayCollector<E>	removeRange(long startIndex, long length)
long	removeSelection(long[] indices)
long	replace(E element, E replacement)
long	replace(Predicate<? super E> predicate, E substitute)
long	replaceAll(XGettingCollection<? extends E> elements, E replacement)
boolean	replaceOne(E element, E replacement)
boolean	replaceOne(Predicate<? super E> predicate, E substitute)
long	retainAll(XGettingCollection<? extends E> elements)
ArrayCollector<E>	retainRange(long startIndex, long length)
E	retrieve(E element)
E	retrieveBy(Predicate<? super E> predicate)
ArrayCollector<E>	reverse()
<T> T[]	rngCopyTo(int startIndex, int length, T[] target, int offset)
long	scan(Predicate<? super E> predicate)	Iterates through the collection and returns the index of the last element that the passed Predicateapplied to ("scanning").
E	search(Predicate<? super E> predicate)
E	seek(E sample)	Returns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained.
boolean	set(long index, E element)
ArrayCollector<E>	set(long offset, E[] src, int srcIndex, int srcLength)
ArrayCollector<E>	set(long offset, XGettingSequence<? extends E> elements, long elementsOffset, long elementsLength)
ArrayCollector<E>	setAll(long offset, E... elements)
ArrayCollector<E>	setArray(E[] array, int size)
void	setFirst(E element)
E	setGet(long index, E element)
void	setLast(E element)
ArrayCollector<E>	shiftBy(long sourceIndex, long distance)
ArrayCollector<E>	shiftBy(long sourceIndex, long distance, long length)
ArrayCollector<E>	shiftTo(long sourceIndex, long targetIndex)
ArrayCollector<E>	shiftTo(long sourceIndex, long targetIndex, long length)
long	size()
ArrayCollector<E>	sort(Comparator<? super E> comparator)
long	substitute(Function<? super E,? extends E> mapper)
long	substitute(Predicate<? super E> predicate, Function<E,E> mapper)
ArrayCollector<E>	swap(long indexA, long indexB)
ArrayCollector<E>	swap(long indexA, long indexB, long length)
Object[]	toArray()
E[]	toArray(Class<E> type)
ArrayCollector<E>	toReversed()
String	toString()
void	truncate()	Clears (and reinitializes if needed) this collection in the fastest possible way, i.e.
<C extends Consumer<? super E>> C	union(XGettingCollection<? extends E> samples, Equalator<? super E> equalator, C target)
ListView<E>	view()
SubListView<E>	view(long fromIndex, long toIndex)

Methods inherited from class one.microstream.collections.AbstractArrayCollection

pow2BoundMaxed

Methods inherited from class one.microstream.collections.AbstractExtendedCollection

ensureFreeArrayCapacity, validateIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface one.microstream.collections.interfaces.CapacityExtendable

currentFreeCapacity

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface one.microstream.collections.types.XGettingCollection

intSize

Methods inherited from interface one.microstream.collections.types.XGettingSequence

hasIndex

Methods inherited from interface one.microstream.collections.types.XList

collector

Constructor Detail

ArrayCollector

public ArrayCollector()

ArrayCollector

public ArrayCollector(ArrayCollector<? extends E> original)
               throws NullPointerException

Throws:

NullPointerException

ArrayCollector

@SafeVarargs
public ArrayCollector(E... elements)
               throws NullPointerException

Throws:

NullPointerException

ArrayCollector

public ArrayCollector(E[] elements,
                      int size)

Method Detail

getArray

public E[] getArray()

equality

public Equalator<? super E> equality()

Specified by:

equality in interface XGettingCollection<E>

setArray

public ArrayCollector<E> setArray(E[] array,
                                  int size)

copy

public ArrayCollector<E> copy()

Description copied from interface: XGettingCollection

Creates a true copy of this collection which references the same elements as this collection does at the time the method is called. The elements themselves are NOT copied (no deep copying).
The type of the returned set is the same as of this list if possible.

Specified by:

copy in interface Copyable

Specified by:

copy in interface XAddGetCollection<E>

Specified by:

copy in interface XBag<E>

Specified by:

copy in interface XBasicList<E>

Specified by:

copy in interface XBasicSequence<E>

Specified by:

copy in interface XCollection<E>

Specified by:

copy in interface XDecreasingList<E>

Specified by:

copy in interface XDecreasingSequence<E>

Specified by:

copy in interface XGettingBag<E>

Specified by:

copy in interface XGettingCollection<E>

Specified by:

copy in interface XGettingList<E>

Specified by:

copy in interface XGettingSequence<E>

Specified by:

copy in interface XIncreasingList<E>

Specified by:

copy in interface XIncreasingSequence<E>

Specified by:

copy in interface XList<E>

Specified by:

copy in interface XProcessingBag<E>

Specified by:

copy in interface XProcessingList<E>

Specified by:

copy in interface XPutGetCollection<E>

Specified by:

copy in interface XPutGetList<E>

Specified by:

copy in interface XPutGetSequence<E>

Specified by:

copy in interface XReplacingBag<E>

Specified by:

copy in interface XSequence<E>

Specified by:

copy in interface XSettingList<E>

Specified by:

copy in interface XSettingSequence<E>

Specified by:

copy in interface XSortableSequence<E>

Returns:

a copy of this list

immure

public XImmutableList<E> immure()

Description copied from interface: XGettingCollection

Provides an instance of an immutable collection type with equal behavior and data as this instance.

If this instance already is of an immutable collection type, it returns itself.

Specified by:

immure in interface XGettingBag<E>

Specified by:

immure in interface XGettingCollection<E>

Specified by:

immure in interface XGettingList<E>

Specified by:

immure in interface XGettingSequence<E>

Specified by:

immure in interface XProcessingBag<E>

Returns:

an immutable copy of this collection instance.

toReversed

public ArrayCollector<E> toReversed()

Specified by:

toReversed in interface XBasicList<E>

Specified by:

toReversed in interface XBasicSequence<E>

Specified by:

toReversed in interface XDecreasingList<E>

Specified by:

toReversed in interface XDecreasingSequence<E>

Specified by:

toReversed in interface XGettingList<E>

Specified by:

toReversed in interface XGettingSequence<E>

Specified by:

toReversed in interface XIncreasingList<E>

Specified by:

toReversed in interface XIncreasingSequence<E>

Specified by:

toReversed in interface XList<E>

Specified by:

toReversed in interface XProcessingList<E>

Specified by:

toReversed in interface XProcessingSequence<E>

Specified by:

toReversed in interface XPutGetList<E>

Specified by:

toReversed in interface XPutGetSequence<E>

Specified by:

toReversed in interface XSequence<E>

Specified by:

toReversed in interface XSettingList<E>

Specified by:

toReversed in interface XSettingSequence<E>

Specified by:

toReversed in interface XSortableSequence<E>

toArray

public E[] toArray(Class<E> type)

Specified by:

toArray in interface XGettingCollection<E>

iterate

public <P extends Consumer<? super E>> P iterate(P procedure)

Specified by:

iterate in interface XIterable<E>

Specified by:

iterate in interface XList<E>

Specified by:

iterate in interface XProcessingCollection<E>

join

public final <A> A join(BiConsumer<? super E,? super A> joiner,
                        A aggregate)

Specified by:

join in interface XGettingCollection<E>

Specified by:

join in interface XJoinable<E>

iterateIndexed

public final <P extends IndexedAcceptor<? super E>> P iterateIndexed(P procedure)

Specified by:

iterateIndexed in interface XIndexIterable<E>

count

public long count(E element)

Specified by:

count in interface XGettingCollection<E>

countBy

public long countBy(Predicate<? super E> predicate)

Specified by:

countBy in interface XGettingCollection<E>

indexOf

public long indexOf(E element)

Specified by:

indexOf in interface XGettingSequence<E>

indexBy

public long indexBy(Predicate<? super E> predicate)

Specified by:

indexBy in interface XGettingSequence<E>

lastIndexOf

public long lastIndexOf(E element)

Specified by:

lastIndexOf in interface XGettingSequence<E>

lastIndexBy

public long lastIndexBy(Predicate<? super E> predicate)

Specified by:

lastIndexBy in interface XGettingSequence<E>

maxIndex

public long maxIndex(Comparator<? super E> comparator)

Specified by:

maxIndex in interface XGettingSequence<E>

minIndex

public long minIndex(Comparator<? super E> comparator)

Specified by:

minIndex in interface XGettingSequence<E>

scan

public long scan(Predicate<? super E> predicate)

Description copied from interface: XGettingSequence

Iterates through the collection and returns the index of the last element that the passed Predicateapplied to ("scanning").

Specified by:

scan in interface XGettingSequence<E>

Returns:

the index of the last positively tested element.

get

public E get()

Description copied from interface: XGettingCollection

Gets one element from the collection. If the collection is not ordered XGettingSequence, then it is undefined which element is returned. If the collection is ordered, the element at index 0 is returned.

Specified by:

get in interface XGettingCollection<E>

Specified by:

get in interface XGettingSequence<E>

Returns:

the first / any element.

See Also:

XGettingSequence.at(long), XGettingSequence.first(), XGettingSequence.last()

first

public E first()

Specified by:

first in interface XGettingSequence<E>

last

public E last()

Specified by:

last in interface XGettingSequence<E>

poll

public E poll()

Specified by:

poll in interface XGettingSequence<E>

peek

public E peek()

Specified by:

peek in interface XGettingSequence<E>

seek

public E seek(E sample)

Description copied from interface: XGettingCollection

Returns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained. (For collections using referential equality, this method is basically just a variation of XGettingCollection.contains(Object) with a different return type. For collections with data-dependant equality, the returned element might be the same as the passed one or a data-wise equal one, depending on the content of the collection)

Specified by:

seek in interface XGettingCollection<E>

search

public E search(Predicate<? super E> predicate)

Specified by:

search in interface XGettingCollection<E>

max

public E max(Comparator<? super E> comparator)

Specified by:

max in interface XGettingCollection<E>

min

public E min(Comparator<? super E> comparator)

Specified by:

min in interface XGettingCollection<E>

hasVolatileElements

public boolean hasVolatileElements()

Description copied from interface: XGettingCollection

Tells if this collection contains volatile elements.
An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. Examples are WeakReference of SoftReference or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
Note that WeakReference instances that are added to a a simple (non-volatile) implementation of a collection do NOT make the collection volatile, as the elements themselves (the reference instances) are still strongly referenced.

Specified by:

hasVolatileElements in interface ExtendedCollection<E>

Specified by:

hasVolatileElements in interface XGettingCollection<E>

Returns:

true if the collection contains volatile elements.

nullAllowed

public boolean nullAllowed()

Specified by:

nullAllowed in interface ExtendedCollection<E>

isSorted

public boolean isSorted(Comparator<? super E> comparator)

Specified by:

isSorted in interface XGettingSequence<E>

containsSearched

public boolean containsSearched(Predicate<? super E> predicate)

Specified by:

containsSearched in interface XGettingCollection<E>

applies

public boolean applies(Predicate<? super E> predicate)

Specified by:

applies in interface XGettingCollection<E>

nullContained

public boolean nullContained()

Specified by:

nullContained in interface XGettingCollection<E>

containsId

public boolean containsId(E element)

Description copied from interface: XGettingCollection

Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic.
This method has the same behavior as XGettingCollection.containsSearched(Predicate) with a Predicate implementation that checks for object identity. The only difference is a performance and usability advantage

Specified by:

containsId in interface XGettingCollection<E>

Parameters:

element - the element to be searched in the collection by identity.

Returns:

whether this collection contains exactely the given element.

contains

public boolean contains(E element)

Specified by:

contains in interface XGettingCollection<E>

containsAll

public boolean containsAll(XGettingCollection<? extends E> elements)

Specified by:

containsAll in interface XGettingCollection<E>

equals

public boolean equals(XGettingCollection<? extends E> samples,
                      Equalator<? super E> equalator)

Description copied from interface: XGettingCollection

Returns true if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator) yields true.

Specified by:

equals in interface XGettingCollection<E>

equalsContent

public boolean equalsContent(XGettingCollection<? extends E> samples,
                             Equalator<? super E> equalator)

Description copied from interface: XGettingCollection

Returns true if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.

Note that for colletion types that don't have a defined order of elements, this method is hardly usable (as is XGettingCollection.equals(Object) for them as defined in Collection). The core problem of comparing collections that have no defined order is that they aren't really reliably comparable to any other collection.

Specified by:

equalsContent in interface XGettingCollection<E>

equalator - the equalator to use to determine the equality of each element

Returns:

true if this list is equal to the passed list, false otherwise

intersect

public <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> samples,
                                                   Equalator<? super E> equalator,
                                                   C target)

Specified by:

intersect in interface XGettingCollection<E>

except

public <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> samples,
                                                Equalator<? super E> equalator,
                                                C target)

Specified by:

except in interface XGettingCollection<E>

union

public <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> samples,
                                               Equalator<? super E> equalator,
                                               C target)

Specified by:

union in interface XGettingCollection<E>

copyTo

public <C extends Consumer<? super E>> C copyTo(C target)

Specified by:

copyTo in interface XGettingCollection<E>

filterTo

public <C extends Consumer<? super E>> C filterTo(C target,
                                                  Predicate<? super E> predicate)

Specified by:

filterTo in interface XGettingCollection<E>

rngCopyTo

public <T> T[] rngCopyTo(int startIndex,
                         int length,
                         T[] target,
                         int offset)

distinct

public <C extends Consumer<? super E>> C distinct(C target)

Specified by:

distinct in interface XGettingCollection<E>

distinct

public <C extends Consumer<? super E>> C distinct(C target,
                                                  Equalator<? super E> equalator)

Specified by:

distinct in interface XGettingCollection<E>

copySelection

public <C extends Consumer<? super E>> C copySelection(C target,
                                                       long... indices)

Specified by:

copySelection in interface XGettingSequence<E>

view

public ListView<E> view()

Specified by:

view in interface XGettingBag<E>

Specified by:

view in interface XGettingCollection<E>

Specified by:

view in interface XGettingList<E>

Specified by:

view in interface XGettingSequence<E>

Specified by:

view in interface XProcessingBag<E>

view

public SubListView<E> view(long fromIndex,
                           long toIndex)

Specified by:

view in interface XGettingList<E>

Specified by:

view in interface XGettingSequence<E>

Specified by:

view in interface XProcessingSequence<E>

shiftTo

public ArrayCollector<E> shiftTo(long sourceIndex,
                                 long targetIndex)

Specified by:

shiftTo in interface XList<E>

Specified by:

shiftTo in interface XOrderingSequence<E>

Specified by:

shiftTo in interface XSortableSequence<E>

shiftTo

public ArrayCollector<E> shiftTo(long sourceIndex,
                                 long targetIndex,
                                 long length)

Specified by:

shiftTo in interface XList<E>

Specified by:

shiftTo in interface XOrderingSequence<E>

Specified by:

shiftTo in interface XSortableSequence<E>

shiftBy

public ArrayCollector<E> shiftBy(long sourceIndex,
                                 long distance)

Specified by:

shiftBy in interface XList<E>

Specified by:

shiftBy in interface XOrderingSequence<E>

Specified by:

shiftBy in interface XSortableSequence<E>

shiftBy

public ArrayCollector<E> shiftBy(long sourceIndex,
                                 long distance,
                                 long length)

Specified by:

shiftBy in interface XList<E>

Specified by:

shiftBy in interface XOrderingSequence<E>

Specified by:

shiftBy in interface XSortableSequence<E>

swap

public ArrayCollector<E> swap(long indexA,
                              long indexB)
                       throws IndexOutOfBoundsException,
                              ArrayIndexOutOfBoundsException

Specified by:

swap in interface XDecreasingList<E>

Specified by:

swap in interface XDecreasingSequence<E>

Specified by:

swap in interface XIncreasingList<E>

Specified by:

swap in interface XIncreasingSequence<E>

Specified by:

swap in interface XList<E>

Specified by:

swap in interface XOrderingSequence<E>

Specified by:

swap in interface XSettingList<E>

Specified by:

swap in interface XSettingSequence<E>

Specified by:

swap in interface XSortableSequence<E>

Throws:

IndexOutOfBoundsException

ArrayIndexOutOfBoundsException

swap

public ArrayCollector<E> swap(long indexA,
                              long indexB,
                              long length)

Specified by:

swap in interface XDecreasingList<E>

Specified by:

swap in interface XDecreasingSequence<E>

Specified by:

swap in interface XIncreasingList<E>

Specified by:

swap in interface XIncreasingSequence<E>

Specified by:

swap in interface XList<E>

Specified by:

swap in interface XOrderingSequence<E>

Specified by:

swap in interface XSettingList<E>

Specified by:

swap in interface XSettingSequence<E>

Specified by:

swap in interface XSortableSequence<E>

reverse

public ArrayCollector<E> reverse()

Specified by:

reverse in interface XDecreasingList<E>

Specified by:

reverse in interface XDecreasingSequence<E>

Specified by:

reverse in interface XIncreasingList<E>

Specified by:

reverse in interface XIncreasingSequence<E>

Specified by:

reverse in interface XList<E>

Specified by:

reverse in interface XOrderingSequence<E>

Specified by:

reverse in interface XSettingList<E>

Specified by:

reverse in interface XSettingSequence<E>

Specified by:

reverse in interface XSortableSequence<E>

setFirst

public void setFirst(E element)

Specified by:

setFirst in interface XSettingSequence<E>

setLast

public void setLast(E element)

Specified by:

setLast in interface XSettingSequence<E>

setAll

@SafeVarargs
public final ArrayCollector<E> setAll(long offset,
                                      E... elements)

Specified by:

setAll in interface XDecreasingList<E>

Specified by:

setAll in interface XDecreasingSequence<E>

Specified by:

setAll in interface XIncreasingList<E>

Specified by:

setAll in interface XList<E>

Specified by:

setAll in interface XSettingList<E>

Specified by:

setAll in interface XSettingSequence<E>

set

public ArrayCollector<E> set(long offset,
                             E[] src,
                             int srcIndex,
                             int srcLength)

Specified by:

set in interface XDecreasingList<E>

Specified by:

set in interface XDecreasingSequence<E>

Specified by:

set in interface XIncreasingList<E>

Specified by:

set in interface XList<E>

Specified by:

set in interface XSettingList<E>

Specified by:

set in interface XSettingSequence<E>

set

public ArrayCollector<E> set(long offset,
                             XGettingSequence<? extends E> elements,
                             long elementsOffset,
                             long elementsLength)

Specified by:

set in interface XDecreasingList<E>

Specified by:

set in interface XDecreasingSequence<E>

Specified by:

set in interface XIncreasingList<E>

Specified by:

set in interface XList<E>

Specified by:

set in interface XSettingList<E>

Specified by:

set in interface XSettingSequence<E>

fill

public ArrayCollector<E> fill(long offset,
                              long length,
                              E element)

Specified by:

fill in interface XDecreasingList<E>

Specified by:

fill in interface XIncreasingList<E>

Specified by:

fill in interface XList<E>

Specified by:

fill in interface XSettingList<E>

sort

public ArrayCollector<E> sort(Comparator<? super E> comparator)

Specified by:

sort in interface Sortable<E>

Specified by:

sort in interface XDecreasingList<E>

Specified by:

sort in interface XDecreasingSequence<E>

Specified by:

sort in interface XIncreasingList<E>

Specified by:

sort in interface XIncreasingSequence<E>

Specified by:

sort in interface XList<E>

Specified by:

sort in interface XSequence<E>

Specified by:

sort in interface XSettingList<E>

Specified by:

sort in interface XSettingSequence<E>

Specified by:

sort in interface XSortableSequence<E>

replaceOne

public boolean replaceOne(E element,
                          E replacement)

Specified by:

replaceOne in interface XReplacingBag<E>

replaceOne

public boolean replaceOne(Predicate<? super E> predicate,
                          E substitute)

Specified by:

replaceOne in interface XReplacingBag<E>

replace

public long replace(E element,
                    E replacement)

Specified by:

replace in interface XReplacingBag<E>

replace

public long replace(Predicate<? super E> predicate,
                    E substitute)

Specified by:

replace in interface XReplacingBag<E>

replaceAll

public long replaceAll(XGettingCollection<? extends E> elements,
                       E replacement)

Specified by:

replaceAll in interface XReplacingBag<E>

substitute

public long substitute(Function<? super E,? extends E> mapper)

Specified by:

substitute in interface XReplacingCollection<E>

substitute

public long substitute(Predicate<? super E> predicate,
                       Function<E,E> mapper)

Specified by:

substitute in interface XReplacingBag<E>

currentCapacity

public long currentCapacity()

Description copied from interface: CapacityExtendable

Returns the current amount of elements this instance can hold before a storage rebuild becomes necessary.

For carrier implementations that don't have a concept of storage rebuilding (like linked list for example) this method returns the same value as CapacityCarrying.maximumCapacity().

Specified by:

currentCapacity in interface CapacityExtendable

Returns:

the current capacity of this instance before a rebuild is required.

maximumCapacity

public long maximumCapacity()

Description copied from interface: CapacityCarrying

Returns the maximum amount of elements this carrier instance can contain.
The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g. Integer.MAX_VALUE)

Specified by:

maximumCapacity in interface CapacityCarrying

Returns:

the maximum amount of elements this carrier instance can contain.

isFull

public boolean isFull()

Description copied from interface: CapacityCarrying

Returns true if the current capacity cannot be increased any more.

Specified by:

isFull in interface CapacityCarrying

remainingCapacity

public long remainingCapacity()

Description copied from interface: CapacityCarrying

Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.

Specified by:

remainingCapacity in interface CapacityCarrying

optimize

public long optimize()

Description copied from interface: OptimizableCollection

Optimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.

Specified by:

optimize in interface OptimizableCollection

Specified by:

optimize in interface XRemovingCollection<E>

Returns:

the storage size of the collection after the optimzation.

ensureFreeCapacity

public ArrayCollector<E> ensureFreeCapacity(long requiredFreeCapacity)

Description copied from interface: CapacityExtendable

Ensures that the next minimalFreeCapacity elements can be actually added in a fast way, meaning for example no internal storage rebuild will be necessary.

Specified by:

ensureFreeCapacity in interface CapacityExtendable

ensureCapacity

public ArrayCollector<E> ensureCapacity(long minCapacity)

Specified by:

ensureCapacity in interface CapacityExtendable

accept

public void accept(E element)

Specified by:

accept in interface Consumer<E>

Specified by:

accept in interface XAddingCollection<E>

add

public boolean add(E element)

Specified by:

add in interface XAddingCollection<E>

addAll

@SafeVarargs
public final ArrayCollector<E> addAll(E... elements)

Specified by:

addAll in interface XAddGetCollection<E>

Specified by:

addAll in interface XAddingBag<E>

Specified by:

addAll in interface XAddingCollection<E>

Specified by:

addAll in interface XAddingList<E>

Specified by:

addAll in interface XAddingSequence<E>

Specified by:

addAll in interface XBag<E>

Specified by:

addAll in interface XBasicList<E>

Specified by:

addAll in interface XBasicSequence<E>

Specified by:

addAll in interface XCollection<E>

Specified by:

addAll in interface XExpandingList<E>

Specified by:

addAll in interface XExpandingSequence<E>

Specified by:

addAll in interface XExtendingList<E>

Specified by:

addAll in interface XExtendingSequence<E>

Specified by:

addAll in interface XIncreasingList<E>

Specified by:

addAll in interface XIncreasingSequence<E>

Specified by:

addAll in interface XInputtingList<E>

Specified by:

addAll in interface XInputtingSequence<E>

Specified by:

addAll in interface XInsertingSequence<E>

Specified by:

addAll in interface XList<E>

Specified by:

addAll in interface XPutGetCollection<E>

Specified by:

addAll in interface XPutGetList<E>

Specified by:

addAll in interface XPutGetSequence<E>

Specified by:

addAll in interface XPuttingBag<E>

Specified by:

addAll in interface XPuttingList<E>

Specified by:

addAll in interface XSequence<E>

addAll

public ArrayCollector<E> addAll(E[] elements,
                                int offset,
                                int length)

Specified by:

addAll in interface XAddGetCollection<E>

Specified by:

addAll in interface XAddingBag<E>

Specified by:

addAll in interface XAddingCollection<E>

Specified by:

addAll in interface XAddingList<E>

Specified by:

addAll in interface XAddingSequence<E>

Specified by:

addAll in interface XBag<E>

Specified by:

addAll in interface XBasicList<E>

Specified by:

addAll in interface XBasicSequence<E>

Specified by:

addAll in interface XCollection<E>

Specified by:

addAll in interface XExpandingList<E>

Specified by:

addAll in interface XExpandingSequence<E>

Specified by:

addAll in interface XExtendingList<E>

Specified by:

addAll in interface XExtendingSequence<E>

Specified by:

addAll in interface XIncreasingList<E>

Specified by:

addAll in interface XIncreasingSequence<E>

Specified by:

addAll in interface XInputtingList<E>

Specified by:

addAll in interface XInputtingSequence<E>

Specified by:

addAll in interface XInsertingSequence<E>

Specified by:

addAll in interface XList<E>

Specified by:

addAll in interface XPutGetCollection<E>

Specified by:

addAll in interface XPutGetList<E>

Specified by:

addAll in interface XPutGetSequence<E>

Specified by:

addAll in interface XPuttingBag<E>

Specified by:

addAll in interface XPuttingList<E>

Specified by:

addAll in interface XSequence<E>

addAll

public ArrayCollector<E> addAll(XGettingCollection<? extends E> elements)

Specified by:

addAll in interface XAddGetCollection<E>

Specified by:

addAll in interface XAddingBag<E>

Specified by:

addAll in interface XAddingCollection<E>

Specified by:

addAll in interface XAddingList<E>

Specified by:

addAll in interface XAddingSequence<E>

Specified by:

addAll in interface XBag<E>

Specified by:

addAll in interface XBasicList<E>

Specified by:

addAll in interface XBasicSequence<E>

Specified by:

addAll in interface XCollection<E>

Specified by:

addAll in interface XExpandingList<E>

Specified by:

addAll in interface XExpandingSequence<E>

Specified by:

addAll in interface XExtendingList<E>

Specified by:

addAll in interface XExtendingSequence<E>

Specified by:

addAll in interface XIncreasingList<E>

Specified by:

addAll in interface XIncreasingSequence<E>

Specified by:

addAll in interface XInputtingList<E>

Specified by:

addAll in interface XInputtingSequence<E>

Specified by:

addAll in interface XInsertingSequence<E>

Specified by:

addAll in interface XList<E>

Specified by:

addAll in interface XPutGetCollection<E>

Specified by:

addAll in interface XPutGetList<E>

Specified by:

addAll in interface XPutGetSequence<E>

Specified by:

addAll in interface XPuttingBag<E>

Specified by:

addAll in interface XPuttingList<E>

Specified by:

addAll in interface XSequence<E>

nullAdd

public boolean nullAdd()

Specified by:

nullAdd in interface XAddingCollection<E>

put

public boolean put(E element)

Specified by:

put in interface XPuttingCollection<E>

putAll

@SafeVarargs
public final ArrayCollector<E> putAll(E... elements)

Specified by:

putAll in interface XBag<E>

Specified by:

putAll in interface XBasicList<E>

Specified by:

putAll in interface XBasicSequence<E>

Specified by:

putAll in interface XCollection<E>

Specified by:

putAll in interface XExpandingList<E>

Specified by:

putAll in interface XExpandingSequence<E>

Specified by:

putAll in interface XIncreasingList<E>

Specified by:

putAll in interface XIncreasingSequence<E>

Specified by:

putAll in interface XInputtingList<E>

Specified by:

putAll in interface XInputtingSequence<E>

Specified by:

putAll in interface XList<E>

Specified by:

putAll in interface XPutGetCollection<E>

Specified by:

putAll in interface XPutGetList<E>

Specified by:

putAll in interface XPutGetSequence<E>

Specified by:

putAll in interface XPuttingBag<E>

Specified by:

putAll in interface XPuttingCollection<E>

Specified by:

putAll in interface XPuttingList<E>

Specified by:

putAll in interface XPuttingSequence<E>

Specified by:

putAll in interface XSequence<E>

putAll

public ArrayCollector<E> putAll(E[] elements,
                                int offset,
                                int length)

Specified by:

putAll in interface XBag<E>

Specified by:

putAll in interface XBasicList<E>

Specified by:

putAll in interface XBasicSequence<E>

Specified by:

putAll in interface XCollection<E>

Specified by:

putAll in interface XExpandingList<E>

Specified by:

putAll in interface XExpandingSequence<E>

Specified by:

putAll in interface XIncreasingList<E>

Specified by:

putAll in interface XIncreasingSequence<E>

Specified by:

putAll in interface XInputtingList<E>

Specified by:

putAll in interface XInputtingSequence<E>

Specified by:

putAll in interface XList<E>

Specified by:

putAll in interface XPutGetCollection<E>

Specified by:

putAll in interface XPutGetList<E>

Specified by:

putAll in interface XPutGetSequence<E>

Specified by:

putAll in interface XPuttingBag<E>

Specified by:

putAll in interface XPuttingCollection<E>

Specified by:

putAll in interface XPuttingList<E>

Specified by:

putAll in interface XPuttingSequence<E>

Specified by:

putAll in interface XSequence<E>

putAll

public ArrayCollector<E> putAll(XGettingCollection<? extends E> elements)

Specified by:

putAll in interface XBag<E>

Specified by:

putAll in interface XBasicList<E>

Specified by:

putAll in interface XBasicSequence<E>

Specified by:

putAll in interface XCollection<E>

Specified by:

putAll in interface XExpandingList<E>

Specified by:

putAll in interface XExpandingSequence<E>

Specified by:

putAll in interface XIncreasingList<E>

Specified by:

putAll in interface XIncreasingSequence<E>

Specified by:

putAll in interface XInputtingList<E>

Specified by:

putAll in interface XInputtingSequence<E>

Specified by:

putAll in interface XList<E>

Specified by:

putAll in interface XPutGetCollection<E>

Specified by:

putAll in interface XPutGetList<E>

Specified by:

putAll in interface XPutGetSequence<E>

Specified by:

putAll in interface XPuttingBag<E>

Specified by:

putAll in interface XPuttingCollection<E>

Specified by:

putAll in interface XPuttingList<E>

Specified by:

putAll in interface XPuttingSequence<E>

Specified by:

putAll in interface XSequence<E>

nullPut

public boolean nullPut()

Specified by:

nullPut in interface XPuttingCollection<E>

prepend

public boolean prepend(E element)

Specified by:

prepend in interface XPrependingSequence<E>

prependAll

@SafeVarargs
public final ArrayCollector<E> prependAll(E... elements)

Specified by:

prependAll in interface XExpandingList<E>

Specified by:

prependAll in interface XExpandingSequence<E>

Specified by:

prependAll in interface XExtendingList<E>

Specified by:

prependAll in interface XExtendingSequence<E>

Specified by:

prependAll in interface XIncreasingList<E>

Specified by:

prependAll in interface XIncreasingSequence<E>

Specified by:

prependAll in interface XInputtingList<E>

Specified by:

prependAll in interface XInputtingSequence<E>

Specified by:

prependAll in interface XInsertingSequence<E>

Specified by:

prependAll in interface XList<E>

Specified by:

prependAll in interface XPrependingList<E>

Specified by:

prependAll in interface XPrependingSequence<E>

Specified by:

prependAll in interface XPreputtingList<E>

Specified by:

prependAll in interface XPreputtingSequence<E>

prependAll

public ArrayCollector<E> prependAll(E[] elements,
                                    int srcStartIndex,
                                    int srcLength)

Specified by:

prependAll in interface XExpandingList<E>

Specified by:

prependAll in interface XExpandingSequence<E>

Specified by:

prependAll in interface XExtendingList<E>

Specified by:

prependAll in interface XExtendingSequence<E>

Specified by:

prependAll in interface XIncreasingList<E>

Specified by:

prependAll in interface XIncreasingSequence<E>

Specified by:

prependAll in interface XInputtingList<E>

Specified by:

prependAll in interface XInputtingSequence<E>

Specified by:

prependAll in interface XInsertingSequence<E>

Specified by:

prependAll in interface XList<E>

Specified by:

prependAll in interface XPrependingList<E>

Specified by:

prependAll in interface XPrependingSequence<E>

Specified by:

prependAll in interface XPreputtingList<E>

Specified by:

prependAll in interface XPreputtingSequence<E>

prependAll

public ArrayCollector<E> prependAll(XGettingCollection<? extends E> elements)

Specified by:

prependAll in interface XExpandingList<E>

Specified by:

prependAll in interface XExpandingSequence<E>

Specified by:

prependAll in interface XExtendingList<E>

Specified by:

prependAll in interface XExtendingSequence<E>

Specified by:

prependAll in interface XIncreasingList<E>

Specified by:

prependAll in interface XIncreasingSequence<E>

Specified by:

prependAll in interface XInputtingList<E>

Specified by:

prependAll in interface XInputtingSequence<E>

Specified by:

prependAll in interface XInsertingSequence<E>

Specified by:

prependAll in interface XList<E>

Specified by:

prependAll in interface XPrependingList<E>

Specified by:

prependAll in interface XPrependingSequence<E>

Specified by:

prependAll in interface XPreputtingList<E>

Specified by:

prependAll in interface XPreputtingSequence<E>

nullPrepend

public boolean nullPrepend()

Specified by:

nullPrepend in interface XPrependingSequence<E>

preput

public boolean preput(E element)

Specified by:

preput in interface XPreputtingSequence<E>

preputAll

@SafeVarargs
public final ArrayCollector<E> preputAll(E... elements)

Specified by:

preputAll in interface XExpandingList<E>

Specified by:

preputAll in interface XExpandingSequence<E>

Specified by:

preputAll in interface XIncreasingList<E>

Specified by:

preputAll in interface XIncreasingSequence<E>

Specified by:

preputAll in interface XInputtingList<E>

Specified by:

preputAll in interface XInputtingSequence<E>

Specified by:

preputAll in interface XList<E>

Specified by:

preputAll in interface XPreputtingList<E>

Specified by:

preputAll in interface XPreputtingSequence<E>

preputAll

public ArrayCollector<E> preputAll(E[] elements,
                                   int offset,
                                   int length)

Specified by:

preputAll in interface XExpandingList<E>

Specified by:

preputAll in interface XExpandingSequence<E>

Specified by:

preputAll in interface XIncreasingList<E>

Specified by:

preputAll in interface XIncreasingSequence<E>

Specified by:

preputAll in interface XInputtingList<E>

Specified by:

preputAll in interface XInputtingSequence<E>

Specified by:

preputAll in interface XList<E>

Specified by:

preputAll in interface XPreputtingList<E>

Specified by:

preputAll in interface XPreputtingSequence<E>

preputAll

public ArrayCollector<E> preputAll(XGettingCollection<? extends E> elements)

Specified by:

preputAll in interface XExpandingList<E>

Specified by:

preputAll in interface XExpandingSequence<E>

Specified by:

preputAll in interface XIncreasingList<E>

Specified by:

preputAll in interface XIncreasingSequence<E>

Specified by:

preputAll in interface XInputtingList<E>

Specified by:

preputAll in interface XInputtingSequence<E>

Specified by:

preputAll in interface XList<E>

Specified by:

preputAll in interface XPreputtingList<E>

Specified by:

preputAll in interface XPreputtingSequence<E>

nullPreput

public boolean nullPreput()

Specified by:

nullPreput in interface XPreputtingSequence<E>

insert

public boolean insert(long index,
                      E element)

Specified by:

insert in interface XInsertingSequence<E>

insertAll

@SafeVarargs
public final long insertAll(long index,
                            E... elements)
                     throws IndexOutOfBoundsException

Specified by:

insertAll in interface XInsertingSequence<E>

Throws:

IndexOutOfBoundsException

insertAll

public long insertAll(long index,
                      E[] elements,
                      int offset,
                      int length)

Specified by:

insertAll in interface XInsertingSequence<E>

insertAll

public long insertAll(long index,
                      XGettingCollection<? extends E> elements)

Specified by:

insertAll in interface XInsertingSequence<E>

nullInsert

public boolean nullInsert(long index)

Specified by:

nullInsert in interface XInsertingSequence<E>

input

public boolean input(long index,
                     E element)

Specified by:

input in interface XInputtingSequence<E>

inputAll

@SafeVarargs
public final long inputAll(long index,
                           E... elements)
                    throws IndexOutOfBoundsException

Specified by:

inputAll in interface XInputtingSequence<E>

Throws:

IndexOutOfBoundsException

inputAll

public long inputAll(long index,
                     E[] elements,
                     int offset,
                     int length)

Specified by:

inputAll in interface XInputtingSequence<E>

inputAll

public long inputAll(long index,
                     XGettingCollection<? extends E> elements)

Specified by:

inputAll in interface XInputtingSequence<E>

nullInput

public boolean nullInput(long index)

Specified by:

nullInput in interface XInputtingSequence<E>

truncate

public void truncate()

Description copied from interface: XRemovingCollection

Clears (and reinitializes if needed) this collection in the fastest possible way, i.e. by allocating a new and empty internal storage of default capacity. The collection will be empty after calling this method.

Specified by:

truncate in interface Truncateable

Specified by:

truncate in interface XRemovingCollection<E>

consolidate

public long consolidate()

Description copied from interface: XRemovingCollection

Consolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore. (e.g. WeakReference entries whose reference has been cleared).

If this is not possible or not needed in the concrete implementation, this method does nothing and returns 0.

Specified by:

consolidate in interface ConsolidatableCollection

Specified by:

consolidate in interface XRemovingCollection<E>

Returns:

the number of discarded entries.

retrieve

public E retrieve(E element)

Specified by:

retrieve in interface XProcessingCollection<E>

retrieveBy

public E retrieveBy(Predicate<? super E> predicate)

Specified by:

retrieveBy in interface XProcessingCollection<E>

removeOne

public boolean removeOne(E element)

Specified by:

removeOne in interface XRemovingCollection<E>

remove

public long remove(E element)

Specified by:

remove in interface XRemovingCollection<E>

nullRemove

public long nullRemove()

Specified by:

nullRemove in interface XRemovingCollection<E>

removeBy

public long removeBy(Predicate<? super E> predicate)

Specified by:

removeBy in interface XProcessingCollection<E>

retainAll

public long retainAll(XGettingCollection<? extends E> elements)

Specified by:

retainAll in interface XRemovingCollection<E>

process

public final <P extends Consumer<? super E>> P process(P procedure)

Specified by:

process in interface Processable<E>

moveTo

public <C extends Consumer<? super E>> C moveTo(C target,
                                                Predicate<? super E> predicate)

Specified by:

moveTo in interface XProcessingCollection<E>

moveSelection

public <C extends Consumer<? super E>> C moveSelection(C target,
                                                       long... indices)

Specified by:

moveSelection in interface XProcessingSequence<E>

removeAll

public long removeAll(XGettingCollection<? extends E> elements)

Specified by:

removeAll in interface XRemovingCollection<E>

removeDuplicates

public long removeDuplicates(Equalator<? super E> equalator)

Specified by:

removeDuplicates in interface XProcessingCollection<E>

removeDuplicates

public long removeDuplicates()

Specified by:

removeDuplicates in interface XRemovingCollection<E>

fetch

public E fetch()

Specified by:

fetch in interface XProcessingCollection<E>

pop

public E pop()

Specified by:

pop in interface XProcessingSequence<E>

pinch

public E pinch()

Specified by:

pinch in interface XProcessingCollection<E>

pick

public E pick()

Specified by:

pick in interface XProcessingSequence<E>

removeSelection

public long removeSelection(long[] indices)

Specified by:

removeSelection in interface XRemovingSequence<E>

removeRange

public ArrayCollector<E> removeRange(long startIndex,
                                     long length)

Specified by:

removeRange in interface XRemovingSequence<E>

retainRange

public ArrayCollector<E> retainRange(long startIndex,
                                     long length)

Specified by:

retainRange in interface XList<E>

Specified by:

retainRange in interface XRemovingSequence<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Sized

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface XGettingCollection<E>

listIterator

public ListIterator<E> listIterator()

Specified by:

listIterator in interface XGettingList<E>

listIterator

public ListIterator<E> listIterator(long index)

Specified by:

listIterator in interface XGettingList<E>

set

public boolean set(long index,
                   E element)
            throws IndexOutOfBoundsException,
                   ArrayIndexOutOfBoundsException

Specified by:

set in interface XSettingSequence<E>

Throws:

IndexOutOfBoundsException

ArrayIndexOutOfBoundsException

setGet

public E setGet(long index,
                E element)
         throws IndexOutOfBoundsException,
                ArrayIndexOutOfBoundsException

Specified by:

setGet in interface XSettingSequence<E>

Throws:

IndexOutOfBoundsException

ArrayIndexOutOfBoundsException

size

public long size()

Specified by:

size in interface Sized

Specified by:

size in interface XGettingCollection<E>

range

public SubList<E> range(long fromIndex,
                        long toIndex)

Specified by:

range in interface XDecreasingList<E>

Specified by:

range in interface XDecreasingSequence<E>

Specified by:

range in interface XGettingList<E>

Specified by:

range in interface XGettingSequence<E>

Specified by:

range in interface XIncreasingList<E>

Specified by:

range in interface XIncreasingSequence<E>

Specified by:

range in interface XList<E>

Specified by:

range in interface XSettingList<E>

Specified by:

range in interface XSettingSequence<E>

toString

public String toString()

Overrides:

toString in class Object

toArray

public Object[] toArray()

Specified by:

toArray in interface XGettingCollection<E>

at

public E at(long index)
     throws ArrayIndexOutOfBoundsException

Specified by:

at in interface XGettingSequence<E>

Throws:

ArrayIndexOutOfBoundsException

clear

public void clear()

Description copied from interface: XRemovingCollection

Clears all elements from the collection while leaving the capacity as it is.

Specified by:

clear in interface Clearable

Specified by:

clear in interface XRemovingCollection<E>

removeAt

public E removeAt(long index)
           throws IndexOutOfBoundsException,
                  ArrayIndexOutOfBoundsException

Specified by:

removeAt in interface XProcessingSequence<E>

Throws:

IndexOutOfBoundsException

ArrayIndexOutOfBoundsException

equals

@Deprecated
public boolean equals(Object o)

Deprecated.

Description copied from interface: XGettingCollection

Performs an equality comparison according to the specification in Collection.

Note that it is this interface's author opinion that the whole concept of equals() in standard Java, especially in the collection implementations, is flawed.
The reason is because all different kinds of comparison types that actually depend on the situation have to be mixed up in a harcoded fashion in one method, from identity comparison over data indentity comparison to content comparison.
In order to get the right behavior in every situation, one has to distinct between different types of equality

This means several things:
1.) You can't just say for example an ArrayList is the "same" as a LinkedList just because they contain the same content.
There are different implementations for a good reason, so you have to distinct them when comparing. There are simple code examples which create massive misbehavior that will catastrophically ruin the runtime behavior of a programm due to this error in Java / JDK / Sun / whatever.
2.) You can't always determine equality of two collections by determining equality of each element as Collection defines it.

As a conclusion: don't use this method!
Be clear what type of comparison you really need, then use one of the following methods and proper comparators:
XGettingCollection.equals(XGettingCollection,Equalator)
XGettingCollection.equalsContent(XGettingCollection,Equalator)

Specified by:

equals in interface XGettingCollection<E>

Overrides:

equals in class Object

hashCode

@Deprecated
public int hashCode()

Deprecated.

Specified by:

hashCode in interface XGettingCollection<E>

Overrides:

hashCode in class Object

old

public ArrayCollector.OldArrayCollector<E> old()

Specified by:

old in interface XGettingCollection<E>

Specified by:

old in interface XGettingList<E>