one.microstream.collections

Class SynchList<E>

java.lang.Object

one.microstream.collections.SynchList<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>, Synchronized, ThreadSafe, Processable<E>, Clearable, Copyable

public final class SynchList<E>
extends Object
implements XList<E>, Synchronized

Synchronization wrapper class that wraps an XList instance in public synchronized delegate methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SynchList.OldSynchList<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.XBag

XBag.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.XInputtingList

XInputtingList.Factory<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.XBasicSequence

XBasicSequence.Factory<E>

Constructor Summary

Constructors

Constructor and Description
SynchList(XList<E> list) Creates a new SynchList that wraps the passed XList instance.

Method Summary

Modifier and Type	Method and Description
void	accept(E e)
boolean	add(E e) Adds the passed element.
SynchList<E>	addAll(E... elements)
SynchList<E>	addAll(E[] elements, int offset, int length)
SynchList<E>	addAll(XGettingCollection<? extends E> elements)
boolean	applies(Predicate<? super E> predicate) Tests each element of the collection on the given 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) Checks if the given element is contained in the collection.
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)
SynchList<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) Iterates through all the elements of the given indices and calls the Consumer.accept(Object) on the target Consumer.
<C extends Consumer<? super E>> C	copyTo(C target) Calls Consumer.accept(Object) on the target Consumer for all the elements of this collection.
long	count(E element) Count how many times this element matches another element in the collection using the Equalator.
long	countBy(Predicate<? super E> predicate) Count how many matches are found using the given predicate on each element of the collection.
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) Calls Consumer.accept(Object) on the target Consumer for all the unique/distinct elements of this collection.
<C extends Consumer<? super E>> C	distinct(C target, Equalator<? super E> equalator) Calls Consumer.accept(Object) on the target Consumer for all the unique/distinct elements of this collection.
SynchList<E>	ensureCapacity(long minimalCapacity)
SynchList<E>	ensureFreeCapacity(long minimalFreeCapacity) 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)
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> other, Equalator<? super E> equalator, C target) Calls Consumer.accept(Object) on the target Consumer for each element of this collection that is not contained in the other collection (through the given equalator).
E	fetch()
SynchList<E>	fill(long offset, long length, E element) Fills all slots from the offset to the offset+length with the given element, regardless of whether or not a slot is null.
<C extends Consumer<? super E>> C	filterTo(C target, Predicate<? super E> predicate) Calls Consumer.accept(Object) on the target Consumer for all the elements of this collection which test true on the given predicate.
E	first() Gets first element or throws IndexOutOfBoundsException if the collection is empty.
E	get() Gets one element from the collection.
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) Iterates forwards through the collection and returns the index of the first element that the passed {link Predicate} applies to immediately. Stops iterating on the first element that the predicate applies to.
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> other, Equalator<? super E> equalator, C target) Tests equality between each element of the two lists and calls Consumer.accept(Object) on the target Consumer for the equal elements. Therefore it effectively creates a mathematical intersection between the two collections.
boolean	isEmpty()
boolean	isFull()
boolean	isSorted(Comparator<? super E> comparator) Tests if the collection is sorted according to the given comparator.
<P extends Consumer<? super E>> P	iterate(P procedure) Executes the given procedure for each element of the XIterable until all elements have been processed or the action throws an exception.
<P extends IndexedAcceptor<? super E>> P	iterateIndexed(P procedure) Iterates over elements with the IndexedAcceptor to use not only the element itself but also its coherent index.
Iterator<E>	iterator()
<A> A	join(BiConsumer<? super E,? super A> joiner, A aggregate) Iterates over all elements of the collections and calls the joiner with each element and the aggregate.
E	last() Gets last element or throws IndexOutOfBoundsException if the collection is empty.
long	lastIndexBy(Predicate<? super E> predicate) Iterates backwards through the collection and returns the index of the last element that the passed Predicate applies to immediately. Stops iterating on the first element that the predicate applies to.
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() Defines if null-elements are allowed inside the collection or not.
boolean	nullContained()
boolean	nullInput(long index)
boolean	nullInsert(long index)
boolean	nullPrepend()
boolean	nullPreput()
boolean	nullPut()
long	nullRemove()
SynchList.OldSynchList<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() Gets last element or null if the collection is empty.
E	pick()
E	pinch()
E	poll() Gets first element or null if the collection is empty.
E	pop()
boolean	prepend(E element)
SynchList<E>	prependAll(E... elements)
SynchList<E>	prependAll(E[] elements, int offset, int length)
SynchList<E>	prependAll(XGettingCollection<? extends E> elements)
boolean	preput(E element)
SynchList<E>	preputAll(E... elements)
SynchList<E>	preputAll(E[] elements, int offset, int length)
SynchList<E>	preputAll(XGettingCollection<? extends E> elements)
<P extends Consumer<? super E>> P	process(P procedure)
boolean	put(E e) Adds the specified element to this collection if it is not already present (optional operation).
SynchList<E>	putAll(E... elements) Adds the specified elements to this collection if it is not already present (optional operation).
SynchList<E>	putAll(E[] elements, int offset, int length) Adds the specified elements to this collection if it is not already present (optional operation). Only the elements with indizes from the srcStartIndex to the srcStartIndex+srcLength are put in the collection.
SynchList<E>	putAll(XGettingCollection<? extends E> elements) Adds the specified elements to this collection if it is not already present (optional operation).
XList<E>	range(long fromIndex, long toIndex)
long	remainingCapacity()
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)
SynchList<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) Replaces the first element that is equal to the given element with the replacement and then returns true.
boolean	replaceOne(Predicate<? super E> predicate, E substitute)
long	retainAll(XGettingCollection<? extends E> elements) Removing all elements except the ones contained in the given elements-collection.
SynchList<E>	retainRange(long startIndex, long length) Removing all elements but the ones from the offset (basically start index) to the offset+length (end index).
E	retrieve(E element)
E	retrieveBy(Predicate<? super E> predicate)
SynchList<E>	reverse() Reverses the order of its own elements and returns itself.
long	scan(Predicate<? super E> predicate) Iterates through the collection and returns the index of the last element that the passed Predicate applied to ("scanning").
E	search(Predicate<? super E> predicate) Returns the first contained element matching the passed 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)
SynchList<E>	set(long offset, E[] src, int srcIndex, int srcLength)
SynchList<E>	set(long offset, XGettingSequence<? extends E> elements, long elementsOffset, long elementsLength)
SynchList<E>	setAll(long offset, E... elements)
void	setFirst(E element)
E	setGet(long index, E element)
void	setLast(E element)
SynchList<E>	shiftBy(long sourceIndex, long distance) Moves the element from the sourceIndex in the sequence to a higher index position. All other elements are possibly moved to create the empty slot for the shifting element.
SynchList<E>	shiftBy(long sourceIndex, long distance, long length) Moves multiple elements from the sourceIndex in the sequence to a higher index position. All other elements are possibly moved to create the empty slot for the shifting elements.
SynchList<E>	shiftTo(long sourceIndex, long targetIndex) Moves the element from the sourceIndex in the sequence to the targetIndex. All other elements are possibly moved to create the empty slot for the shifting element.
SynchList<E>	shiftTo(long sourceIndex, long targetIndex, long length) Moves multiple elements from the sourceIndex in the sequence to the targetIndex. All other elements are possibly moved to create the empty slot for the shifting element.
long	size()
SynchList<E>	sort(Comparator<? super E> comparator) Sorts this collection according to the given comparator and returns itself.
long	substitute(Function<? super E,? extends E> mapper)
long	substitute(Predicate<? super E> predicate, Function<E,E> mapper)
SynchList<E>	swap(long indexA, long indexB)
SynchList<E>	swap(long indexA, long indexB, long length)
Object[]	toArray() Returns an array containing all of the elements in this collection.
E[]	toArray(Class<E> type) Returns a typed array containing all of the elements in this collection.
SynchList<E>	toReversed() Creates a new XBasicList with the reversed order of elements.
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> other, Equalator<? super E> equalator, C target) Calls Consumer.accept(Object) on the target Consumer for all the elements of this collection.
ListView<E>	view() Creates a view of this collection and returns it.
SubListView<E>	view(long fromIndex, long toIndex) Creates a sub-view of this collection and returns it.

Methods inherited from class java.lang.Object

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

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

collector

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

currentFreeCapacity

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface one.microstream.collections.sorting.SortableProcedure

sortIfApplicable

Constructor Detail

SynchList

public SynchList(XList<E> list)

Creates a new SynchList that wraps the passed XList instance.

Parameters:

list - the XList instance to be wrapped (synchronized).

Method Detail

equality

public final Equalator<? super E> equality()

Specified by:

equality in interface XGettingCollection<E>

accept

public final void accept(E e)

Specified by:

accept in interface Consumer<E>

Specified by:

accept in interface XAddingCollection<E>

addAll

@SafeVarargs
public final SynchList<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>

add

public final boolean add(E e)

Description copied from interface: XAddingCollection

Adds the passed element.

Specified by:

add in interface XAddingCollection<E>

Parameters:

e - to add

Returns:

true if element was added; false if not

addAll

public final SynchList<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 final SynchList<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 final boolean nullAdd()

Specified by:

nullAdd in interface XAddingCollection<E>

put

public final boolean put(E e)

Description copied from interface: XPuttingCollection

Adds the specified element to this collection if it is not already present (optional operation).

Specified by:

put in interface XPuttingCollection<E>

Parameters:

e - to add

Returns:

true if this collection did not already contain the specified element

putAll

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

Description copied from interface: XPuttingBag

Adds the specified elements to this collection if it is not already present (optional operation).

In this implementation it is identical to XPuttingBag.addAll(Object...)

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>

Parameters:

elements - to add

Returns:

this

putAll

public final SynchList<E> putAll(XGettingCollection<? extends E> elements)

Description copied from interface: XPuttingBag

Adds the specified elements to this collection if it is not already present (optional operation).

In this implementation it is identical to XPuttingBag.addAll(XGettingCollection)

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>

Parameters:

elements - to add

Returns:

this

putAll

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

Description copied from interface: XPuttingBag

Adds the specified elements to this collection if it is not already present (optional operation).
Only the elements with indizes from the srcStartIndex to the srcStartIndex+srcLength are put in the collection.

In this implementation it is identical to XPuttingBag.addAll(Object[], int, int)

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>

Parameters:

elements - to add

offset - start index of elements-array to add to collection

length - length of elements-array to add to collection

Returns:

this

nullPut

public final boolean nullPut()

Specified by:

nullPut in interface XPuttingCollection<E>

prepend

public final boolean prepend(E element)

Specified by:

prepend in interface XPrependingSequence<E>

prependAll

@SafeVarargs
public final SynchList<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 final SynchList<E> prependAll(E[] elements,
                                     int offset,
                                     int length)

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 final SynchList<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 final boolean nullPrepend()

Specified by:

nullPrepend in interface XPrependingSequence<E>

preput

public final boolean preput(E element)

Specified by:

preput in interface XPreputtingSequence<E>

preputAll

@SafeVarargs
public final SynchList<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 final SynchList<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 final SynchList<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 final boolean nullPreput()

Specified by:

nullPreput in interface XPreputtingSequence<E>

insert

public final boolean insert(long index,
                            E element)

Specified by:

insert in interface XInsertingSequence<E>

insertAll

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

Specified by:

insertAll in interface XInsertingSequence<E>

insertAll

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

Specified by:

insertAll in interface XInsertingSequence<E>

insertAll

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

Specified by:

insertAll in interface XInsertingSequence<E>

nullInsert

public final boolean nullInsert(long index)

Specified by:

nullInsert in interface XInsertingSequence<E>

input

public final boolean input(long index,
                           E element)

Specified by:

input in interface XInputtingSequence<E>

inputAll

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

Specified by:

inputAll in interface XInputtingSequence<E>

inputAll

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

Specified by:

inputAll in interface XInputtingSequence<E>

inputAll

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

Specified by:

inputAll in interface XInputtingSequence<E>

nullInput

public final boolean nullInput(long index)

Specified by:

nullInput in interface XInputtingSequence<E>

containsSearched

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

Specified by:

containsSearched in interface XGettingCollection<E>

applies

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

Description copied from interface: XGettingCollection

Tests each element of the collection on the given predicate.

Specified by:

applies in interface XGettingCollection<E>

Parameters:

predicate - that's tested on each element.

Returns:

If all elements test successfully, true is returned. Otherwise (if at least one test has failed), false is returned.

clear

public final 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 XRemovingCollection<E>

Specified by:

clear in interface Clearable

consolidate

public final long consolidate()

Description copied from interface: ConsolidatableCollection

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).

Specified by:

consolidate in interface ConsolidatableCollection

Specified by:

consolidate in interface XRemovingCollection<E>

Returns:

the number of discarded entries.

contains

public final boolean contains(E element)

Description copied from interface: XGettingCollection

Checks if the given element is contained in the collection.
In contrast to the XGettingCollection.containsId(Object) method, this method uses the internal Equalator defined by the collection itself.

Specified by:

contains in interface XGettingCollection<E>

Parameters:

element - to be searched in the collection

Returns:

Whether this collection contains the given element as specified by the Equalator.

containsAll

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

Specified by:

containsAll in interface XGettingCollection<E>

Parameters:

elements - to be searched in the collection.

Returns:

Whether this collection contains all given elements as specified by the Equalator.

containsId

public final 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 exactly the given element.

copy

public final SynchList<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 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>

Specified by:

copy in interface Copyable

Returns:

a copy of this list

immure

public final 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.

copySelection

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

Description copied from interface: XGettingSequence

Iterates through all the elements of the given indices and calls the Consumer.accept(Object) on the target Consumer.

Specified by:

copySelection in interface XGettingSequence<E>

Type Parameters:

C - type of the target

Parameters:

target - on which the Consumer.accept(Object) is called

indices - of the elements which are copied

Returns:

Given target

filterTo

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

Description copied from interface: XGettingCollection

Calls Consumer.accept(Object) on the target Consumer for all the elements of this collection which test true on the given predicate.

Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.

Example:

 BulkList<Integer> collection1 = BulkList.New(1,2,3);
 BulkList<Integer> filteredCollection = collection1.filterTo(BulkList.New(), e-> e % 2 == 0);
 

Results in filteredCollection containing 2.

Specified by:

filterTo in interface XGettingCollection<E>

Type Parameters:

C - type of the target

Parameters:

target - on which the Consumer.accept(Object) is called for elements that test true.

predicate - on which to test all elements.

Returns:

Given target

copyTo

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

Description copied from interface: XGettingCollection

Calls Consumer.accept(Object) on the target Consumer for all the elements of this collection.

Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.

Example:

 BulkList<Integer> collection1 = BulkList.New(1,2,3);
 BulkList<Integer> copiedCollection = collection1.copyTo(BulkList.New());
 

Results in copiedCollection containing 1, 2 and 3.

Specified by:

copyTo in interface XGettingCollection<E>

Type Parameters:

C - type of the target

Parameters:

target - on which the Consumer.accept(Object) is called for all elements of this collection.

Returns:

Given target

count

public final long count(E element)

Description copied from interface: XGettingCollection

Count how many times this element matches another element in the collection using the Equalator.

Specified by:

count in interface XGettingCollection<E>

Parameters:

element - to count

Returns:

Amount of matches

countBy

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

Description copied from interface: XGettingCollection

Count how many matches are found using the given predicate on each element of the collection.

Specified by:

countBy in interface XGettingCollection<E>

Parameters:

predicate - defines which elements are counted and which are not

Returns:

Amount of matches

distinct

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

Description copied from interface: XGettingCollection

Calls Consumer.accept(Object) on the target Consumer for all the unique/distinct elements of this collection. This means the elements are not equal to each other.
Uniqueness is defined by the given Equalator.

Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.

Example:

 BulkList<Integer> collection1 = BulkList.New(1,2,2,3);
 BulkList<Integer> distinctCollection = collection1.distinct(BulkList.New(), Equalator.identity());
 

Results in distinctCollection containing 1, 2 and 3.

Specified by:

distinct in interface XGettingCollection<E>

Type Parameters:

C - type of the target

Parameters:

target - on which the Consumer.accept(Object) is called for every distinct element of this collection.

equalator - defines what distinct means (which elements are equal to one another)

Returns:

Given target

distinct

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

Description copied from interface: XGettingCollection

Calls Consumer.accept(Object) on the target Consumer for all the unique/distinct elements of this collection. This means the elements are not equal to each other.
Uniqueness is defined by the collections internal Equalator.

Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.

Example:
BulkList<Integer> collection1 = BulkList.New(1,2,2,3);
BulkList<Integer> distinctCollection = collection1.distinct(BulkList.New());
Results in distinctCollection containing 1, 2 and 3.

Specified by:

distinct in interface XGettingCollection<E>

Type Parameters:

C - type of the target

Parameters:

target - on which the Consumer.accept(Object) is called for every distinct element of this collection.

Returns:

Given target

ensureFreeCapacity

public final SynchList<E> ensureFreeCapacity(long minimalFreeCapacity)

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

Parameters:

minimalFreeCapacity - the capacity to ensure

Returns:

this

ensureCapacity

public final SynchList<E> ensureCapacity(long minimalCapacity)

Specified by:

ensureCapacity in interface CapacityExtendable

equals

@Deprecated
public final 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

Parameters:

o - the reference object with which to compare.

equals

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

Specified by:

equals in interface XGettingCollection<E>

Parameters:

samples - is the collection which is checked for equality

equalator - is used to check the equality of the collections

Returns:

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

equalsContent

public final 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>

Parameters:

samples - is the collection which is checked for equality

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

except

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

Description copied from interface: XGettingCollection

Calls Consumer.accept(Object) on the target Consumer for each element of this collection that is not contained in the other collection (through the given equalator).

Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.

Example:

 BulkList<Integer> collection1 = BulkList.New(1,2,3);
 BulkList<Integer> collection2 = BulkList.New(2,3,4);
 BulkList<Integer> exceptCollection = collection1.except(collection2, Equalator.identity(), BulkList.New());
 

Results in exceptCollection containing 1.

Specified by:

except in interface XGettingCollection<E>

Type Parameters:

C - type of the target

Parameters:

other - collection whose elements are excluded from the target.

equalator - which is used for the equal-tests.

target - on which the Consumer.accept(Object) is called for elements not contained in the other collection.

Returns:

Given target

iterate

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

Description copied from interface: XIterable

Executes the given procedure for each element of the XIterable until all elements have been processed or the action throws an exception. Unless otherwise specified by the implementing class, procedures are performed in the order of iteration (if an iteration order is specified). Exceptions thrown by the procedure are relayed to the caller.
Should be identical to Iterable.forEach(Consumer).

Specified by:

iterate in interface XIterable<E>

Specified by:

iterate in interface XList<E>

Specified by:

iterate in interface XProcessingCollection<E>

Type Parameters:

P - type of procedure

Parameters:

procedure - The procedure to be performed for each element

Returns:

Given procedure

iterateIndexed

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

Description copied from interface: XIndexIterable

Iterates over elements with the IndexedAcceptor to use not only the element itself but also its coherent index.

Specified by:

iterateIndexed in interface XIndexIterable<E>

Type Parameters:

P - type of procedure

Parameters:

procedure - which is executed when iterating

Returns:

Given procedure

join

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

Description copied from interface: XJoinable

Iterates over all elements of the collections and calls the joiner with each element and the aggregate.

Specified by:

join in interface XGettingCollection<E>

Specified by:

join in interface XJoinable<E>

Type Parameters:

A - type of aggregate

Parameters:

joiner - is the actual function to do the joining

aggregate - where to join into

Returns:

the joined aggregate

fill

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

Description copied from interface: XSettingList

Fills all slots from the offset to the offset+length with the given element, regardless of whether or not a slot is null.

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>

Parameters:

offset - from the start of the collection (start index)

length - of how many slots should be filled

element - to use for filling of slots

Returns:

this

at

public final E at(long index)

Specified by:

at in interface XGettingSequence<E>

get

public final 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 final E first()

Description copied from interface: XGettingSequence

Gets first element or throws IndexOutOfBoundsException if the collection is empty.

Is an alias for XGettingSequence.get().

Specified by:

first in interface XGettingSequence<E>

Returns:

First element

last

public final E last()

Description copied from interface: XGettingSequence

Gets last element or throws IndexOutOfBoundsException if the collection is empty.

Specified by:

last in interface XGettingSequence<E>

Returns:

Last element

poll

public final E poll()

Description copied from interface: XGettingSequence

Gets first element or null if the collection is empty.

Specified by:

poll in interface XGettingSequence<E>

Returns:

First element or null

peek

public final E peek()

Description copied from interface: XGettingSequence

Gets last element or null if the collection is empty.
This behaves like peeking on a stack without pop.

Specified by:

peek in interface XGettingSequence<E>

Returns:

Last element or null

hashCode

@Deprecated
public final int hashCode()

Deprecated.

Specified by:

hashCode in interface XGettingCollection<E>

Overrides:

hashCode in class Object

hasVolatileElements

public final boolean hasVolatileElements()

Description copied from interface: ExtendedCollection

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.

indexOf

public final long indexOf(E element)

Specified by:

indexOf in interface XGettingSequence<E>

indexBy

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

Description copied from interface: XGettingSequence

Iterates forwards through the collection and returns the index of the first element that the passed {link Predicate} applies to immediately.
Stops iterating on the first element that the predicate applies to.

Basically the opposite of XGettingSequence.lastIndexBy(Predicate)

Specified by:

indexBy in interface XGettingSequence<E>

Parameters:

predicate - to define a valid element

Returns:

The index of the first positively tested element.

intersect

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

Description copied from interface: XGettingCollection

Tests equality between each element of the two lists and calls Consumer.accept(Object) on the target Consumer for the equal elements.
Therefore it effectively creates a mathematical intersection between the two collections.

Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.

Example:

 BulkList<Integer> collection1 = BulkList.New(1,2,3);
 BulkList<Integer> collection2 = BulkList.New(2,3,4);
 BulkList<Integer> intersection = collection1.intersect(collection2, Equalator.identity(), BulkList.New());
 

Results in intersection containing 2 and 3.

Specified by:

intersect in interface XGettingCollection<E>

Type Parameters:

C - type of the target

Parameters:

other - collection to intersect with.

equalator - which is used for the equal-tests.

target - on which the Consumer.accept(Object) is called for equal elements.

Returns:

Given target

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Sized

isSorted

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

Description copied from interface: XGettingSequence

Tests if the collection is sorted according to the given comparator.

Specified by:

isSorted in interface XGettingSequence<E>

Parameters:

comparator - defines if elements are sorted

Returns:

true if it sorted, false if not

iterator

public final Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface XGettingCollection<E>

lastIndexBy

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

Description copied from interface: XGettingSequence

Iterates backwards through the collection and returns the index of the last element that the passed Predicate applies to immediately.
Stops iterating on the first element that the predicate applies to.

Basically the opposite of XGettingSequence.indexBy(Predicate).
Similar but not the same as XGettingSequence.scan(Predicate), since scan iterates through all elements.

Specified by:

lastIndexBy in interface XGettingSequence<E>

Parameters:

predicate - to define a valid element

Returns:

the index of the last positively tested element.

lastIndexOf

public final long lastIndexOf(E element)

Specified by:

lastIndexOf in interface XGettingSequence<E>

listIterator

public final ListIterator<E> listIterator()

Specified by:

listIterator in interface XGettingList<E>

listIterator

public final ListIterator<E> listIterator(long index)

Specified by:

listIterator in interface XGettingList<E>

max

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

Specified by:

max in interface XGettingCollection<E>

maxIndex

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

Specified by:

maxIndex in interface XGettingSequence<E>

min

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

Specified by:

min in interface XGettingCollection<E>

minIndex

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

Specified by:

minIndex in interface XGettingSequence<E>

moveSelection

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

Specified by:

moveSelection in interface XProcessingSequence<E>

moveTo

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

Specified by:

moveTo in interface XProcessingCollection<E>

process

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

Specified by:

process in interface Processable<E>

removeBy

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

Specified by:

removeBy in interface XProcessingCollection<E>

remove

public final long remove(E element)

Specified by:

remove in interface XRemovingCollection<E>

removeAt

public final E removeAt(long index)

Specified by:

removeAt in interface XProcessingSequence<E>

removeAll

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

Specified by:

removeAll in interface XRemovingCollection<E>

removeDuplicates

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

Specified by:

removeDuplicates in interface XProcessingCollection<E>

removeDuplicates

public final long removeDuplicates()

Specified by:

removeDuplicates in interface XRemovingCollection<E>

fetch

public final E fetch()

Specified by:

fetch in interface XProcessingCollection<E>

pop

public final E pop()

Specified by:

pop in interface XProcessingSequence<E>

pinch

public final E pinch()

Specified by:

pinch in interface XProcessingCollection<E>

pick

public final E pick()

Specified by:

pick in interface XProcessingSequence<E>

removeOne

public final boolean removeOne(E element)

Specified by:

removeOne in interface XRemovingCollection<E>

retrieve

public final E retrieve(E element)

Specified by:

retrieve in interface XProcessingCollection<E>

retrieveBy

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

Specified by:

retrieveBy in interface XProcessingCollection<E>

removeRange

public final SynchList<E> removeRange(long startIndex,
                                      long length)

Specified by:

removeRange in interface XRemovingSequence<E>

retainRange

public final SynchList<E> retainRange(long startIndex,
                                      long length)

Description copied from interface: XRemovingSequence

Removing all elements but the ones from the offset (basically start index) to the offset+length (end index).

Specified by:

retainRange in interface XList<E>

Specified by:

retainRange in interface XRemovingSequence<E>

Parameters:

startIndex - is the index of the first element to retain

length - is the amount of elements to retain

Returns:

this

removeSelection

public final long removeSelection(long[] indices)

Specified by:

removeSelection in interface XRemovingSequence<E>

replace

public final long replace(E element,
                          E replacement)

Specified by:

replace in interface XReplacingBag<E>

replace

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

Specified by:

replace in interface XReplacingBag<E>

substitute

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

Specified by:

substitute in interface XReplacingCollection<E>

substitute

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

Specified by:

substitute in interface XReplacingBag<E>

replaceAll

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

Specified by:

replaceAll in interface XReplacingBag<E>

replaceOne

public final boolean replaceOne(E element,
                                E replacement)

Description copied from interface: XReplacingBag

Replaces the first element that is equal to the given element with the replacement and then returns true.

Specified by:

replaceOne in interface XReplacingBag<E>

Parameters:

element - to replace

replacement - for the found element

Returns:

true if element is found, false if not

replaceOne

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

Specified by:

replaceOne in interface XReplacingBag<E>

retainAll

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

Description copied from interface: XRemovingCollection

Removing all elements except the ones contained in the given elements-collection.

Basically intersect this collection with the given collection and only keeping the resulting elements.

Specified by:

retainAll in interface XRemovingCollection<E>

Parameters:

elements - to retain

Returns:

Amount of deleted elements

reverse

public final SynchList<E> reverse()

Description copied from interface: XSortableSequence

Reverses the order of its own elements and returns itself.

Unlike the XSortableSequence.toReversed() method, this method does not create a new collection, but changes the order of its own elements.

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>

Returns:

this

scan

public final 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 Predicate applied to ("scanning").

In order to find the last element, this method must iterate over all elements of the collection (opposed to XGettingSequence.indexBy(Predicate) and XGettingSequence.lastIndexBy(Predicate)).

Iteration can be safely canceled with a ThrowBreak (X.BREAK)

Specified by:

scan in interface XGettingSequence<E>

Parameters:

predicate - to define a valid element

Returns:

the index of the last positively tested element.

seek

public final 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>

Parameters:

sample - to seek in the collection

Returns:

the first contained element matching the passed sample

search

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

Description copied from interface: XGettingCollection

Returns the first contained element matching the passed predicate.

Specified by:

search in interface XGettingCollection<E>

Parameters:

predicate - defines which element is searched

Returns:

Matching element

setAll

@SafeVarargs
public final SynchList<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 final boolean set(long index,
                         E element)

Specified by:

set in interface XSettingSequence<E>

setGet

public final E setGet(long index,
                      E element)

Specified by:

setGet in interface XSettingSequence<E>

set

public final SynchList<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 final SynchList<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>

setFirst

public final void setFirst(E element)

Specified by:

setFirst in interface XSettingSequence<E>

setLast

public final void setLast(E element)

Specified by:

setLast in interface XSettingSequence<E>

optimize

public final 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.

size

public final long size()

Specified by:

size in interface Sized

Specified by:

size in interface XGettingCollection<E>

sort

public final SynchList<E> sort(Comparator<? super E> comparator)

Description copied from interface: Sortable

Sorts this collection according to the given comparator and returns itself.

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>

Parameters:

comparator - to sort this collection

Returns:

this

range

public final XList<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>

shiftTo

public final SynchList<E> shiftTo(long sourceIndex,
                                  long targetIndex)

Description copied from interface: XOrderingSequence

Moves the element from the sourceIndex in the sequence to the targetIndex.
All other elements are possibly moved to create the empty slot for the shifting element.

Does not expand or shrink the capacity of the sequence.

Throws a IndexExceededException if sourceIndex or targetIndex are greater than the size of the sequence.

Specified by:

shiftTo in interface XList<E>

Specified by:

shiftTo in interface XOrderingSequence<E>

Specified by:

shiftTo in interface XSortableSequence<E>

Parameters:

sourceIndex - points to the source element; Index of the source element

targetIndex - points to the target element; Index of the target element

Returns:

this

shiftTo

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

Description copied from interface: XOrderingSequence

Moves multiple elements from the sourceIndex in the sequence to the targetIndex.
All other elements are possibly moved to create the empty slot for the shifting element.

Does not expand or shrink the capacity of the sequence.

Throws a IndexExceededException if sourceIndex or targetIndex exceed the size of the sequence.

Specified by:

shiftTo in interface XList<E>

Specified by:

shiftTo in interface XOrderingSequence<E>

Specified by:

shiftTo in interface XSortableSequence<E>

Parameters:

sourceIndex - points to the source element; Index of the source element

targetIndex - points to the target element; Index of the target element

length - Amount of moved elements.

Returns:

self

shiftBy

public final SynchList<E> shiftBy(long sourceIndex,
                                  long distance)

Description copied from interface: XOrderingSequence

Moves the element from the sourceIndex in the sequence to a higher index position.
All other elements are possibly moved to create the empty slot for the shifting element. ("to the right")

Does not expand or shrink the capacity of the sequence.

Throws a IndexExceededException if sourceIndex or targetIndex (sourceIndex+distance) exceed the size of the sequence.

Specified by:

shiftBy in interface XList<E>

Specified by:

shiftBy in interface XOrderingSequence<E>

Specified by:

shiftBy in interface XSortableSequence<E>

Parameters:

sourceIndex - points to the source element; Index of the source element

distance - of how far the element should be moved. Example: 1 moves the element from position 21 to position 22

Returns:

self

shiftBy

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

Description copied from interface: XOrderingSequence

Moves multiple elements from the sourceIndex in the sequence to a higher index position.
All other elements are possibly moved to create the empty slot for the shifting elements. ("to the right")

Does not expand or shrink the capacity of the sequence.

Throws a IndexExceededException if sourceIndex or targetIndex (sourceIndex+distance+length) exceed the size of the sequence.

Specified by:

shiftBy in interface XList<E>

Specified by:

shiftBy in interface XOrderingSequence<E>

Specified by:

shiftBy in interface XSortableSequence<E>

Parameters:

sourceIndex - points to the source element; Index of the source element

distance - of how far the element should be moved. Example: 1 moves the element from position 21 to position 22

length - Amount of moved elements.

Returns:

self

swap

public final SynchList<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>

swap

public final SynchList<E> swap(long indexA,
                               long indexB)

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>

toArray

public final Object[] toArray()

Description copied from interface: XGettingCollection

Returns an array containing all of the elements in this collection.

The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.

This method acts as bridge between MicroStream-based collections and Java-native-based APIs.

Specified by:

toArray in interface XGettingCollection<E>

Returns:

an array containing all of the elements in this collection

toArray

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

Description copied from interface: XGettingCollection

Returns a typed array containing all of the elements in this collection.

The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.

This method acts as bridge between MicroStream-based collections and Java-native-based APIs.

Specified by:

toArray in interface XGettingCollection<E>

Parameters:

type - the Class representing type E at runtime.

Returns:

a typed array containing all of the elements in this collection

toReversed

public final SynchList<E> toReversed()

Description copied from interface: XBasicList

Creates a new XBasicList with the reversed order of elements.

This method creates a new collection and does not change the existing collection.
Furthermore changes to the reversed collection do not reflect to the original.

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>

Returns:

new reversed collection

truncate

public final 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>

union

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

Description copied from interface: XGettingCollection

Calls Consumer.accept(Object) on the target Consumer for all the elements of this collection. And calls it for all elements of the other collection, that are not already in this collection (defined by the given Equalator)
Therefore it effectively creates a mathematical union between the two collections.

Since all MicroStream Collections implement the Consumer interface, new collections can be used as target.

Example:

 BulkList<Integer> collection1 = BulkList.New(1,2,3);
 BulkList<Integer> collection2 = BulkList.New(2,3,4);
 BulkList<Integer> union = collection1.union(collection2, Equalator.identity(), BulkList.New());
 

Results in union containing 1, 2, 3 and 4.

Specified by:

union in interface XGettingCollection<E>

Type Parameters:

C - type of the target

Parameters:

other - collection to build a union with.

equalator - which is used for the equal-tests.

target - on which the Consumer.accept(Object) is called for all unified elements.

Returns:

Given target

currentCapacity

public final 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 final 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 final boolean isFull()

Specified by:

isFull in interface CapacityCarrying

Returns:

true if the current capacity cannot be increased any more.

remainingCapacity

public final long remainingCapacity()

Specified by:

remainingCapacity in interface CapacityCarrying

Returns:

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

nullAllowed

public final boolean nullAllowed()

Description copied from interface: ExtendedCollection

Defines if null-elements are allowed inside the collection or not.

Specified by:

nullAllowed in interface ExtendedCollection<E>

Returns:

true if null is allowed inside the collection; false if not

nullContained

public final boolean nullContained()

Specified by:

nullContained in interface XGettingCollection<E>

nullRemove

public final long nullRemove()

Specified by:

nullRemove in interface XRemovingCollection<E>

view

public final ListView<E> view()

Description copied from interface: XGettingCollection

Creates a view of this collection and returns it. It is a read-only collection, which wraps around this collection and only allows read methods.

A view is different from immutable collection (XGettingCollection.immure()) in the way, that changes in this collection are still affecting the view. The immutable collection on the other hand has no reference to this collection and changes therefore do not affect the immutable collection.

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>

Returns:

new read-only collection to view this collection

view

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

Description copied from interface: XGettingSequence

Creates a sub-view of this collection and returns it. It is a read-only collection, which wraps around this collection and only allows read methods.
The view is limited to a range from the lowIndex to the highIndex.

A view is different from immutable collection (XGettingCollection.immure()) in the way, that changes in this collection are still affecting the view. The immutable collection on the other hand has no reference to this collection and changes therefore do not affect the immutable collection.

Specified by:

view in interface XGettingList<E>

Specified by:

view in interface XGettingSequence<E>

Specified by:

view in interface XProcessingSequence<E>

Parameters:

fromIndex - defines lower boundary for the view of the collection.

toIndex - defines higher boundary for the view of the collection.

Returns:

new read-only collection to view a range of elements in this collection

old

public final SynchList.OldSynchList<E> old()

Specified by:

old in interface XGettingCollection<E>

Specified by:

old in interface XGettingList<E>