Package one.microstream.collections
Class Constant<E>
- java.lang.Object
-
- one.microstream.collections.Constant<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>
,XReferencing<E>
,ThreadSafe
,HashImmutable
,Referencing<E>
,Copyable
,Immutable
- Direct Known Subclasses:
LinkingReferencing.Default
public class Constant<E> extends Object implements XImmutableList<E>, XImmutableEnum<E>, XReferencing<E>
Immutable 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:
Singleton
-
-
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.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>
-
-
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 asXGettingCollection.containsSearched(Predicate)
with aPredicate
implementation that checks for object identity.boolean
containsSearched(Predicate<? super E> predicate)
Constant<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>>
TcopySelection(T target, long... indices)
<T extends Consumer<? super E>>
TcopyTo(T target)
long
count(E element)
long
countBy(Predicate<? super E> predicate)
<T extends Consumer<? super E>>
Tdistinct(T target)
<T extends Consumer<? super E>>
Tdistinct(T target, Equalator<? super E> equalator)
Equalator<? super E>
equality()
boolean
equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
Returnstrue
if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)
yieldstrue
.boolean
equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
Returnstrue
if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.<T extends Consumer<? super E>>
Texcept(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)
<T extends Consumer<? super E>>
TfilterTo(T target, Predicate<? super E> predicate)
E
first()
E
get()
Convenience alias forfirst()
.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()
Always returns the already immutable collection instance itselflong
indexBy(Predicate<? super E> predicate)
long
indexOf(E element)
<T extends Consumer<? super E>>
Tintersect(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>>
Piterate(P procedure)
<P extends IndexedAcceptor<? super E>>
PiterateIndexed(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.Constant.OldConstant
old()
E
peek()
E
poll()
Constant<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 passedPredicate
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)
Constant<E>
toReversed()
<T extends Consumer<? super E>>
Tunion(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)
Constant<E>
view()
Constant<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
-
Constant
public Constant(E element)
-
-
Method Detail
-
get
public final E get()
Convenience alias forfirst()
.- Specified by:
get
in interfaceReferencing<E>
- Specified by:
get
in interfaceXGettingCollection<E>
- Specified by:
get
in interfaceXGettingSequence<E>
- Specified by:
get
in interfaceXReferencing<E>
- Returns:
- the contained element.
- See Also:
XGettingSequence.at(long)
,XGettingSequence.first()
,XGettingSequence.last()
-
copy
public final Constant<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 interfaceCopyable
- Specified by:
copy
in interfaceXGettingBag<E>
- Specified by:
copy
in interfaceXGettingCollection<E>
- Specified by:
copy
in interfaceXGettingEnum<E>
- Specified by:
copy
in interfaceXGettingList<E>
- Specified by:
copy
in interfaceXGettingSequence<E>
- Specified by:
copy
in interfaceXGettingSet<E>
- Specified by:
copy
in interfaceXImmutableBag<E>
- Specified by:
copy
in interfaceXImmutableCollection<E>
- Specified by:
copy
in interfaceXImmutableEnum<E>
- Specified by:
copy
in interfaceXImmutableList<E>
- Specified by:
copy
in interfaceXImmutableSequence<E>
- Specified by:
copy
in interfaceXImmutableSet<E>
- Specified by:
copy
in interfaceXReferencing<E>
- Returns:
- a copy of this list
-
iterate
public final <P extends Consumer<? super E>> P iterate(P procedure)
- Specified by:
iterate
in interfaceXGettingEnum<E>
- Specified by:
iterate
in interfaceXGettingSet<E>
- Specified by:
iterate
in interfaceXIterable<E>
-
join
public final <A> A join(BiConsumer<? super E,? super A> joiner, A aggregate)
-
iterateIndexed
public final <P extends IndexedAcceptor<? super E>> P iterateIndexed(P procedure)
- Specified by:
iterateIndexed
in interfaceXIndexIterable<E>
-
immure
public final Constant<E> immure()
Description copied from interface:XImmutableList
Always returns the already immutable collection instance itselfFor spawning a copy of the collection instance, see
XImmutableCollection.copy()
- Specified by:
immure
in interfaceXGettingBag<E>
- Specified by:
immure
in interfaceXGettingCollection<E>
- Specified by:
immure
in interfaceXGettingEnum<E>
- Specified by:
immure
in interfaceXGettingList<E>
- Specified by:
immure
in interfaceXGettingSequence<E>
- Specified by:
immure
in interfaceXGettingSet<E>
- Specified by:
immure
in interfaceXImmutableBag<E>
- Specified by:
immure
in interfaceXImmutableCollection<E>
- Specified by:
immure
in interfaceXImmutableEnum<E>
- Specified by:
immure
in interfaceXImmutableList<E>
- Specified by:
immure
in interfaceXImmutableSequence<E>
- Specified by:
immure
in interfaceXImmutableSet<E>
- Specified by:
immure
in interfaceXReferencing<E>
- Returns:
- a reference to the instance itself.
- See Also:
XImmutableCollection.copy()
-
listIterator
public final ListIterator<E> listIterator()
- Specified by:
listIterator
in interfaceXGettingList<E>
- Specified by:
listIterator
in interfaceXReferencing<E>
-
listIterator
public final ListIterator<E> listIterator(long index)
- Specified by:
listIterator
in interfaceXGettingList<E>
- Specified by:
listIterator
in interfaceXReferencing<E>
-
old
public final one.microstream.collections.Constant.OldConstant old()
- Specified by:
old
in interfaceXGettingCollection<E>
- Specified by:
old
in interfaceXGettingList<E>
- Specified by:
old
in interfaceXReferencing<E>
-
range
public final Constant<E> range(long fromIndex, long toIndex)
- Specified by:
range
in interfaceXGettingEnum<E>
- Specified by:
range
in interfaceXGettingList<E>
- Specified by:
range
in interfaceXGettingSequence<E>
- Specified by:
range
in interfaceXImmutableList<E>
- Specified by:
range
in interfaceXReferencing<E>
-
toReversed
public final Constant<E> toReversed()
- Specified by:
toReversed
in interfaceXGettingEnum<E>
- Specified by:
toReversed
in interfaceXGettingList<E>
- Specified by:
toReversed
in interfaceXGettingSequence<E>
- Specified by:
toReversed
in interfaceXImmutableEnum<E>
- Specified by:
toReversed
in interfaceXImmutableList<E>
- Specified by:
toReversed
in interfaceXImmutableSequence<E>
- Specified by:
toReversed
in interfaceXReferencing<E>
-
copySelection
public final <T extends Consumer<? super E>> T copySelection(T target, long... indices)
- Specified by:
copySelection
in interfaceXGettingSequence<E>
- Specified by:
copySelection
in interfaceXReferencing<E>
-
first
public final E first()
- Specified by:
first
in interfaceXGettingSequence<E>
- Specified by:
first
in interfaceXReferencing<E>
-
at
public final E at(long index)
- Specified by:
at
in interfaceXGettingSequence<E>
- Specified by:
at
in interfaceXReferencing<E>
-
indexOf
public final long indexOf(E element)
- Specified by:
indexOf
in interfaceXGettingSequence<E>
- Specified by:
indexOf
in interfaceXReferencing<E>
-
indexBy
public final long indexBy(Predicate<? super E> predicate)
- Specified by:
indexBy
in interfaceXGettingSequence<E>
- Specified by:
indexBy
in interfaceXReferencing<E>
-
isSorted
public final boolean isSorted(Comparator<? super E> comparator)
- Specified by:
isSorted
in interfaceXGettingSequence<E>
- Specified by:
isSorted
in interfaceXReferencing<E>
-
last
public final E last()
- Specified by:
last
in interfaceXGettingSequence<E>
- Specified by:
last
in interfaceXReferencing<E>
-
lastIndexOf
public final long lastIndexOf(E element)
- Specified by:
lastIndexOf
in interfaceXGettingSequence<E>
- Specified by:
lastIndexOf
in interfaceXReferencing<E>
-
lastIndexBy
public final long lastIndexBy(Predicate<? super E> predicate)
- Specified by:
lastIndexBy
in interfaceXGettingSequence<E>
- Specified by:
lastIndexBy
in interfaceXReferencing<E>
-
maxIndex
public final long maxIndex(Comparator<? super E> comparator)
- Specified by:
maxIndex
in interfaceXGettingSequence<E>
- Specified by:
maxIndex
in interfaceXReferencing<E>
-
minIndex
public final long minIndex(Comparator<? super E> comparator)
- Specified by:
minIndex
in interfaceXGettingSequence<E>
- Specified by:
minIndex
in interfaceXReferencing<E>
-
peek
public final E peek()
- Specified by:
peek
in interfaceXGettingSequence<E>
- Specified by:
peek
in interfaceXReferencing<E>
-
poll
public final E poll()
- Specified by:
poll
in interfaceXGettingSequence<E>
- Specified by:
poll
in interfaceXReferencing<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 passedPredicate
applied to ("scanning").- Specified by:
scan
in interfaceXGettingSequence<E>
- Specified by:
scan
in interfaceXReferencing<E>
- Returns:
- the index of the last positively tested element.
-
view
public final Constant<E> view()
- Specified by:
view
in interfaceXGettingBag<E>
- Specified by:
view
in interfaceXGettingCollection<E>
- Specified by:
view
in interfaceXGettingEnum<E>
- Specified by:
view
in interfaceXGettingList<E>
- Specified by:
view
in interfaceXGettingSequence<E>
- Specified by:
view
in interfaceXImmutableList<E>
- Specified by:
view
in interfaceXReferencing<E>
-
view
public final Constant<E> view(long lowIndex, long highIndex)
- Specified by:
view
in interfaceXGettingEnum<E>
- Specified by:
view
in interfaceXGettingList<E>
- Specified by:
view
in interfaceXGettingSequence<E>
- Specified by:
view
in interfaceXImmutableList<E>
- Specified by:
view
in interfaceXReferencing<E>
-
containsSearched
public final boolean containsSearched(Predicate<? super E> predicate)
- Specified by:
containsSearched
in interfaceXGettingCollection<E>
- Specified by:
containsSearched
in interfaceXReferencing<E>
-
applies
public final boolean applies(Predicate<? super E> predicate)
- Specified by:
applies
in interfaceXGettingCollection<E>
- Specified by:
applies
in interfaceXReferencing<E>
-
contains
public final boolean contains(E element)
- Specified by:
contains
in interfaceXGettingCollection<E>
- Specified by:
contains
in interfaceXReferencing<E>
-
containsAll
public final boolean containsAll(XGettingCollection<? extends E> elements)
- Specified by:
containsAll
in interfaceXGettingCollection<E>
- Specified by:
containsAll
in interfaceXReferencing<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 asXGettingCollection.containsSearched(Predicate)
with aPredicate
implementation that checks for object identity. The only difference is a performance and usability advantage- Specified by:
containsId
in interfaceXGettingCollection<E>
- Specified by:
containsId
in interfaceXReferencing<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 interfaceXGettingCollection<E>
- Specified by:
copyTo
in interfaceXReferencing<E>
-
filterTo
public final <T extends Consumer<? super E>> T filterTo(T target, Predicate<? super E> predicate)
- Specified by:
filterTo
in interfaceXGettingCollection<E>
- Specified by:
filterTo
in interfaceXReferencing<E>
-
count
public final long count(E element)
- Specified by:
count
in interfaceXGettingCollection<E>
- Specified by:
count
in interfaceXReferencing<E>
-
countBy
public final long countBy(Predicate<? super E> predicate)
- Specified by:
countBy
in interfaceXGettingCollection<E>
- Specified by:
countBy
in interfaceXReferencing<E>
-
distinct
public final <T extends Consumer<? super E>> T distinct(T target)
- Specified by:
distinct
in interfaceXGettingCollection<E>
- Specified by:
distinct
in interfaceXReferencing<E>
-
distinct
public final <T extends Consumer<? super E>> T distinct(T target, Equalator<? super E> equalator)
- Specified by:
distinct
in interfaceXGettingCollection<E>
- Specified by:
distinct
in interfaceXReferencing<E>
-
equality
public final Equalator<? super E> equality()
- Specified by:
equality
in interfaceXGettingCollection<E>
- Specified by:
equality
in interfaceXReferencing<E>
-
equals
public final boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
Description copied from interface:XGettingCollection
Returnstrue
if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)
yieldstrue
.- Specified by:
equals
in interfaceXGettingCollection<E>
- Specified by:
equals
in interfaceXReferencing<E>
-
equalsContent
public final boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)
Description copied from interface:XGettingCollection
Returnstrue
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 inCollection
). 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 interfaceXGettingCollection<E>
- Specified by:
equalsContent
in interfaceXReferencing<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 interfaceXGettingCollection<E>
- Specified by:
except
in interfaceXReferencing<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 areWeakReference
ofSoftReference
or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
Note thatWeakReference
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 interfaceExtendedCollection<E>
- Specified by:
hasVolatileElements
in interfaceXGettingCollection<E>
- Specified by:
hasVolatileElements
in interfaceXReferencing<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 interfaceXGettingCollection<E>
- Specified by:
intersect
in interfaceXReferencing<E>
-
isEmpty
public final boolean isEmpty()
- Specified by:
isEmpty
in interfaceSized
- Specified by:
isEmpty
in interfaceXReferencing<E>
-
iterator
public Iterator<E> iterator()
- Specified by:
iterator
in interfaceIterable<E>
- Specified by:
iterator
in interfaceXGettingCollection<E>
- Specified by:
iterator
in interfaceXReferencing<E>
-
max
public final E max(Comparator<? super E> comparator)
- Specified by:
max
in interfaceXGettingCollection<E>
- Specified by:
max
in interfaceXReferencing<E>
-
min
public final E min(Comparator<? super E> comparator)
- Specified by:
min
in interfaceXGettingCollection<E>
- Specified by:
min
in interfaceXReferencing<E>
-
nullContained
public final boolean nullContained()
- Specified by:
nullContained
in interfaceXGettingCollection<E>
- Specified by:
nullContained
in interfaceXReferencing<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 ofXGettingCollection.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 interfaceXGettingCollection<E>
- Specified by:
seek
in interfaceXReferencing<E>
-
search
public final E search(Predicate<? super E> predicate)
- Specified by:
search
in interfaceXGettingCollection<E>
- Specified by:
search
in interfaceXReferencing<E>
-
size
public final long size()
- Specified by:
size
in interfaceSized
- Specified by:
size
in interfaceXGettingCollection<E>
- Specified by:
size
in interfaceXReferencing<E>
-
toArray
public Object[] toArray()
- Specified by:
toArray
in interfaceXGettingCollection<E>
- Specified by:
toArray
in interfaceXReferencing<E>
-
toArray
public E[] toArray(Class<E> type)
- Specified by:
toArray
in interfaceXGettingCollection<E>
- Specified by:
toArray
in interfaceXReferencing<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 interfaceXGettingCollection<E>
- Specified by:
union
in interfaceXReferencing<E>
-
nullAllowed
public final boolean nullAllowed()
- Specified by:
nullAllowed
in interfaceExtendedCollection<E>
- Specified by:
nullAllowed
in interfaceXReferencing<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 interfaceCapacityCarrying
- Specified by:
remainingCapacity
in interfaceXReferencing<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 interfaceCapacityCarrying
- Specified by:
isFull
in interfaceXReferencing<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 interfaceCapacityCarrying
- Specified by:
maximumCapacity
in interfaceXReferencing<E>
- Returns:
- the maximum amount of elements this carrier instance can contain.
-
-