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

Type Parameters:

E -

All Implemented Interfaces:

Iterable<E>, CapacityCarrying, ExtendedBag<E>, ExtendedCollection<E>, ExtendedList<E>, ExtendedSequence<E>, Sized, XGettingBag<E>, XGettingCollection<E>, XGettingEnum<E>, XGettingList<E>, XGettingSequence<E>, XGettingSet<E>, XImmutableBag<E>, XImmutableCollection<E>, XImmutableEnum<E>, XImmutableList<E>, XImmutableSequence<E>, XImmutableSet<E>, XIndexIterable<E>, XIterable<E>, XJoinable<E>, ThreadSafe, HashImmutable, Copyable, Immutable, Stateless
```
public final class Empty<E>
extends Object
implements XImmutableList<E>, XImmutableEnum<E>, Stateless
```
Empty dummy collection to be used as a constant and stateless empty collection placeholder.
As there is no element at all, this type can be a List and a Set (Enum) at the same time, enabling it to be used in any type situation.

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.XGettingSet
  XGettingSet.Creator<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XImmutableEnum
  XImmutableEnum.Factory<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XImmutableList
  XImmutableList.Factory<E>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XIterable
  XIterable.Executor<E>

Constructor Summary

Constructors
Constructor Description

Empty()

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)`
`Empty<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.
`<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 one element from 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.
`Empty<E>`	`immure()`	Always returns the already immutable collection instance itself
`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.Empty.OldEmpty`	`old()`
`E`	`peek()`
`E`	`poll()`
`Empty<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)`
`Empty<E>`	`toReversed()`
`<T extends Consumer<? super E>> T`	`union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)`
`Empty<E>`	`view()`
`Empty<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 one.microstream.hashing.HashImmutable
equals, hashCode

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

- Constructor Detail
  - Empty
```
public Empty()
```
- Method Detail
  - copy
```
public final Empty<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 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 XImmutableBag<E>
    
    Specified by:
    
    copy in interface XImmutableCollection<E>
    
    Specified by:
    
    copy in interface XImmutableEnum<E>
    
    Specified by:
    
    copy in interface XImmutableList<E>
    
    Specified by:
    
    copy in interface XImmutableSequence<E>
    
    Specified by:
    
    copy in interface XImmutableSet<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 Empty<E> immure()
```
    Description copied from interface: XImmutableList
    
    Always returns the already immutable collection instance itself
    For spawning a copy of the collection instance, see XImmutableCollection.copy()
    
    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 XImmutableBag<E>
    
    Specified by:
    
    immure in interface XImmutableCollection<E>
    
    Specified by:
    
    immure in interface XImmutableEnum<E>
    
    Specified by:
    
    immure in interface XImmutableList<E>
    
    Specified by:
    
    immure in interface XImmutableSequence<E>
    
    Specified by:
    
    immure in interface XImmutableSet<E>
    
    Returns:
    
    a reference to the instance itself.
    
    See Also:
    
    XImmutableCollection.copy()
  - listIterator
```
public ListIterator<E> listIterator()
```
    Specified by:
    
    listIterator in interface XGettingList<E>
  - listIterator
```
public ListIterator<E> listIterator(long index)
```
    Specified by:
    
    listIterator in interface XGettingList<E>
  - old
```
public one.microstream.collections.Empty.OldEmpty old()
```
    Specified by:
    
    old in interface XGettingCollection<E>
    
    Specified by:
    
    old in interface XGettingList<E>
  - range
```
public Empty<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 XImmutableList<E>
  - toReversed
```
public Empty<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 XImmutableEnum<E>
    
    Specified by:
    
    toReversed in interface XImmutableList<E>
    
    Specified by:
    
    toReversed in interface XImmutableSequence<E>
  - copySelection
```
public <T extends Consumer<? super E>> T copySelection(T target,
                                                       long... indices)
```
    Specified by:
    
    copySelection in interface XGettingSequence<E>
  - get
```
public E get()
```
    Description copied from interface: XGettingCollection
    
    Gets one element from the collection. If the collection is not ordered XGettingSequence, then it is undefined which element is returned. If the collection is ordered, the element at index 0 is returned.
    
    Specified by:
    
    get in interface XGettingCollection<E>
    
    Specified by:
    
    get in interface XGettingSequence<E>
    
    Returns:
    
    the first / any element.
    
    See Also:
    
    XGettingSequence.at(long), XGettingSequence.first(), XGettingSequence.last()
  - first
```
public E first()
```
    Specified by:
    
    first in interface XGettingSequence<E>
  - at
```
public E at(long index)
```
    Specified by:
    
    at in interface XGettingSequence<E>
  - indexOf
```
public long indexOf(E element)
```
    Specified by:
    
    indexOf in interface XGettingSequence<E>
  - indexBy
```
public long indexBy(Predicate<? super E> predicate)
```
    Specified by:
    
    indexBy in interface XGettingSequence<E>
  - isSorted
```
public boolean isSorted(Comparator<? super E> comparator)
```
    Specified by:
    
    isSorted in interface XGettingSequence<E>
  - last
```
public E last()
```
    Specified by:
    
    last in interface XGettingSequence<E>
  - lastIndexOf
```
public long lastIndexOf(E element)
```
    Specified by:
    
    lastIndexOf in interface XGettingSequence<E>
  - lastIndexBy
```
public long lastIndexBy(Predicate<? super E> predicate)
```
    Specified by:
    
    lastIndexBy in interface XGettingSequence<E>
  - maxIndex
```
public long maxIndex(Comparator<? super E> comparator)
```
    Specified by:
    
    maxIndex in interface XGettingSequence<E>
  - minIndex
```
public long minIndex(Comparator<? super E> comparator)
```
    Specified by:
    
    minIndex in interface XGettingSequence<E>
  - peek
```
public E peek()
```
    Specified by:
    
    peek in interface XGettingSequence<E>
  - poll
```
public E poll()
```
    Specified by:
    
    poll in interface XGettingSequence<E>
  - scan
```
public long scan(Predicate<? super E> predicate)
```
    Description copied from interface: XGettingSequence
    
    Iterates through the collection and returns the index of the last element that the passed Predicateapplied to ("scanning").
    
    Specified by:
    
    scan in interface XGettingSequence<E>
    
    Returns:
    
    the index of the last positively tested element.
  - view
```
public Empty<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 XImmutableList<E>
  - view
```
public Empty<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 XImmutableList<E>
  - containsSearched
```
public boolean containsSearched(Predicate<? super E> predicate)
```
    Specified by:
    
    containsSearched in interface XGettingCollection<E>
  - applies
```
public boolean applies(Predicate<? super E> predicate)
```
    Specified by:
    
    applies in interface XGettingCollection<E>
  - contains
```
public boolean contains(E element)
```
    Specified by:
    
    contains in interface XGettingCollection<E>
  - containsAll
```
public boolean containsAll(XGettingCollection<? extends E> elements)
```
    Specified by:
    
    containsAll in interface XGettingCollection<E>
  - containsId
```
public boolean containsId(E element)
```
    Description copied from interface: XGettingCollection
    
    Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic.
    This method has the same behavior as XGettingCollection.containsSearched(Predicate) with a Predicate implementation that checks for object identity. The only difference is a performance and usability advantage
    
    Specified by:
    
    containsId in interface XGettingCollection<E>
    
    Parameters:
    
    element - the element to be searched in the collection by identity.
    
    Returns:
    
    whether this collection contains exactely the given element.
  - copyTo
```
public <T extends Consumer<? super E>> T copyTo(T target)
```
    Specified by:
    
    copyTo in interface XGettingCollection<E>
  - filterTo
```
public <T extends Consumer<? super E>> T filterTo(T target,
                                                  Predicate<? super E> predicate)
```
    Specified by:
    
    filterTo in interface XGettingCollection<E>
  - count
```
public long count(E element)
```
    Specified by:
    
    count in interface XGettingCollection<E>
  - countBy
```
public long countBy(Predicate<? super E> predicate)
```
    Specified by:
    
    countBy in interface XGettingCollection<E>
  - distinct
```
public <T extends Consumer<? super E>> T distinct(T target)
```
    Specified by:
    
    distinct in interface XGettingCollection<E>
  - distinct
```
public <T extends Consumer<? super E>> T distinct(T target,
                                                  Equalator<? super E> equalator)
```
    Specified by:
    
    distinct in interface XGettingCollection<E>
  - equality
```
public Equalator<? super E> equality()
```
    Specified by:
    
    equality in interface XGettingCollection<E>
  - equals
```
public boolean equals(XGettingCollection<? extends E> samples,
                      Equalator<? super E> equalator)
```
    Description copied from interface: XGettingCollection
    
    Returns true if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator) yields true.
    
    Specified by:
    
    equals in interface XGettingCollection<E>
  - equalsContent
```
public boolean equalsContent(XGettingCollection<? extends E> samples,
                             Equalator<? super E> equalator)
```
    Description copied from interface: XGettingCollection
    
    Returns true if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.
    Note that for colletion types that don't have a defined order of elements, this method is hardly usable (as is XGettingCollection.equals(Object) for them as defined in Collection). The core problem of comparing collections that have no defined order is that they aren't really reliably comparable to any other collection.
    
    Specified by:
    
    equalsContent in interface XGettingCollection<E>
    
    equalator - the equalator to use to determine the equality of each element
    
    Returns:
    
    true if this list is equal to the passed list, false otherwise
  - except
```
public <T extends Consumer<? super E>> T except(XGettingCollection<? extends E> other,
                                                Equalator<? super E> equalator,
                                                T target)
```
    Specified by:
    
    except in interface XGettingCollection<E>
  - hasVolatileElements
```
public boolean hasVolatileElements()
```
    Description copied from interface: XGettingCollection
    
    Tells if this collection contains volatile elements.
    An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. Examples are WeakReference of SoftReference or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
    Note that WeakReference instances that are added to a a simple (non-volatile) implementation of a collection do NOT make the collection volatile, as the elements themselves (the reference instances) are still strongly referenced.
    
    Specified by:
    
    hasVolatileElements in interface ExtendedCollection<E>
    
    Specified by:
    
    hasVolatileElements in interface XGettingCollection<E>
    
    Returns:
    
    true if the collection contains volatile elements.
  - intersect
```
public <T extends Consumer<? super E>> T intersect(XGettingCollection<? extends E> other,
                                                   Equalator<? super E> equalator,
                                                   T target)
```
    Specified by:
    
    intersect in interface XGettingCollection<E>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Sized
  - iterator
```
public Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface XGettingCollection<E>
  - max
```
public E max(Comparator<? super E> comparator)
```
    Specified by:
    
    max in interface XGettingCollection<E>
  - min
```
public E min(Comparator<? super E> comparator)
```
    Specified by:
    
    min in interface XGettingCollection<E>
  - nullContained
```
public boolean nullContained()
```
    Specified by:
    
    nullContained in interface XGettingCollection<E>
  - seek
```
public E seek(E sample)
```
    Description copied from interface: XGettingCollection
    
    Returns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained. (For collections using referential equality, this method is basically just a variation of XGettingCollection.contains(Object) with a different return type. For collections with data-dependant equality, the returned element might be the same as the passed one or a data-wise equal one, depending on the content of the collection)
    
    Specified by:
    
    seek in interface XGettingCollection<E>
  - search
```
public E search(Predicate<? super E> predicate)
```
    Specified by:
    
    search in interface XGettingCollection<E>
  - size
```
public long size()
```
    Specified by:
    
    size in interface Sized
    
    Specified by:
    
    size in interface XGettingCollection<E>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface XGettingCollection<E>
  - toArray
```
public E[] toArray(Class<E> type)
```
    Specified by:
    
    toArray in interface XGettingCollection<E>
  - union
```
public <T extends Consumer<? super E>> T union(XGettingCollection<? extends E> other,
                                               Equalator<? super E> equalator,
                                               T target)
```
    Specified by:
    
    union in interface XGettingCollection<E>
  - nullAllowed
```
public boolean nullAllowed()
```
    Specified by:
    
    nullAllowed in interface ExtendedCollection<E>
  - remainingCapacity
```
public long remainingCapacity()
```
    Description copied from interface: CapacityCarrying
    
    Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.
    
    Specified by:
    
    remainingCapacity in interface CapacityCarrying
  - isFull
```
public boolean isFull()
```
    Description copied from interface: CapacityCarrying
    
    Returns true if the current capacity cannot be increased any more.
    
    Specified by:
    
    isFull in interface CapacityCarrying
  - maximumCapacity
```
public long maximumCapacity()
```
    Description copied from interface: CapacityCarrying
    
    Returns the maximum amount of elements this carrier instance can contain.
    The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g. Integer.MAX_VALUE)
    
    Specified by:
    
    maximumCapacity in interface CapacityCarrying
    
    Returns:
    
    the maximum amount of elements this carrier instance can contain.

Class Empty<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.XGettingSet

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

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface one.microstream.hashing.HashImmutable

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 Detail

Empty

Method Detail

copy

iterate

join

iterateIndexed

immure

listIterator

listIterator

old

range

toReversed

copySelection

get

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

isFull

maximumCapacity