All Superinterfaces:

CapacityCarrying, Copyable, ExtendedBag<E>, ExtendedCollection<E>, ExtendedList<E>, ExtendedSequence<E>, Iterable<E>, Referencing<E>, Sized, XGettingBag<E>, XGettingCollection<E>, XGettingEnum<E>, XGettingList<E>, XGettingSequence<E>, XGettingSet<E>, XIndexIterable<E>, XIterable<E>, XJoinable<E>

All Known Subinterfaces:

XReference<E>

All Known Implementing Classes:

Constant, LinkingReferencing.Default, LinkReference.Default, Single, Singleton, SingletonView
```
public interface XReferencing<E>
extends XGettingList<E>, XGettingEnum<E>, Referencing<E>
```

Nested Class Summary
- Nested classes/interfaces inherited from interface one.microstream.typing.Copyable
  Copyable.Static
- Nested classes/interfaces inherited from interface one.microstream.collections.interfaces.ExtendedCollection
  ExtendedCollection.Creator<E,C extends ExtendedCollection<E>>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingCollection
  XGettingCollection.Creator<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingEnum
  XGettingEnum.Creator<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingList
  XGettingList.Factory<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XGettingSequence
  XGettingSequence.Factory<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable
  XIterable.Executor<E>

Method Summary

Modifier and Type	Method	Description
`boolean`	`applies(Predicate<? super E> predicate)`
`E`	`at(long index)`
`boolean`	`contains(E element)`
`boolean`	`containsAll(XGettingCollection<? extends E> elements)`
`boolean`	`containsId(E element)`	Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic. This method has the same behavior as `XGettingCollection.containsSearched(Predicate)` with a `Predicate` implementation that checks for object identity.
`boolean`	`containsSearched(Predicate<? super E> predicate)`
`XReferencing<E>`	`copy()`	Creates a true copy of this list which references th same elements in the same order as this list does at the time the method is called.
`<T extends Consumer<? super E>> T`	`copySelection(T target, long... indices)`
`<T extends Consumer<? super E>> T`	`copyTo(T target)`
`long`	`count(E element)`
`long`	`countBy(Predicate<? super E> predicate)`
`<T extends Consumer<? super E>> T`	`distinct(T target)`
`<T extends Consumer<? super E>> T`	`distinct(T target, Equalator<? super E> equalator)`
`Equalator<? super E>`	`equality()`
`boolean`	`equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)`	Returns `true` if the passed collection is of the same type as this collection and`this.equalsContent(list, equalator)` yields `true`.
`boolean`	`equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)`	Returns `true` if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.
`<T extends Consumer<? super E>> T`	`except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)`
`<T extends Consumer<? super E>> T`	`filterTo(T target, Predicate<? super E> predicate)`
`E`	`first()`
`E`	`get()`	Gets the first element in the collection.
`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.
`Constant<E>`	`immure()`	Provides an instance of an immutable collection type with equal behavior and data as this instance.
`long`	`indexBy(Predicate<? super E> predicate)`
`long`	`indexOf(E element)`
`<T extends Consumer<? super E>> T`	`intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)`
`boolean`	`isEmpty()`
`boolean`	`isFull()`	Returns true if the current capacity cannot be increased any more.
`boolean`	`isSorted(Comparator<? super E> comparator)`
`Iterator<E>`	`iterator()`
`E`	`last()`
`long`	`lastIndexBy(Predicate<? super E> predicate)`
`long`	`lastIndexOf(E element)`
`ListIterator<E>`	`listIterator()`
`ListIterator<E>`	`listIterator(long index)`
`E`	`max(Comparator<? super E> comparator)`
`long`	`maximumCapacity()`	Returns the maximum amount of elements this carrier instance can contain. The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g.
`long`	`maxIndex(Comparator<? super E> comparator)`
`E`	`min(Comparator<? super E> comparator)`
`long`	`minIndex(Comparator<? super E> comparator)`
`boolean`	`nullAllowed()`
`boolean`	`nullContained()`
`OldList<E>`	`old()`
`E`	`peek()`
`E`	`poll()`
`XReferencing<E>`	`range(long fromIndex, long toIndex)`
`long`	`remainingCapacity()`	Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.
`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)`
`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.
`long`	`size()`
`Object[]`	`toArray()`
`E[]`	`toArray(Class<E> type)`
`XReferencing<E>`	`toReversed()`
`<T extends Consumer<? super E>> T`	`union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)`
`XReferencing<E>`	`view()`
`XReferencing<E>`	`view(long lowIndex, long highIndex)`

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface one.microstream.collections.types.XGettingCollection
equals, hashCode, intSize, join

Methods inherited from interface one.microstream.collections.types.XGettingEnum
iterate

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

Methods inherited from interface one.microstream.collections.types.XIndexIterable
iterateIndexed

- Method Detail
  - get
```
E get()
```
    Description copied from interface: XGettingSequence
    
    Gets the first element in the collection. This is a parameterless alias vor at(0).
    first() is an alias for this method for consistency reasons with last().
    
    Specified by:
    
    get in interface Referencing<E>
    
    Specified by:
    
    get in interface XGettingCollection<E>
    
    Specified by:
    
    get in interface XGettingSequence<E>
    
    Returns:
    
    the first element.
    
    See Also:
    
    XGettingSequence.at(long), XGettingSequence.first(), XGettingSequence.last()
  - at
```
E at(long index)
```
    Specified by:
    
    at in interface XGettingSequence<E>
  - first
```
E first()
```
    Specified by:
    
    first in interface XGettingSequence<E>
  - last
```
E last()
```
    Specified by:
    
    last in interface XGettingSequence<E>
  - poll
```
E poll()
```
    Specified by:
    
    poll in interface XGettingSequence<E>
  - peek
```
E peek()
```
    Specified by:
    
    peek in interface XGettingSequence<E>
  - maxIndex
```
long maxIndex(Comparator<? super E> comparator)
```
    Specified by:
    
    maxIndex in interface XGettingSequence<E>
  - minIndex
```
long minIndex(Comparator<? super E> comparator)
```
    Specified by:
    
    minIndex in interface XGettingSequence<E>
  - indexOf
```
long indexOf(E element)
```
    Specified by:
    
    indexOf in interface XGettingSequence<E>
  - indexBy
```
long indexBy(Predicate<? super E> predicate)
```
    Specified by:
    
    indexBy in interface XGettingSequence<E>
  - lastIndexOf
```
long lastIndexOf(E element)
```
    Specified by:
    
    lastIndexOf in interface XGettingSequence<E>
  - lastIndexBy
```
long lastIndexBy(Predicate<? super E> predicate)
```
    Specified by:
    
    lastIndexBy in interface XGettingSequence<E>
  - scan
```
long scan(Predicate<? super E> predicate)
```
    Description copied from interface: XGettingSequence
    
    Iterates through the collection and returns the index of the last element that the passed Predicateapplied to ("scanning").
    
    Specified by:
    
    scan in interface XGettingSequence<E>
    
    Returns:
    
    the index of the last positively tested element.
  - isSorted
```
boolean isSorted(Comparator<? super E> comparator)
```
    Specified by:
    
    isSorted in interface XGettingSequence<E>
  - copySelection
```
<T extends Consumer<? super E>> T copySelection(T target,
                                                long... indices)
```
    Specified by:
    
    copySelection in interface XGettingSequence<E>
  - iterator
```
Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface XGettingCollection<E>
  - toArray
```
Object[] toArray()
```
    Specified by:
    
    toArray in interface XGettingCollection<E>
  - hasVolatileElements
```
boolean hasVolatileElements()
```
    Description copied from interface: XGettingCollection
    
    Tells if this collection contains volatile elements.
    An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. Examples are WeakReference of SoftReference or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
    Note that WeakReference instances that are added to a a simple (non-volatile) implementation of a collection do NOT make the collection volatile, as the elements themselves (the reference instances) are still strongly referenced.
    
    Specified by:
    
    hasVolatileElements in interface ExtendedCollection<E>
    
    Specified by:
    
    hasVolatileElements in interface XGettingCollection<E>
    
    Returns:
    
    true if the collection contains volatile elements.
  - size
```
long size()
```
    Specified by:
    
    size in interface Sized
    
    Specified by:
    
    size in interface XGettingCollection<E>
  - isEmpty
```
boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Sized
  - equality
```
Equalator<? super E> equality()
```
    Specified by:
    
    equality in interface XGettingCollection<E>
  - toArray
```
E[] toArray(Class<E> type)
```
    Specified by:
    
    toArray in interface XGettingCollection<E>
  - equals
```
boolean equals(XGettingCollection<? extends E> samples,
               Equalator<? super E> equalator)
```
    Description copied from interface: XGettingCollection
    
    Returns true if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator) yields true.
    
    Specified by:
    
    equals in interface XGettingCollection<E>
  - equalsContent
```
boolean equalsContent(XGettingCollection<? extends E> samples,
                      Equalator<? super E> equalator)
```
    Description copied from interface: XGettingCollection
    
    Returns true if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.
    Note that for colletion types that don't have a defined order of elements, this method is hardly usable (as is XGettingCollection.equals(Object) for them as defined in Collection). The core problem of comparing collections that have no defined order is that they aren't really reliably comparable to any other collection.
    
    Specified by:
    
    equalsContent in interface XGettingCollection<E>
    
    equalator - the equalator to use to determine the equality of each element
    
    Returns:
    
    true if this list is equal to the passed list, false otherwise
  - nullContained
```
boolean nullContained()
```
    Specified by:
    
    nullContained in interface XGettingCollection<E>
  - containsId
```
boolean containsId(E element)
```
    Description copied from interface: XGettingCollection
    
    Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic.
    This method has the same behavior as XGettingCollection.containsSearched(Predicate) with a Predicate implementation that checks for object identity. The only difference is a performance and usability advantage
    
    Specified by:
    
    containsId in interface XGettingCollection<E>
    
    Parameters:
    
    element - the element to be searched in the collection by identity.
    
    Returns:
    
    whether this collection contains exactely the given element.
  - contains
```
boolean contains(E element)
```
    Specified by:
    
    contains in interface XGettingCollection<E>
  - containsSearched
```
boolean containsSearched(Predicate<? super E> predicate)
```
    Specified by:
    
    containsSearched in interface XGettingCollection<E>
  - containsAll
```
boolean containsAll(XGettingCollection<? extends E> elements)
```
    Specified by:
    
    containsAll in interface XGettingCollection<E>
  - applies
```
boolean applies(Predicate<? super E> predicate)
```
    Specified by:
    
    applies in interface XGettingCollection<E>
  - count
```
long count(E element)
```
    Specified by:
    
    count in interface XGettingCollection<E>
  - countBy
```
long countBy(Predicate<? super E> predicate)
```
    Specified by:
    
    countBy in interface XGettingCollection<E>
  - search
```
E search(Predicate<? super E> predicate)
```
    Specified by:
    
    search in interface XGettingCollection<E>
  - seek
```
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>
  - max
```
E max(Comparator<? super E> comparator)
```
    Specified by:
    
    max in interface XGettingCollection<E>
  - min
```
E min(Comparator<? super E> comparator)
```
    Specified by:
    
    min in interface XGettingCollection<E>
  - distinct
```
<T extends Consumer<? super E>> T distinct(T target)
```
    Specified by:
    
    distinct in interface XGettingCollection<E>
  - distinct
```
<T extends Consumer<? super E>> T distinct(T target,
                                           Equalator<? super E> equalator)
```
    Specified by:
    
    distinct in interface XGettingCollection<E>
  - copyTo
```
<T extends Consumer<? super E>> T copyTo(T target)
```
    Specified by:
    
    copyTo in interface XGettingCollection<E>
  - filterTo
```
<T extends Consumer<? super E>> T filterTo(T target,
                                           Predicate<? super E> predicate)
```
    Specified by:
    
    filterTo in interface XGettingCollection<E>
  - union
```
<T extends Consumer<? super E>> T union(XGettingCollection<? extends E> other,
                                        Equalator<? super E> equalator,
                                        T target)
```
    Specified by:
    
    union in interface XGettingCollection<E>
  - intersect
```
<T extends Consumer<? super E>> T intersect(XGettingCollection<? extends E> other,
                                            Equalator<? super E> equalator,
                                            T target)
```
    Specified by:
    
    intersect in interface XGettingCollection<E>
  - except
```
<T extends Consumer<? super E>> T except(XGettingCollection<? extends E> other,
                                         Equalator<? super E> equalator,
                                         T target)
```
    Specified by:
    
    except in interface XGettingCollection<E>
  - nullAllowed
```
boolean nullAllowed()
```
    Specified by:
    
    nullAllowed in interface ExtendedCollection<E>
  - maximumCapacity
```
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.
  - remainingCapacity
```
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
  - isFull
```
boolean isFull()
```
    Description copied from interface: CapacityCarrying
    
    Returns true if the current capacity cannot be increased any more.
    
    Specified by:
    
    isFull in interface CapacityCarrying
  - immure
```
Constant<E> immure()
```
    Description copied from interface: XGettingList
    
    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 XGettingEnum<E>
    
    Specified by:
    
    immure in interface XGettingList<E>
    
    Specified by:
    
    immure in interface XGettingSequence<E>
    
    Specified by:
    
    immure in interface XGettingSet<E>
    
    Returns:
    
    an immutable copy of this collection instance.
  - listIterator
```
ListIterator<E> listIterator()
```
    Specified by:
    
    listIterator in interface XGettingList<E>
  - listIterator
```
ListIterator<E> listIterator(long index)
```
    Specified by:
    
    listIterator in interface XGettingList<E>
  - old
```
OldList<E> old()
```
    Specified by:
    
    old in interface XGettingCollection<E>
    
    Specified by:
    
    old in interface XGettingList<E>
  - copy
```
XReferencing<E> copy()
```
    Description copied from interface: XGettingSequence
    
    Creates a true copy of this list which references th same elements in the same order as this list does at the time the method is called. The elements themselves are NOT copied (no deep copying).
    The type of the returned list is the same as of this list if possible (i.e.: a SubList can not meaningful return a true copy that references its elements but still is a SubList)
    
    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 XGettingEnum<E>
    
    Specified by:
    
    copy in interface XGettingList<E>
    
    Specified by:
    
    copy in interface XGettingSequence<E>
    
    Specified by:
    
    copy in interface XGettingSet<E>
    
    Returns:
    
    a copy of this list
  - toReversed
```
XReferencing<E> toReversed()
```
    Specified by:
    
    toReversed in interface XGettingEnum<E>
    
    Specified by:
    
    toReversed in interface XGettingList<E>
    
    Specified by:
    
    toReversed in interface XGettingSequence<E>
  - view
```
XReferencing<E> view()
```
    Specified by:
    
    view in interface XGettingBag<E>
    
    Specified by:
    
    view in interface XGettingCollection<E>
    
    Specified by:
    
    view in interface XGettingEnum<E>
    
    Specified by:
    
    view in interface XGettingList<E>
    
    Specified by:
    
    view in interface XGettingSequence<E>
  - view
```
XReferencing<E> view(long lowIndex,
                     long highIndex)
```
    Specified by:
    
    view in interface XGettingEnum<E>
    
    Specified by:
    
    view in interface XGettingList<E>
    
    Specified by:
    
    view in interface XGettingSequence<E>
  - range
```
XReferencing<E> range(long fromIndex,
                      long toIndex)
```
    Specified by:
    
    range in interface XGettingEnum<E>
    
    Specified by:
    
    range in interface XGettingList<E>
    
    Specified by:
    
    range in interface XGettingSequence<E>

Interface XReferencing<E>

Nested Class Summary

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

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

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

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

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

Method Summary

Methods inherited from interface java.lang.Iterable

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

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

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

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

Method Detail

get

at

first

last

poll

peek

maxIndex

minIndex

indexOf

indexBy

lastIndexOf

lastIndexBy

scan

isSorted

copySelection

iterator

toArray

hasVolatileElements

size

isEmpty

equality

toArray

equals

equalsContent

nullContained

containsId

contains

containsSearched

containsAll

applies

count

countBy

search

seek

max

min

distinct

distinct

copyTo

filterTo

union

intersect

except

nullAllowed

maximumCapacity

remainingCapacity

isFull

immure

listIterator

listIterator

old

copy

toReversed

view

view

range