one.microstream.collections.ListAccessor<E>

All Implemented Interfaces:: Iterable<E>, CapacityCarrying, ExtendedBag<E>, ExtendedCollection<E>, ExtendedList<E>, ExtendedSequence<E>, ReleasingCollection<E>, Sized, Sortable<E>, XGettingBag<E>, XGettingCollection<E>, XGettingList<E>, XGettingSequence<E>, XIndexIterable<E>, XIterable<E>, XJoinable<E>, XOrderingSequence<E>, XReplacingBag<E>, XReplacingCollection<E>, XSettingList<E>, XSettingSequence<E>, XSortableSequence<E>, Copyable

public class ListAccessor<E>
extends Object
implements XSettingList<E>

Wrapper class that reduces the services provided by any wrapped XSettingList to only those of XSettingList, effectively making the wrapped XSettingList instance structural unmodifiable if used through an instance of this class.

All methods declared in XSettingList are transparently passed to the wrapped list.
All structural modifying methods declared in Collection and List (all variations of add~(), remove~() and retain~() as well as clear()) immediately throw an UnsupportedOperationException when called.

This concept can be very useful if a class wants to provide public read and write access to an internal list without either the danger of the list being structurally modified from the outside or the need to copy the whole list on every access.

This is one of many useful concepts that are missing in the JDK Collections Framework and thus so far lead to either inefficient or unneccessary verbose program code (or both).

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class ListAccessor.OldListAccessor<E>

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

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.XIterable
XIterable.Executor<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XReplacingBag
XReplacingBag.Factory<E>

Nested classes/interfaces inherited from interface one.microstream.collections.types.XSettingList
XSettingList.Creator<E>
Constructor Summary

Constructors

Constructor Description

ListAccessor(XSettingList<E> list)

Method Summary

Modifier and Type	Method	Description
`boolean`	`applies(Predicate<? super E> predicate)`	Tests each element of the collection on the given predicate.
`E`	`at(long index)`
`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)`
`ListAccessor<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.
`<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.
`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).
`ListAccessor<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)`
`<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()`	Returns true if the current capacity cannot be increased any more.
`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)`
`boolean`	`nullAllowed()`	Defines if null-elements are allowed inside the collection or not.
`boolean`	`nullContained()`
`ListAccessor.OldListAccessor<E>`	`old()`
`E`	`peek()`	Gets last element or null if the collection is empty.
`E`	`poll()`	Gets first element or null if the collection is empty.
`XSettingList<E>`	`range(long fromIndex, long toIndex)`
`long`	`remainingCapacity()`	Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.
`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)`
`ListAccessor<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)`
`ListAccessor<E>`	`set(long offset, E[] src, int srcIndex, int srcLength)`
`ListAccessor<E>`	`set(long offset, XGettingSequence<? extends E> elements, long elementsOffset, long elementsLength)`
`ListAccessor<E>`	`setAll(long offset, E... elements)`
`void`	`setFirst(E element)`
`E`	`setGet(long index, E element)`
`void`	`setLast(E element)`
`ListAccessor<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.
`ListAccessor<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.
`ListAccessor<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.
`ListAccessor<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()`
`ListAccessor<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)`
`ListAccessor<E>`	`swap(long indexA, long indexB)`
`ListAccessor<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.
`ListAccessor<E>`	`toReversed()`	Creates a new `XGettingSequence` with the reversed order of elements.
`<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 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

Constructor Details
- ListAccessor
  
  public ListAccessor(XSettingList<E> list)
Method Details
- equality
  
  public final Equalator<? super E> equality()
  
  Specified by:
  
  equality in interface XGettingCollection<E>
- 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.
- 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.
- 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>
- 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.
- 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.
- 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 ListAccessor<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 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 XReplacingBag<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
- 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>
  
  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>
  
  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>
  
  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>
  
  Parameters:
  
  target - on which the Consumer.accept(Object) is called for every distinct element of this collection.
  
  Returns:
  
  Given target
- 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
- 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>
  
  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
- fill
  
  public final ListAccessor<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 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
- 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.
- indexOf
  
  public final long indexOf(E element)
  
  Specified by:
  
  indexOf in interface XGettingSequence<E>
- 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>
  
  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
- 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>
- iterator
  
  public final Iterator<E> iterator()
  
  Specified by:
  
  iterator in interface Iterable<E>
  
  Specified by:
  
  iterator in interface XGettingCollection<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>
- 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>
- reverse
  
  public final ListAccessor<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 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 ListAccessor<E> setAll(long offset, E... elements)
  
  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 ListAccessor<E> set(long offset, E[] src, int srcIndex, int srcLength)
  
  Specified by:
  
  set in interface XSettingList<E>
  
  Specified by:
  
  set in interface XSettingSequence<E>
- set
  
  public final ListAccessor<E> set(long offset, XGettingSequence<? extends E> elements, long elementsOffset, long elementsLength)
  
  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>
- size
  
  public final long size()
  
  Specified by:
  
  size in interface Sized
  
  Specified by:
  
  size in interface XGettingCollection<E>
- 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()
  
  Description copied from interface: CapacityCarrying
  
  Returns true if the current capacity cannot be increased any more.
  
  Specified by:
  
  isFull in interface CapacityCarrying
- remainingCapacity
  
  public final 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
- sort
  
  public final ListAccessor<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 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 XSettingList<E> range(long fromIndex, long toIndex)
  
  Specified by:
  
  range in interface XGettingList<E>
  
  Specified by:
  
  range in interface XGettingSequence<E>
  
  Specified by:
  
  range in interface XSettingList<E>
  
  Specified by:
  
  range in interface XSettingSequence<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>
  
  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>
  
  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
- shiftTo
  
  public final ListAccessor<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 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 ListAccessor<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 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 ListAccessor<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 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 ListAccessor<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 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 ListAccessor<E> swap(long indexA, long indexB, long length)
  
  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 ListAccessor<E> swap(long indexA, long indexB)
  
  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>
  
  Returns:
  
  a typed array containing all of the elements in this collection
- toReversed
  
  public final ListAccessor<E> toReversed()
  
  Description copied from interface: XSortableSequence
  
  Creates a new XGettingSequence with the reversed order of elements.
  This method creates a new collection and does not change the existing collection.
  Unlike the XSortableSequence.reverse() method, this method creates a new collection and does not change the existing collection.
  
  Specified by:
  
  toReversed in interface XGettingList<E>
  
  Specified by:
  
  toReversed in interface XGettingSequence<E>
  
  Specified by:
  
  toReversed in interface XSettingList<E>
  
  Specified by:
  
  toReversed in interface XSettingSequence<E>
  
  Specified by:
  
  toReversed in interface XSortableSequence<E>
  
  Returns:
  
  New copy of the collection
- 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>
  
  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
- 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
- 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>
  
  Returns:
  
  an immutable copy of this collection instance.
- old
  
  public final ListAccessor.OldListAccessor<E> old()
  
  Specified by:
  
  old in interface XGettingCollection<E>
  
  Specified by:
  
  old in interface XGettingList<E>

Class ListAccessor<E>

Nested Class Summary

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

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

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

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

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

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

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

Constructor Details

Method Details