java.lang.Object
- one.microstream.collections.Singleton<E>

Type Parameters:

E -

All Implemented Interfaces:

Iterable<E>, Consumer<E>, CapacityCarrying, ExtendedBag<E>, ExtendedCollection<E>, ExtendedList<E>, ExtendedSequence<E>, ReleasingCollection<E>, Sized, Sortable<E>, XGettingBag<E>, XGettingCollection<E>, XGettingEnum<E>, XGettingList<E>, XGettingSequence<E>, XGettingSet<E>, XIndexIterable<E>, XIterable<E>, XJoinable<E>, XOrderingEnum<E>, XOrderingSequence<E>, XReference<E>, XReferencing<E>, XReplacingBag<E>, XReplacingCollection<E>, XSettingList<E>, XSettingSequence<E>, XSortableEnum<E>, XSortableSequence<E>, Reference<E>, Referencing<E>, Copyable

Direct Known Subclasses:

LinkReference.Default
```
public class Singleton<E>
extends Object
implements XReference<E>
```
Singleton dummy collection used to pass a single instance masked as a collection.
As there is always only one element, this type can be a List and a Set (Enum) at the same time, enabling it to be used in any type situation.

See Also:

Constant

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>
- 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>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XSortableEnum
  XSortableEnum.Creator<E>

Constructor Summary

Constructors
Constructor Description

Singleton(E element)

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)`
`Singleton<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)`
`Singleton<E>`	`fill(long offset, long length, E element)`
`<T extends Consumer<? super E>> T`	`filterTo(T target, Predicate<? super E> predicate)`
`E`	`first()`
`E`	`get()`	Convenience alias for `first()`.
`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)`
`<P extends Consumer<? super E>> P`	`iterate(P procedure)`
`<P extends IndexedAcceptor<? super E>> P`	`iterateIndexed(P procedure)`
`Iterator<E>`	`iterator()`
`<A> A`	`join(BiConsumer<? super E,? super A> joiner, A aggregate)`
`E`	`last()`
`long`	`lastIndexBy(Predicate<? super E> predicate)`
`long`	`lastIndexOf(E element)`
`ListIterator<E>`	`listIterator()`
`ListIterator<E>`	`listIterator(long index)`
`E`	`max(Comparator<? super E> comparator)`
`long`	`maximumCapacity()`	Returns the maximum amount of elements this carrier instance can contain. The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g.
`long`	`maxIndex(Comparator<? super E> comparator)`
`E`	`min(Comparator<? super E> comparator)`
`long`	`minIndex(Comparator<? super E> comparator)`
`boolean`	`nullAllowed()`
`boolean`	`nullContained()`
`one.microstream.collections.Singleton.OldSingleton`	`old()`
`E`	`peek()`
`E`	`poll()`
`Singleton<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)`
`boolean`	`replaceOne(Predicate<? super E> predicate, E substitute)`
`Singleton<E>`	`reverse()`
`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.
`boolean`	`set(long index, E element)`
`Singleton<E>`	`set(long index, E[] elements, int offset, int length)`
`Singleton<E>`	`set(long index, XGettingSequence<? extends E> elements, long offset, long length)`
`void`	`set(E element)`
`Singleton<E>`	`setAll(long index, E... elements)`
`void`	`setFirst(E element)`
`E`	`setGet(long index, E element)`
`void`	`setLast(E element)`
`Singleton<E>`	`shiftBy(long sourceIndex, long distance)`
`Singleton<E>`	`shiftBy(long sourceIndex, long distance, long length)`
`Singleton<E>`	`shiftTo(long sourceIndex, long targetIndex)`
`Singleton<E>`	`shiftTo(long sourceIndex, long targetIndex, long length)`
`long`	`size()`
`Singleton<E>`	`sort(Comparator<? super E> comparator)`
`long`	`substitute(Function<? super E,? extends E> mapper)`
`long`	`substitute(Predicate<? super E> predicate, Function<E,E> mapper)`
`Singleton<E>`	`swap(long indexA, long indexB)`
`Singleton<E>`	`swap(long indexA, long indexB, long length)`
`Object[]`	`toArray()`
`E[]`	`toArray(Class<E> type)`
`Singleton<E>`	`toReversed()`
`<T extends Consumer<? super E>> T`	`union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)`
`SingletonView<E>`	`view()`
`SingletonView<E>`	`view(long lowIndex, long highIndex)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Consumer
andThen

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

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

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

Methods inherited from interface one.microstream.collections.types.XReference
accept

- Constructor Detail
  - Singleton
```
public Singleton(E element)
```
- Method Detail
  - get
```
public final E get()
```
    Convenience alias for first().
    
    Specified by:
    
    get in interface Referencing<E>
    
    Specified by:
    
    get in interface XGettingCollection<E>
    
    Specified by:
    
    get in interface XGettingSequence<E>
    
    Specified by:
    
    get in interface XReferencing<E>
    
    Returns:
    
    the contained element.
    
    See Also:
    
    XGettingSequence.at(long), XGettingSequence.first(), XGettingSequence.last()
  - copy
```
public final Singleton<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>
    
    Specified by:
    
    copy in interface XReference<E>
    
    Specified by:
    
    copy in interface XReferencing<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 XSortableEnum<E>
    
    Specified by:
    
    copy in interface XSortableSequence<E>
    
    Returns:
    
    a copy of this list
  - iterate
```
public final <P extends Consumer<? super E>> P iterate(P procedure)
```
    Specified by:
    
    iterate in interface XGettingEnum<E>
    
    Specified by:
    
    iterate in interface XGettingSet<E>
    
    Specified by:
    
    iterate in interface XIterable<E>
  - join
```
public final <A> A join(BiConsumer<? super E,? super A> joiner,
                        A aggregate)
```
    Specified by:
    
    join in interface XGettingCollection<E>
    
    Specified by:
    
    join in interface XJoinable<E>
  - iterateIndexed
```
public final <P extends IndexedAcceptor<? super E>> P iterateIndexed(P procedure)
```
    Specified by:
    
    iterateIndexed in interface XIndexIterable<E>
  - immure
```
public final 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>
    
    Specified by:
    
    immure in interface XReference<E>
    
    Specified by:
    
    immure in interface XReferencing<E>
    
    Returns:
    
    an immutable copy of this collection instance.
  - listIterator
```
public final ListIterator<E> listIterator()
```
    Specified by:
    
    listIterator in interface XGettingList<E>
    
    Specified by:
    
    listIterator in interface XReference<E>
    
    Specified by:
    
    listIterator in interface XReferencing<E>
  - listIterator
```
public final ListIterator<E> listIterator(long index)
```
    Specified by:
    
    listIterator in interface XGettingList<E>
    
    Specified by:
    
    listIterator in interface XReference<E>
    
    Specified by:
    
    listIterator in interface XReferencing<E>
  - old
```
public final one.microstream.collections.Singleton.OldSingleton old()
```
    Specified by:
    
    old in interface XGettingCollection<E>
    
    Specified by:
    
    old in interface XGettingList<E>
    
    Specified by:
    
    old in interface XReference<E>
    
    Specified by:
    
    old in interface XReferencing<E>
  - range
```
public final Singleton<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>
    
    Specified by:
    
    range in interface XReference<E>
    
    Specified by:
    
    range in interface XReferencing<E>
    
    Specified by:
    
    range in interface XSettingList<E>
    
    Specified by:
    
    range in interface XSettingSequence<E>
  - toReversed
```
public final Singleton<E> toReversed()
```
    Specified by:
    
    toReversed in interface XGettingEnum<E>
    
    Specified by:
    
    toReversed in interface XGettingList<E>
    
    Specified by:
    
    toReversed in interface XGettingSequence<E>
    
    Specified by:
    
    toReversed in interface XReference<E>
    
    Specified by:
    
    toReversed in interface XReferencing<E>
    
    Specified by:
    
    toReversed in interface XSettingList<E>
    
    Specified by:
    
    toReversed in interface XSettingSequence<E>
    
    Specified by:
    
    toReversed in interface XSortableEnum<E>
    
    Specified by:
    
    toReversed in interface XSortableSequence<E>
  - copySelection
```
public final <T extends Consumer<? super E>> T copySelection(T target,
                                                             long... indices)
```
    Specified by:
    
    copySelection in interface XGettingSequence<E>
    
    Specified by:
    
    copySelection in interface XReference<E>
    
    Specified by:
    
    copySelection in interface XReferencing<E>
  - first
```
public final E first()
```
    Specified by:
    
    first in interface XGettingSequence<E>
    
    Specified by:
    
    first in interface XReference<E>
    
    Specified by:
    
    first in interface XReferencing<E>
  - at
```
public final E at(long index)
```
    Specified by:
    
    at in interface XGettingSequence<E>
    
    Specified by:
    
    at in interface XReference<E>
    
    Specified by:
    
    at in interface XReferencing<E>
  - indexOf
```
public final long indexOf(E element)
```
    Specified by:
    
    indexOf in interface XGettingSequence<E>
    
    Specified by:
    
    indexOf in interface XReference<E>
    
    Specified by:
    
    indexOf in interface XReferencing<E>
  - indexBy
```
public final long indexBy(Predicate<? super E> predicate)
```
    Specified by:
    
    indexBy in interface XGettingSequence<E>
    
    Specified by:
    
    indexBy in interface XReference<E>
    
    Specified by:
    
    indexBy in interface XReferencing<E>
  - isSorted
```
public final boolean isSorted(Comparator<? super E> comparator)
```
    Specified by:
    
    isSorted in interface XGettingSequence<E>
    
    Specified by:
    
    isSorted in interface XReference<E>
    
    Specified by:
    
    isSorted in interface XReferencing<E>
  - last
```
public final E last()
```
    Specified by:
    
    last in interface XGettingSequence<E>
    
    Specified by:
    
    last in interface XReference<E>
    
    Specified by:
    
    last in interface XReferencing<E>
  - lastIndexOf
```
public final long lastIndexOf(E element)
```
    Specified by:
    
    lastIndexOf in interface XGettingSequence<E>
    
    Specified by:
    
    lastIndexOf in interface XReference<E>
    
    Specified by:
    
    lastIndexOf in interface XReferencing<E>
  - lastIndexBy
```
public final long lastIndexBy(Predicate<? super E> predicate)
```
    Specified by:
    
    lastIndexBy in interface XGettingSequence<E>
    
    Specified by:
    
    lastIndexBy in interface XReference<E>
    
    Specified by:
    
    lastIndexBy in interface XReferencing<E>
  - maxIndex
```
public final long maxIndex(Comparator<? super E> comparator)
```
    Specified by:
    
    maxIndex in interface XGettingSequence<E>
    
    Specified by:
    
    maxIndex in interface XReference<E>
    
    Specified by:
    
    maxIndex in interface XReferencing<E>
  - minIndex
```
public final long minIndex(Comparator<? super E> comparator)
```
    Specified by:
    
    minIndex in interface XGettingSequence<E>
    
    Specified by:
    
    minIndex in interface XReference<E>
    
    Specified by:
    
    minIndex in interface XReferencing<E>
  - peek
```
public final E peek()
```
    Specified by:
    
    peek in interface XGettingSequence<E>
    
    Specified by:
    
    peek in interface XReference<E>
    
    Specified by:
    
    peek in interface XReferencing<E>
  - poll
```
public final E poll()
```
    Specified by:
    
    poll in interface XGettingSequence<E>
    
    Specified by:
    
    poll in interface XReference<E>
    
    Specified by:
    
    poll in interface XReferencing<E>
  - 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 Predicateapplied to ("scanning").
    
    Specified by:
    
    scan in interface XGettingSequence<E>
    
    Specified by:
    
    scan in interface XReference<E>
    
    Specified by:
    
    scan in interface XReferencing<E>
    
    Returns:
    
    the index of the last positively tested element.
  - view
```
public final SingletonView<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>
    
    Specified by:
    
    view in interface XReference<E>
    
    Specified by:
    
    view in interface XReferencing<E>
  - view
```
public final SingletonView<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>
    
    Specified by:
    
    view in interface XReference<E>
    
    Specified by:
    
    view in interface XReferencing<E>
  - containsSearched
```
public final boolean containsSearched(Predicate<? super E> predicate)
```
    Specified by:
    
    containsSearched in interface XGettingCollection<E>
    
    Specified by:
    
    containsSearched in interface XReference<E>
    
    Specified by:
    
    containsSearched in interface XReferencing<E>
  - applies
```
public final boolean applies(Predicate<? super E> predicate)
```
    Specified by:
    
    applies in interface XGettingCollection<E>
    
    Specified by:
    
    applies in interface XReference<E>
    
    Specified by:
    
    applies in interface XReferencing<E>
  - contains
```
public final boolean contains(E element)
```
    Specified by:
    
    contains in interface XGettingCollection<E>
    
    Specified by:
    
    contains in interface XReference<E>
    
    Specified by:
    
    contains in interface XReferencing<E>
  - containsAll
```
public final boolean containsAll(XGettingCollection<? extends E> elements)
```
    Specified by:
    
    containsAll in interface XGettingCollection<E>
    
    Specified by:
    
    containsAll in interface XReference<E>
    
    Specified by:
    
    containsAll in interface XReferencing<E>
  - 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>
    
    Specified by:
    
    containsId in interface XReference<E>
    
    Specified by:
    
    containsId in interface XReferencing<E>
    
    Parameters:
    
    element - the element to be searched in the collection by identity.
    
    Returns:
    
    whether this collection contains exactely the given element.
  - copyTo
```
public final <T extends Consumer<? super E>> T copyTo(T target)
```
    Specified by:
    
    copyTo in interface XGettingCollection<E>
    
    Specified by:
    
    copyTo in interface XReference<E>
    
    Specified by:
    
    copyTo in interface XReferencing<E>
  - filterTo
```
public final <T extends Consumer<? super E>> T filterTo(T target,
                                                        Predicate<? super E> predicate)
```
    Specified by:
    
    filterTo in interface XGettingCollection<E>
    
    Specified by:
    
    filterTo in interface XReference<E>
    
    Specified by:
    
    filterTo in interface XReferencing<E>
  - count
```
public final long count(E element)
```
    Specified by:
    
    count in interface XGettingCollection<E>
    
    Specified by:
    
    count in interface XReference<E>
    
    Specified by:
    
    count in interface XReferencing<E>
  - countBy
```
public final long countBy(Predicate<? super E> predicate)
```
    Specified by:
    
    countBy in interface XGettingCollection<E>
    
    Specified by:
    
    countBy in interface XReference<E>
    
    Specified by:
    
    countBy in interface XReferencing<E>
  - distinct
```
public final <T extends Consumer<? super E>> T distinct(T target)
```
    Specified by:
    
    distinct in interface XGettingCollection<E>
    
    Specified by:
    
    distinct in interface XReference<E>
    
    Specified by:
    
    distinct in interface XReferencing<E>
  - distinct
```
public final <T extends Consumer<? super E>> T distinct(T target,
                                                        Equalator<? super E> equalator)
```
    Specified by:
    
    distinct in interface XGettingCollection<E>
    
    Specified by:
    
    distinct in interface XReference<E>
    
    Specified by:
    
    distinct in interface XReferencing<E>
  - equality
```
public final Equalator<? super E> equality()
```
    Specified by:
    
    equality in interface XGettingCollection<E>
    
    Specified by:
    
    equality in interface XReference<E>
    
    Specified by:
    
    equality in interface XReferencing<E>
  - equals
```
public final 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>
    
    Specified by:
    
    equals in interface XReference<E>
    
    Specified by:
    
    equals in interface XReferencing<E>
  - 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>
    
    Specified by:
    
    equalsContent in interface XReference<E>
    
    Specified by:
    
    equalsContent in interface XReferencing<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
  - except
```
public final <T extends Consumer<? super E>> T except(XGettingCollection<? extends E> other,
                                                      Equalator<? super E> equalator,
                                                      T target)
```
    Specified by:
    
    except in interface XGettingCollection<E>
    
    Specified by:
    
    except in interface XReference<E>
    
    Specified by:
    
    except in interface XReferencing<E>
  - hasVolatileElements
```
public final 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>
    
    Specified by:
    
    hasVolatileElements in interface XReference<E>
    
    Specified by:
    
    hasVolatileElements in interface XReferencing<E>
    
    Returns:
    
    true if the collection contains volatile elements.
  - intersect
```
public final <T extends Consumer<? super E>> T intersect(XGettingCollection<? extends E> other,
                                                         Equalator<? super E> equalator,
                                                         T target)
```
    Specified by:
    
    intersect in interface XGettingCollection<E>
    
    Specified by:
    
    intersect in interface XReference<E>
    
    Specified by:
    
    intersect in interface XReferencing<E>
  - isEmpty
```
public final boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Sized
    
    Specified by:
    
    isEmpty in interface XReference<E>
    
    Specified by:
    
    isEmpty in interface XReferencing<E>
  - iterator
```
public Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface XGettingCollection<E>
    
    Specified by:
    
    iterator in interface XReference<E>
    
    Specified by:
    
    iterator in interface XReferencing<E>
  - max
```
public final E max(Comparator<? super E> comparator)
```
    Specified by:
    
    max in interface XGettingCollection<E>
    
    Specified by:
    
    max in interface XReference<E>
    
    Specified by:
    
    max in interface XReferencing<E>
  - min
```
public final E min(Comparator<? super E> comparator)
```
    Specified by:
    
    min in interface XGettingCollection<E>
    
    Specified by:
    
    min in interface XReference<E>
    
    Specified by:
    
    min in interface XReferencing<E>
  - nullContained
```
public final boolean nullContained()
```
    Specified by:
    
    nullContained in interface XGettingCollection<E>
    
    Specified by:
    
    nullContained in interface XReference<E>
    
    Specified by:
    
    nullContained in interface XReferencing<E>
  - 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>
    
    Specified by:
    
    seek in interface XReference<E>
    
    Specified by:
    
    seek in interface XReferencing<E>
  - search
```
public final E search(Predicate<? super E> predicate)
```
    Specified by:
    
    search in interface XGettingCollection<E>
    
    Specified by:
    
    search in interface XReference<E>
    
    Specified by:
    
    search in interface XReferencing<E>
  - size
```
public final long size()
```
    Specified by:
    
    size in interface Sized
    
    Specified by:
    
    size in interface XGettingCollection<E>
    
    Specified by:
    
    size in interface XReference<E>
    
    Specified by:
    
    size in interface XReferencing<E>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface XGettingCollection<E>
    
    Specified by:
    
    toArray in interface XReference<E>
    
    Specified by:
    
    toArray in interface XReferencing<E>
  - toArray
```
public E[] toArray(Class<E> type)
```
    Specified by:
    
    toArray in interface XGettingCollection<E>
    
    Specified by:
    
    toArray in interface XReference<E>
    
    Specified by:
    
    toArray in interface XReferencing<E>
  - union
```
public final <T extends Consumer<? super E>> T union(XGettingCollection<? extends E> other,
                                                     Equalator<? super E> equalator,
                                                     T target)
```
    Specified by:
    
    union in interface XGettingCollection<E>
    
    Specified by:
    
    union in interface XReference<E>
    
    Specified by:
    
    union in interface XReferencing<E>
  - nullAllowed
```
public final boolean nullAllowed()
```
    Specified by:
    
    nullAllowed in interface ExtendedCollection<E>
    
    Specified by:
    
    nullAllowed in interface XReference<E>
    
    Specified by:
    
    nullAllowed in interface XReferencing<E>
  - 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
    
    Specified by:
    
    remainingCapacity in interface XReference<E>
    
    Specified by:
    
    remainingCapacity in interface XReferencing<E>
  - 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
    
    Specified by:
    
    isFull in interface XReference<E>
    
    Specified by:
    
    isFull in interface XReferencing<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
    
    Specified by:
    
    maximumCapacity in interface XReference<E>
    
    Specified by:
    
    maximumCapacity in interface XReferencing<E>
    
    Returns:
    
    the maximum amount of elements this carrier instance can contain.
  - replaceOne
```
public final boolean replaceOne(E element,
                                E replacement)
```
    Specified by:
    
    replaceOne in interface XReference<E>
    
    Specified by:
    
    replaceOne in interface XReplacingBag<E>
  - replace
```
public final long replace(E element,
                          E replacement)
```
    Specified by:
    
    replace in interface XReference<E>
    
    Specified by:
    
    replace in interface XReplacingBag<E>
  - replaceAll
```
public final long replaceAll(XGettingCollection<? extends E> elements,
                             E replacement)
```
    Specified by:
    
    replaceAll in interface XReference<E>
    
    Specified by:
    
    replaceAll in interface XReplacingBag<E>
  - replaceOne
```
public final boolean replaceOne(Predicate<? super E> predicate,
                                E substitute)
```
    Specified by:
    
    replaceOne in interface XReference<E>
    
    Specified by:
    
    replaceOne in interface XReplacingBag<E>
  - replace
```
public final long replace(Predicate<? super E> predicate,
                          E substitute)
```
    Specified by:
    
    replace in interface XReference<E>
    
    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>
  - set
```
public final boolean set(long index,
                         E element)
```
    Specified by:
    
    set in interface XReference<E>
    
    Specified by:
    
    set in interface XSettingSequence<E>
  - setGet
```
public final E setGet(long index,
                      E element)
```
    Specified by:
    
    setGet in interface XReference<E>
    
    Specified by:
    
    setGet in interface XSettingSequence<E>
  - setFirst
```
public final void setFirst(E element)
```
    Specified by:
    
    setFirst in interface XReference<E>
    
    Specified by:
    
    setFirst in interface XSettingSequence<E>
  - setLast
```
public final void setLast(E element)
```
    Specified by:
    
    setLast in interface XReference<E>
    
    Specified by:
    
    setLast in interface XSettingSequence<E>
  - shiftTo
```
public final Singleton<E> shiftTo(long sourceIndex,
                                  long targetIndex)
```
    Specified by:
    
    shiftTo in interface XOrderingEnum<E>
    
    Specified by:
    
    shiftTo in interface XOrderingSequence<E>
    
    Specified by:
    
    shiftTo in interface XReference<E>
    
    Specified by:
    
    shiftTo in interface XSortableEnum<E>
    
    Specified by:
    
    shiftTo in interface XSortableSequence<E>
  - shiftTo
```
public final Singleton<E> shiftTo(long sourceIndex,
                                  long targetIndex,
                                  long length)
```
    Specified by:
    
    shiftTo in interface XOrderingEnum<E>
    
    Specified by:
    
    shiftTo in interface XOrderingSequence<E>
    
    Specified by:
    
    shiftTo in interface XReference<E>
    
    Specified by:
    
    shiftTo in interface XSortableEnum<E>
    
    Specified by:
    
    shiftTo in interface XSortableSequence<E>
  - shiftBy
```
public final Singleton<E> shiftBy(long sourceIndex,
                                  long distance)
```
    Specified by:
    
    shiftBy in interface XOrderingEnum<E>
    
    Specified by:
    
    shiftBy in interface XOrderingSequence<E>
    
    Specified by:
    
    shiftBy in interface XReference<E>
    
    Specified by:
    
    shiftBy in interface XSortableEnum<E>
    
    Specified by:
    
    shiftBy in interface XSortableSequence<E>
  - shiftBy
```
public final Singleton<E> shiftBy(long sourceIndex,
                                  long distance,
                                  long length)
```
    Specified by:
    
    shiftBy in interface XOrderingEnum<E>
    
    Specified by:
    
    shiftBy in interface XOrderingSequence<E>
    
    Specified by:
    
    shiftBy in interface XReference<E>
    
    Specified by:
    
    shiftBy in interface XSortableEnum<E>
    
    Specified by:
    
    shiftBy in interface XSortableSequence<E>
  - set
```
public final void set(E element)
```
    Specified by:
    
    set in interface Reference<E>
    
    Specified by:
    
    set in interface XReference<E>
  - fill
```
public final Singleton<E> fill(long offset,
                               long length,
                               E element)
```
    Specified by:
    
    fill in interface XReference<E>
    
    Specified by:
    
    fill in interface XSettingList<E>
  - setAll
```
@SafeVarargs
public final Singleton<E> setAll(long index,
                                 E... elements)
```
    Specified by:
    
    setAll in interface XReference<E>
    
    Specified by:
    
    setAll in interface XSettingList<E>
    
    Specified by:
    
    setAll in interface XSettingSequence<E>
  - set
```
public final Singleton<E> set(long index,
                              E[] elements,
                              int offset,
                              int length)
```
    Specified by:
    
    set in interface XReference<E>
    
    Specified by:
    
    set in interface XSettingList<E>
    
    Specified by:
    
    set in interface XSettingSequence<E>
  - set
```
public final Singleton<E> set(long index,
                              XGettingSequence<? extends E> elements,
                              long offset,
                              long length)
```
    Specified by:
    
    set in interface XReference<E>
    
    Specified by:
    
    set in interface XSettingList<E>
    
    Specified by:
    
    set in interface XSettingSequence<E>
  - swap
```
public final Singleton<E> swap(long indexA,
                               long indexB)
```
    Specified by:
    
    swap in interface XOrderingEnum<E>
    
    Specified by:
    
    swap in interface XOrderingSequence<E>
    
    Specified by:
    
    swap in interface XReference<E>
    
    Specified by:
    
    swap in interface XSettingList<E>
    
    Specified by:
    
    swap in interface XSettingSequence<E>
    
    Specified by:
    
    swap in interface XSortableEnum<E>
    
    Specified by:
    
    swap in interface XSortableSequence<E>
  - swap
```
public final Singleton<E> swap(long indexA,
                               long indexB,
                               long length)
```
    Specified by:
    
    swap in interface XOrderingEnum<E>
    
    Specified by:
    
    swap in interface XOrderingSequence<E>
    
    Specified by:
    
    swap in interface XReference<E>
    
    Specified by:
    
    swap in interface XSettingList<E>
    
    Specified by:
    
    swap in interface XSettingSequence<E>
    
    Specified by:
    
    swap in interface XSortableEnum<E>
    
    Specified by:
    
    swap in interface XSortableSequence<E>
  - reverse
```
public final Singleton<E> reverse()
```
    Specified by:
    
    reverse in interface XOrderingEnum<E>
    
    Specified by:
    
    reverse in interface XOrderingSequence<E>
    
    Specified by:
    
    reverse in interface XReference<E>
    
    Specified by:
    
    reverse in interface XSettingList<E>
    
    Specified by:
    
    reverse in interface XSettingSequence<E>
    
    Specified by:
    
    reverse in interface XSortableEnum<E>
    
    Specified by:
    
    reverse in interface XSortableSequence<E>
  - sort
```
public final Singleton<E> sort(Comparator<? super E> comparator)
```
    Specified by:
    
    sort in interface Sortable<E>
    
    Specified by:
    
    sort in interface XReference<E>
    
    Specified by:
    
    sort in interface XSettingList<E>
    
    Specified by:
    
    sort in interface XSettingSequence<E>
    
    Specified by:
    
    sort in interface XSortableEnum<E>
    
    Specified by:
    
    sort in interface XSortableSequence<E>

Class Singleton<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

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

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.function.Consumer

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

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

Constructor Detail

Singleton

Method Detail

get

copy

iterate

join

iterateIndexed

immure

listIterator

listIterator

old

range

toReversed

copySelection

first

at

indexOf

indexBy

isSorted

last

lastIndexOf

lastIndexBy

maxIndex

minIndex

peek

poll

scan

view

view

containsSearched

applies

contains

containsAll

containsId

copyTo

filterTo

count

countBy

distinct

distinct

equality

equals

equalsContent

except

hasVolatileElements

intersect

isEmpty

iterator

max

min

nullContained

seek

search

size

toArray

toArray

union

nullAllowed

remainingCapacity