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.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> -
Constructor Summary
-
Method Summary
Modifier and Type Method Description booleanapplies(Predicate<? super E> predicate)Eat(long index)booleancontains(E element)booleancontainsAll(XGettingCollection<? extends E> elements)booleancontainsId(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 aPredicateimplementation that checks for object identity.booleancontainsSearched(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)longcount(E element)longcountBy(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()booleanequals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Returnstrueif the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)yieldstrue.booleanequalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Returnstrueif 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)Efirst()Eget()Convenience alias forfirst().booleanhasVolatileElements()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 itselflongindexBy(Predicate<? super E> predicate)longindexOf(E element)<T extends Consumer<? super E>>
Tintersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)booleanisEmpty()booleanisFull()Returns true if the current capacity cannot be increased any more.booleanisSorted(Comparator<? super E> comparator)<P extends Consumer<? super E>>
Piterate(P procedure)<P extends IndexedAcceptor<? super E>>
PiterateIndexed(P procedure)Iterator<E>iterator()<A> Ajoin(BiConsumer<? super E,? super A> joiner, A aggregate)Elast()longlastIndexBy(Predicate<? super E> predicate)longlastIndexOf(E element)ListIterator<E>listIterator()ListIterator<E>listIterator(long index)Emax(Comparator<? super E> comparator)longmaximumCapacity()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.longmaxIndex(Comparator<? super E> comparator)Emin(Comparator<? super E> comparator)longminIndex(Comparator<? super E> comparator)booleannullAllowed()booleannullContained()one.microstream.collections.Constant.OldConstantold()Epeek()Epoll()Constant<E>range(long fromIndex, long toIndex)longremainingCapacity()Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.longscan(Predicate<? super E> predicate)Iterates through the collection and returns the index of the last element that the passedPredicateapplied to ("scanning").Esearch(Predicate<? super E> predicate)Eseek(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.longsize()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, waitMethods inherited from interface one.microstream.collections.types.XGettingCollection
equals, hashCode, intSize
-
Constructor Details
-
Method Details
-
get
Convenience alias forfirst().- Specified by:
getin interfaceReferencing<E>- Specified by:
getin interfaceXGettingCollection<E>- Specified by:
getin interfaceXGettingSequence<E>- Specified by:
getin interfaceXReferencing<E>- Returns:
- the contained element.
- See Also:
XGettingSequence.at(long),XGettingSequence.first(),XGettingSequence.last()
-
copy
Description copied from interface:XGettingCollectionCreates 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:
copyin interfaceCopyable- Specified by:
copyin interfaceXGettingBag<E>- Specified by:
copyin interfaceXGettingCollection<E>- Specified by:
copyin interfaceXGettingEnum<E>- Specified by:
copyin interfaceXGettingList<E>- Specified by:
copyin interfaceXGettingSequence<E>- Specified by:
copyin interfaceXGettingSet<E>- Specified by:
copyin interfaceXImmutableBag<E>- Specified by:
copyin interfaceXImmutableCollection<E>- Specified by:
copyin interfaceXImmutableEnum<E>- Specified by:
copyin interfaceXImmutableList<E>- Specified by:
copyin interfaceXImmutableSequence<E>- Specified by:
copyin interfaceXImmutableSet<E>- Specified by:
copyin interfaceXReferencing<E>- Returns:
- a copy of this list
-
iterate
- Specified by:
iteratein interfaceXGettingEnum<E>- Specified by:
iteratein interfaceXGettingSet<E>- Specified by:
iteratein interfaceXIterable<E>
-
join
-
iterateIndexed
- Specified by:
iterateIndexedin interfaceXIndexIterable<E>
-
immure
Description copied from interface:XImmutableListAlways returns the already immutable collection instance itselfFor spawning a copy of the collection instance, see
XImmutableCollection.copy()- Specified by:
immurein interfaceXGettingBag<E>- Specified by:
immurein interfaceXGettingCollection<E>- Specified by:
immurein interfaceXGettingEnum<E>- Specified by:
immurein interfaceXGettingList<E>- Specified by:
immurein interfaceXGettingSequence<E>- Specified by:
immurein interfaceXGettingSet<E>- Specified by:
immurein interfaceXImmutableBag<E>- Specified by:
immurein interfaceXImmutableCollection<E>- Specified by:
immurein interfaceXImmutableEnum<E>- Specified by:
immurein interfaceXImmutableList<E>- Specified by:
immurein interfaceXImmutableSequence<E>- Specified by:
immurein interfaceXImmutableSet<E>- Specified by:
immurein interfaceXReferencing<E>- Returns:
- a reference to the instance itself.
- See Also:
XImmutableCollection.copy()
-
listIterator
- Specified by:
listIteratorin interfaceXGettingList<E>- Specified by:
listIteratorin interfaceXReferencing<E>
-
listIterator
- Specified by:
listIteratorin interfaceXGettingList<E>- Specified by:
listIteratorin interfaceXReferencing<E>
-
old
public final one.microstream.collections.Constant.OldConstant old()- Specified by:
oldin interfaceXGettingCollection<E>- Specified by:
oldin interfaceXGettingList<E>- Specified by:
oldin interfaceXReferencing<E>
-
range
- Specified by:
rangein interfaceXGettingEnum<E>- Specified by:
rangein interfaceXGettingList<E>- Specified by:
rangein interfaceXGettingSequence<E>- Specified by:
rangein interfaceXImmutableList<E>- Specified by:
rangein interfaceXReferencing<E>
-
toReversed
- Specified by:
toReversedin interfaceXGettingEnum<E>- Specified by:
toReversedin interfaceXGettingList<E>- Specified by:
toReversedin interfaceXGettingSequence<E>- Specified by:
toReversedin interfaceXImmutableEnum<E>- Specified by:
toReversedin interfaceXImmutableList<E>- Specified by:
toReversedin interfaceXImmutableSequence<E>- Specified by:
toReversedin interfaceXReferencing<E>
-
copySelection
- Specified by:
copySelectionin interfaceXGettingSequence<E>- Specified by:
copySelectionin interfaceXReferencing<E>
-
first
- Specified by:
firstin interfaceXGettingSequence<E>- Specified by:
firstin interfaceXReferencing<E>
-
at
- Specified by:
atin interfaceXGettingSequence<E>- Specified by:
atin interfaceXReferencing<E>
-
indexOf
- Specified by:
indexOfin interfaceXGettingSequence<E>- Specified by:
indexOfin interfaceXReferencing<E>
-
indexBy
- Specified by:
indexByin interfaceXGettingSequence<E>- Specified by:
indexByin interfaceXReferencing<E>
-
isSorted
- Specified by:
isSortedin interfaceXGettingSequence<E>- Specified by:
isSortedin interfaceXReferencing<E>
-
last
- Specified by:
lastin interfaceXGettingSequence<E>- Specified by:
lastin interfaceXReferencing<E>
-
lastIndexOf
- Specified by:
lastIndexOfin interfaceXGettingSequence<E>- Specified by:
lastIndexOfin interfaceXReferencing<E>
-
lastIndexBy
- Specified by:
lastIndexByin interfaceXGettingSequence<E>- Specified by:
lastIndexByin interfaceXReferencing<E>
-
maxIndex
- Specified by:
maxIndexin interfaceXGettingSequence<E>- Specified by:
maxIndexin interfaceXReferencing<E>
-
minIndex
- Specified by:
minIndexin interfaceXGettingSequence<E>- Specified by:
minIndexin interfaceXReferencing<E>
-
peek
- Specified by:
peekin interfaceXGettingSequence<E>- Specified by:
peekin interfaceXReferencing<E>
-
poll
- Specified by:
pollin interfaceXGettingSequence<E>- Specified by:
pollin interfaceXReferencing<E>
-
scan
Description copied from interface:XGettingSequenceIterates through the collection and returns the index of the last element that the passedPredicateapplied to ("scanning").- Specified by:
scanin interfaceXGettingSequence<E>- Specified by:
scanin interfaceXReferencing<E>- Returns:
- the index of the last positively tested element.
-
view
- Specified by:
viewin interfaceXGettingBag<E>- Specified by:
viewin interfaceXGettingCollection<E>- Specified by:
viewin interfaceXGettingEnum<E>- Specified by:
viewin interfaceXGettingList<E>- Specified by:
viewin interfaceXGettingSequence<E>- Specified by:
viewin interfaceXImmutableList<E>- Specified by:
viewin interfaceXReferencing<E>
-
view
- Specified by:
viewin interfaceXGettingEnum<E>- Specified by:
viewin interfaceXGettingList<E>- Specified by:
viewin interfaceXGettingSequence<E>- Specified by:
viewin interfaceXImmutableList<E>- Specified by:
viewin interfaceXReferencing<E>
-
containsSearched
- Specified by:
containsSearchedin interfaceXGettingCollection<E>- Specified by:
containsSearchedin interfaceXReferencing<E>
-
applies
- Specified by:
appliesin interfaceXGettingCollection<E>- Specified by:
appliesin interfaceXReferencing<E>
-
contains
- Specified by:
containsin interfaceXGettingCollection<E>- Specified by:
containsin interfaceXReferencing<E>
-
containsAll
- Specified by:
containsAllin interfaceXGettingCollection<E>- Specified by:
containsAllin interfaceXReferencing<E>
-
containsId
Description copied from interface:XGettingCollectionSpecial 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 aPredicateimplementation that checks for object identity. The only difference is a performance and usability advantage- Specified by:
containsIdin interfaceXGettingCollection<E>- Specified by:
containsIdin interfaceXReferencing<E>- Parameters:
element- the element to be searched in the collection by identity.- Returns:
- whether this collection contains exactely the given element.
-
copyTo
- Specified by:
copyToin interfaceXGettingCollection<E>- Specified by:
copyToin interfaceXReferencing<E>
-
filterTo
- Specified by:
filterToin interfaceXGettingCollection<E>- Specified by:
filterToin interfaceXReferencing<E>
-
count
- Specified by:
countin interfaceXGettingCollection<E>- Specified by:
countin interfaceXReferencing<E>
-
countBy
- Specified by:
countByin interfaceXGettingCollection<E>- Specified by:
countByin interfaceXReferencing<E>
-
distinct
- Specified by:
distinctin interfaceXGettingCollection<E>- Specified by:
distinctin interfaceXReferencing<E>
-
distinct
- Specified by:
distinctin interfaceXGettingCollection<E>- Specified by:
distinctin interfaceXReferencing<E>
-
equality
- Specified by:
equalityin interfaceXGettingCollection<E>- Specified by:
equalityin interfaceXReferencing<E>
-
equals
public final boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Description copied from interface:XGettingCollectionReturnstrueif the passed collection is of the same type as this collection andthis.equalsContent(list, equalator)yieldstrue.- Specified by:
equalsin interfaceXGettingCollection<E>- Specified by:
equalsin interfaceXReferencing<E>
-
equalsContent
public final boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)Description copied from interface:XGettingCollectionReturnstrueif 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:
equalsContentin interfaceXGettingCollection<E>- Specified by:
equalsContentin interfaceXReferencing<E>equalator- the equalator to use to determine the equality of each element- Returns:
trueif 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:
exceptin interfaceXGettingCollection<E>- Specified by:
exceptin interfaceXReferencing<E>
-
hasVolatileElements
public final boolean hasVolatileElements()Description copied from interface:XGettingCollectionTells 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 areWeakReferenceofSoftReferenceor implementations of collection entries that remove the element contained in an entry by some means outside the collection.
Note thatWeakReferenceinstances 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:
hasVolatileElementsin interfaceExtendedCollection<E>- Specified by:
hasVolatileElementsin interfaceXGettingCollection<E>- Specified by:
hasVolatileElementsin interfaceXReferencing<E>- Returns:
trueif 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:
intersectin interfaceXGettingCollection<E>- Specified by:
intersectin interfaceXReferencing<E>
-
isEmpty
public final boolean isEmpty()- Specified by:
isEmptyin interfaceSized- Specified by:
isEmptyin interfaceXReferencing<E>
-
iterator
- Specified by:
iteratorin interfaceIterable<E>- Specified by:
iteratorin interfaceXGettingCollection<E>- Specified by:
iteratorin interfaceXReferencing<E>
-
max
- Specified by:
maxin interfaceXGettingCollection<E>- Specified by:
maxin interfaceXReferencing<E>
-
min
- Specified by:
minin interfaceXGettingCollection<E>- Specified by:
minin interfaceXReferencing<E>
-
nullContained
public final boolean nullContained()- Specified by:
nullContainedin interfaceXGettingCollection<E>- Specified by:
nullContainedin interfaceXReferencing<E>
-
seek
Description copied from interface:XGettingCollectionReturns 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:
seekin interfaceXGettingCollection<E>- Specified by:
seekin interfaceXReferencing<E>
-
search
- Specified by:
searchin interfaceXGettingCollection<E>- Specified by:
searchin interfaceXReferencing<E>
-
size
public final long size()- Specified by:
sizein interfaceSized- Specified by:
sizein interfaceXGettingCollection<E>- Specified by:
sizein interfaceXReferencing<E>
-
toArray
- Specified by:
toArrayin interfaceXGettingCollection<E>- Specified by:
toArrayin interfaceXReferencing<E>
-
toArray
- Specified by:
toArrayin interfaceXGettingCollection<E>- Specified by:
toArrayin interfaceXReferencing<E>
-
union
public final <T extends Consumer<? super E>> T union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)- Specified by:
unionin interfaceXGettingCollection<E>- Specified by:
unionin interfaceXReferencing<E>
-
nullAllowed
public final boolean nullAllowed()- Specified by:
nullAllowedin interfaceExtendedCollection<E>- Specified by:
nullAllowedin interfaceXReferencing<E>
-
remainingCapacity
public final long remainingCapacity()Description copied from interface:CapacityCarryingReturns the amount of elements this carrier instance can collect before reaching its maximimum capacity.- Specified by:
remainingCapacityin interfaceCapacityCarrying- Specified by:
remainingCapacityin interfaceXReferencing<E>
-
isFull
public final boolean isFull()Description copied from interface:CapacityCarryingReturns true if the current capacity cannot be increased any more.- Specified by:
isFullin interfaceCapacityCarrying- Specified by:
isFullin interfaceXReferencing<E>
-
maximumCapacity
public final long maximumCapacity()Description copied from interface:CapacityCarryingReturns 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:
maximumCapacityin interfaceCapacityCarrying- Specified by:
maximumCapacityin interfaceXReferencing<E>- Returns:
- the maximum amount of elements this carrier instance can contain.
-