Package one.microstream.collections

Class ConstHashEnum<E>

java.lang.Object

one.microstream.collections.AbstractExtendedCollection<E>

one.microstream.collections.AbstractChainCollection<E,E,E,ChainEntryLinkedStrong<E>>

one.microstream.collections.ConstHashEnum<E>

All Implemented Interfaces:

Iterable<E>, CapacityCarrying, ExtendedCollection<E>, ExtendedSequence<E>, HashCollection<E>, Sized, XGettingCollection<E>, XGettingEnum<E>, XGettingSequence<E>, XGettingSet<E>, XImmutableCollection<E>, XImmutableEnum<E>, XImmutableSequence<E>, XImmutableSet<E>, XIndexIterable<E>, XIterable<E>, XJoinable<E>, ThreadSafe, IdentityEqualityLogic, HashImmutable, Composition, Copyable, Immutable

public final class ConstHashEnum<E>
extends AbstractChainCollection<E,E,E,ChainEntryLinkedStrong<E>>
implements XImmutableEnum<E>, HashCollection<E>, Composition, IdentityEqualityLogic

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.interfaces.HashCollection

HashCollection.Analysis<H>

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.XIterable

XIterable.Executor<E>

Field Summary

Fields inherited from interface one.microstream.collections.interfaces.HashCollection

DEFAULT_HASH_FACTOR, DEFAULT_HASH_LENGTH

Constructor Summary

Constructors

Constructor	Description
ConstHashEnum()

Method Summary

Modifier and Type	Method	Description
HashCollection.Analysis<ConstHashEnum<E>>	analyze()
boolean	applies(Predicate<? super E> predicate)
E	at(long index)
boolean	contains(E element)
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)
ConstHashEnum<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)
<C extends Consumer<? super E>> C	copyTo(C target)
long	count(E entry)
long	countBy(Predicate<? super E> predicate)
<C extends Consumer<? super E>> C	distinct(C target)
<C extends Consumer<? super E>> C	distinct(C target, Equalator<? super E> equalator)
HashEqualator<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 andthis.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.
<C extends Consumer<? super E>> C	except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)
<C extends Consumer<? super E>> C	filterTo(C target, Predicate<? super E> predicate)
E	first()
E	get()	Gets one element from the collection.
float	hashDensity()
int	hashDistributionRange()
HashEqualator<E>	hashEquality()
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.
boolean	hasVolatileHashElements()
ConstHashEnum<E>	immure()	Always returns the already immutable collection instance itself
long	indexBy(Predicate<? super E> predicate)
long	indexOf(E entry)
<C extends Consumer<? super E>> C	intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C 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 entry)
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)
static <E> ConstHashEnum<E>	New()
static <E> ConstHashEnum<E>	New(E... entries)
static <E> ConstHashEnum<E>	New(XGettingCollection<? extends E> entries)
static <E> ConstHashEnum<E>	NewCustom(float hashDensity, E... entries)
static <E> ConstHashEnum<E>	NewCustom(float hashDensity, XGettingCollection<? extends E> entries)
static <E> ConstHashEnum<E>	NewCustom(int initialCapacity)
static <E> ConstHashEnum<E>	NewCustom(int initialCapacity, float hashDensity)
boolean	nullAllowed()
boolean	nullContained()
OldSet<E>	old()
E	peek()
E	poll()
XImmutableEnum<E>	range(long lowIndex, long highIndex)
int	rehash()	Recalculates the hash value of all entries and reorginazes and optimizes the hash storage accordingly.
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 Predicateapplied 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.
void	setHashDensity(float hashDensity)	Sets the hash density (1/density) of this hashing collection if applicable.
long	size()
Object[]	toArray()
E[]	toArray(Class<E> type)
ConstHashEnum<E>	toReversed()
String	toString()
<C extends Consumer<? super E>> C	union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)
XGettingEnum<E>	view()
XGettingEnum<E>	view(long lowIndex, long highIndex)

Methods inherited from class one.microstream.collections.AbstractExtendedCollection

ensureFreeArrayCapacity, validateIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

containsAll, equals, hashCode, intSize

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

hasIndex

Constructor Details

ConstHashEnum

public ConstHashEnum()

Method Details

New

public static final <E> ConstHashEnum<E> New()

NewCustom

public static final <E> ConstHashEnum<E> NewCustom(int initialCapacity)

NewCustom

public static final <E> ConstHashEnum<E> NewCustom(int initialCapacity, float hashDensity)

NewCustom

public static final <E> ConstHashEnum<E> NewCustom(float hashDensity, XGettingCollection<? extends E> entries)

NewCustom

@SafeVarargs public static final <E> ConstHashEnum<E> NewCustom(float hashDensity, E... entries)

New

public static final <E> ConstHashEnum<E> New(XGettingCollection<? extends E> entries)

New

@SafeVarargs public static final <E> ConstHashEnum<E> New(E... entries)

nullAllowed

public boolean nullAllowed()

Specified by:

nullAllowed in interface ExtendedCollection<E>

size

public final long size()

Specified by:

size in interface HashCollection<E>

Specified by:

size in interface Sized

Specified by:

size in interface XGettingCollection<E>

rehash

public final int rehash()

Description copied from interface: HashCollection

Recalculates the hash value of all entries and reorginazes and optimizes the hash storage accordingly. This method is meant for cases where a hash collection has to collect its elements before proper hash values can be derived for them or where hash mutable elements can change their hash-relevant state after having been added (and hashed) in a hash collection. Note that depending on the hash-relevant state of elements and their changing of it, it can be possible that some elements oust others, thus decreasing the collection's size. This behavior depends on the type of the elements and the used hash logic and cannot be compensated by a general purpose collection implementation.

Specified by:

rehash in interface HashCollection<E>

Returns:

the new size of the collection which might be lower than before the call.

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Sized

copy

public final ConstHashEnum<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 XGettingCollection<E>

Specified by:

copy in interface XGettingEnum<E>

Specified by:

copy in interface XGettingSequence<E>

Specified by:

copy in interface XGettingSet<E>

Specified by:

copy in interface XImmutableCollection<E>

Specified by:

copy in interface XImmutableEnum<E>

Specified by:

copy in interface XImmutableSequence<E>

Specified by:

copy in interface XImmutableSet<E>

Returns:

a copy of this list

immure

public final ConstHashEnum<E> immure()

Description copied from interface: XImmutableEnum

Always returns the already immutable collection instance itself

For spawning a copy of the collection instance, see XImmutableCollection.copy()

Specified by:

immure in interface XGettingCollection<E>

Specified by:

immure in interface XGettingEnum<E>

Specified by:

immure in interface XGettingSequence<E>

Specified by:

immure in interface XGettingSet<E>

Specified by:

immure in interface XImmutableCollection<E>

Specified by:

immure in interface XImmutableEnum<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()

view

public final XGettingEnum<E> view()

Specified by:

view in interface XGettingCollection<E>

Specified by:

view in interface XGettingEnum<E>

Specified by:

view in interface XGettingSequence<E>

setHashDensity

public final void setHashDensity(float hashDensity)

Description copied from interface: HashCollection

Sets the hash density (1/density) of this hashing collection if applicable.

If this procedure is not applicable for the hash collection (e.g. an immutable hash collection), calling this method has no effect.

Specified by:

setHashDensity in interface HashCollection<E>

Parameters:

hashDensity - the new hash density to be set.

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>

Returns:

true if the collection contains volatile elements.

old

public final OldSet<E> old()

Specified by:

old in interface XGettingCollection<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

Returns:

the maximum amount of elements this carrier instance can contain.

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

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

analyze

public final HashCollection.Analysis<ConstHashEnum<E>> analyze()

Specified by:

analyze in interface HashCollection<E>

hashDistributionRange

public final int hashDistributionRange()

Specified by:

hashDistributionRange in interface HashCollection<E>

hashEquality

public final HashEqualator<E> hashEquality()

Specified by:

hashEquality in interface HashCollection<E>

hashDensity

public final float hashDensity()

Specified by:

hashDensity in interface HashCollection<E>

hasVolatileHashElements

public final boolean hasVolatileHashElements()

Specified by:

hasVolatileHashElements in interface HashCollection<E>

toString

public final String toString()

Overrides:

toString in class Object

range

public final XImmutableEnum<E> range(long lowIndex, long highIndex)

Specified by:

range in interface XGettingEnum<E>

Specified by:

range in interface XGettingSequence<E>

view

public final XGettingEnum<E> view(long lowIndex, long highIndex)

Specified by:

view in interface XGettingEnum<E>

Specified by:

view in interface XGettingSequence<E>

toArray

public final E[] toArray(Class<E> type)

Specified by:

toArray in interface XGettingCollection<E>

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>

count

public final long count(E entry)

Specified by:

count in interface XGettingCollection<E>

countBy

public final long countBy(Predicate<? super E> predicate)

Specified by:

countBy in interface XGettingCollection<E>

search

public final E search(Predicate<? super E> predicate)

Specified by:

search in interface XGettingCollection<E>

max

public final E max(Comparator<? super E> comparator)

Specified by:

max in interface XGettingCollection<E>

min

public final E min(Comparator<? super E> comparator)

Specified by:

min in interface XGettingCollection<E>

containsSearched

public final boolean containsSearched(Predicate<? super E> predicate)

Specified by:

containsSearched in interface XGettingCollection<E>

applies

public final boolean applies(Predicate<? super E> predicate)

Specified by:

applies in interface XGettingCollection<E>

nullContained

public final boolean nullContained()

Specified by:

nullContained in interface XGettingCollection<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>

Parameters:

element - the element to be searched in the collection by identity.

Returns:

whether this collection contains exactely the given element.

contains

public final boolean contains(E element)

Specified by:

contains in interface XGettingCollection<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>

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>

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>

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

intersect

public final <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)

Specified by:

intersect in interface XGettingCollection<E>

except

public final <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)

Specified by:

except in interface XGettingCollection<E>

union

public final <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)

Specified by:

union in interface XGettingCollection<E>

copyTo

public final <C extends Consumer<? super E>> C copyTo(C target)

Specified by:

copyTo in interface XGettingCollection<E>

filterTo

public final <C extends Consumer<? super E>> C filterTo(C target, Predicate<? super E> predicate)

Specified by:

filterTo in interface XGettingCollection<E>

distinct

public final <C extends Consumer<? super E>> C distinct(C target)

Specified by:

distinct in interface XGettingCollection<E>

distinct

public final <C extends Consumer<? super E>> C distinct(C target, Equalator<? super E> equalator)

Specified by:

distinct in interface XGettingCollection<E>

toReversed

public final ConstHashEnum<E> toReversed()

Specified by:

toReversed in interface XGettingEnum<E>

Specified by:

toReversed in interface XGettingSequence<E>

Specified by:

toReversed in interface XImmutableEnum<E>

Specified by:

toReversed in interface XImmutableSequence<E>

copySelection

public final <T extends Consumer<? super E>> T copySelection(T target, long... indices)

Specified by:

copySelection in interface XGettingSequence<E>

iterateIndexed

public final <P extends IndexedAcceptor<? super E>> P iterateIndexed(P procedure)

Specified by:

iterateIndexed in interface XIndexIterable<E>

at

public final E at(long index)

Specified by:

at in interface XGettingSequence<E>

get

public final 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 final E first()

Specified by:

first in interface XGettingSequence<E>

last

public final E last()

Specified by:

last in interface XGettingSequence<E>

poll

public final E poll()

Specified by:

poll in interface XGettingSequence<E>

peek

public final E peek()

Specified by:

peek in interface XGettingSequence<E>

indexOf

public final long indexOf(E entry)

Specified by:

indexOf in interface XGettingSequence<E>

indexBy

public final long indexBy(Predicate<? super E> predicate)

Specified by:

indexBy in interface XGettingSequence<E>

isSorted

public final boolean isSorted(Comparator<? super E> comparator)

Specified by:

isSorted in interface XGettingSequence<E>

lastIndexOf

public final long lastIndexOf(E entry)

Specified by:

lastIndexOf in interface XGettingSequence<E>

lastIndexBy

public final long lastIndexBy(Predicate<? super E> predicate)

Specified by:

lastIndexBy in interface XGettingSequence<E>

maxIndex

public final long maxIndex(Comparator<? super E> comparator)

Specified by:

maxIndex in interface XGettingSequence<E>

minIndex

public final long minIndex(Comparator<? super E> comparator)

Specified by:

minIndex in interface XGettingSequence<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>

Returns:

the index of the last positively tested element.

iterator

public final Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface XGettingCollection<E>

toArray

public final Object[] toArray()

Specified by:

toArray in interface XGettingCollection<E>

equality

public final HashEqualator<E> equality()

Specified by:

equality in interface XGettingCollection<E>