Package one.microstream.collections

Class SingletonView<E>

java.lang.Object

one.microstream.collections.SingletonView<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>, XIndexIterable<E>, XIterable<E>, XJoinable<E>, XReferencing<E>, Referencing<E>, Copyable

public class SingletonView<E>
extends Object
implements XReferencing<E>

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.typing.Copyable

Copyable.Static

Nested classes/interfaces inherited from interface one.microstream.collections.interfaces.ExtendedCollection

ExtendedCollection.Creator<E,C extends ExtendedCollection<E>>

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

XGettingCollection.Creator<E>

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

XGettingEnum.Creator<E>

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

XGettingList.Factory<E>

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

XGettingSequence.Factory<E>

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

XIterable.Executor<E>

Constructor Summary

Constructors

Constructor	Description
SingletonView(Singleton<E> subject)

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)
SingletonView<E>	copy()	Creates a true copy of this list which references th same elements in the same order as this list does at the time the method is called.
<T extends Consumer<? super E>> T	copySelection(T target, long... indices)
<T extends Consumer<? super E>> T	copyTo(T target)
long	count(E element)
long	countBy(Predicate<? super E> predicate)
<T extends Consumer<? super E>> T	distinct(T target)
<T extends Consumer<? super E>> T	distinct(T target, Equalator<? super E> equalator)
Equalator<? super E>	equality()
boolean	equals(Object obj)	Performs an equality comparison according to the specification in Collection.
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.
<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 the first element in the collection.
int	hashCode()
boolean	hasVolatileElements()	Tells if this collection contains volatile elements. An element is volatile, if it can become no longer reachable by the collection without being removed from the collection.
Constant<E>	immure()	Provides an instance of an immutable collection type with equal behavior and data as this instance.
long	indexBy(Predicate<? super E> predicate)
long	indexOf(E element)
<T extends Consumer<? super E>> T	intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)
boolean	isEmpty()
boolean	isFull()	Returns true if the current capacity cannot be increased any more.
boolean	isSorted(Comparator<? super E> comparator)
<P extends Consumer<? super E>> P	iterate(P procedure)
<P extends IndexedAcceptor<? super E>> P	iterateIndexed(P procedure)
Iterator<E>	iterator()
<A> A	join(BiConsumer<? super E,? super A> joiner, A aggregate)
E	last()
long	lastIndexBy(Predicate<? super E> predicate)
long	lastIndexOf(E element)
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(long index)
E	max(Comparator<? super E> comparator)
long	maximumCapacity()	Returns the maximum amount of elements this carrier instance can contain. The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g.
long	maxIndex(Comparator<? super E> comparator)
E	min(Comparator<? super E> comparator)
long	minIndex(Comparator<? super E> comparator)
boolean	nullAllowed()
boolean	nullContained()
one.microstream.collections.Singleton.OldSingleton	old()
E	peek()
E	poll()
SingletonView<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 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.
long	size()
Object[]	toArray()
E[]	toArray(Class<E> type)
SingletonView<E>	toReversed()
String	toString()
<T extends Consumer<? super E>> T	union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)
SingletonView<E>	view()
SingletonView<E>	view(long lowIndex, long highIndex)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

intSize

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

hasIndex

Constructor Details

SingletonView

public SingletonView(Singleton<E> subject)

Method Details

hashCode

public int hashCode()

Specified by:

hashCode in interface XGettingCollection<E>

Overrides:

hashCode in class Object

get

public E get()

Description copied from interface: XGettingSequence

Gets the first element in the collection. This is a parameterless alias vor at(0).

first() is an alias for this method for consistency reasons with last().

Specified by:

get in interface Referencing<E>

Specified by:

get in interface XGettingCollection<E>

Specified by:

get in interface XGettingSequence<E>

Specified by:

get in interface XReferencing<E>

Returns:

the first element.

See Also:

XGettingSequence.at(long), XGettingSequence.first(), XGettingSequence.last()

copy

public SingletonView<E> copy()

Description copied from interface: XGettingSequence

Creates a true copy of this list which references th same elements in the same order as this list does at the time the method is called. The elements themselves are NOT copied (no deep copying).
The type of the returned list is the same as of this list if possible (i.e.: a SubList can not meaningful return a true copy that references its elements but still is a SubList)

Specified by:

copy in interface Copyable

Specified by:

copy in interface XGettingBag<E>

Specified by:

copy in interface XGettingCollection<E>

Specified by:

copy in interface XGettingEnum<E>

Specified by:

copy in interface XGettingList<E>

Specified by:

copy in interface XGettingSequence<E>

Specified by:

copy in interface XGettingSet<E>

Specified by:

copy in interface XReferencing<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>

iterateIndexed

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

Specified by:

iterateIndexed in interface XIndexIterable<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>

immure

public Constant<E> immure()

Description copied from interface: XGettingList

Provides an instance of an immutable collection type with equal behavior and data as this instance.

If this instance already is of an immutable collection type, it returns itself.

Specified by:

immure in interface XGettingBag<E>

Specified by:

immure in interface XGettingCollection<E>

Specified by:

immure in interface XGettingEnum<E>

Specified by:

immure in interface XGettingList<E>

Specified by:

immure in interface XGettingSequence<E>

Specified by:

immure in interface XGettingSet<E>

Specified by:

immure in interface XReferencing<E>

Returns:

an immutable copy of this collection instance.

listIterator

public ListIterator<E> listIterator()

Specified by:

listIterator in interface XGettingList<E>

Specified by:

listIterator in interface XReferencing<E>

equals

public boolean equals(Object obj)

Description copied from interface: XGettingCollection

Performs an equality comparison according to the specification in Collection.

Note that it is this interface's author opinion that the whole concept of equals() in standard Java, especially in the collection implementations, is flawed.
The reason is because all different kinds of comparison types that actually depend on the situation have to be mixed up in a harcoded fashion in one method, from identity comparison over data indentity comparison to content comparison.
In order to get the right behavior in every situation, one has to distinct between different types of equality

This means several things:
1.) You can't just say for example an ArrayList is the "same" as a LinkedList just because they contain the same content.
There are different implementations for a good reason, so you have to distinct them when comparing. There are simple code examples which create massive misbehavior that will catastrophically ruin the runtime behavior of a programm due to this error in Java / JDK / Sun / whatever.
2.) You can't always determine equality of two collections by determining equality of each element as Collection defines it.

As a conclusion: don't use this method!
Be clear what type of comparison you really need, then use one of the following methods and proper comparators:
XGettingCollection.equals(XGettingCollection,Equalator)
XGettingCollection.equalsContent(XGettingCollection,Equalator)

Specified by:

equals in interface XGettingCollection<E>

Overrides:

equals in class Object

listIterator

public ListIterator<E> listIterator(long index)

Specified by:

listIterator in interface XGettingList<E>

Specified by:

listIterator in interface XReferencing<E>

old

public one.microstream.collections.Singleton.OldSingleton old()

Specified by:

old in interface XGettingCollection<E>

Specified by:

old in interface XGettingList<E>

Specified by:

old in interface XReferencing<E>

range

public SingletonView<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 XReferencing<E>

toReversed

public SingletonView<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 XReferencing<E>

copySelection

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

Specified by:

copySelection in interface XGettingSequence<E>

Specified by:

copySelection in interface XReferencing<E>

first

public E first()

Specified by:

first in interface XGettingSequence<E>

Specified by:

first in interface XReferencing<E>

at

public E at(long index)

Specified by:

at in interface XGettingSequence<E>

Specified by:

at in interface XReferencing<E>

indexOf

public long indexOf(E element)

Specified by:

indexOf in interface XGettingSequence<E>

Specified by:

indexOf in interface XReferencing<E>

indexBy

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

Specified by:

indexBy in interface XGettingSequence<E>

Specified by:

indexBy in interface XReferencing<E>

isSorted

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

Specified by:

isSorted in interface XGettingSequence<E>

Specified by:

isSorted in interface XReferencing<E>

last

public E last()

Specified by:

last in interface XGettingSequence<E>

Specified by:

last in interface XReferencing<E>

lastIndexOf

public long lastIndexOf(E element)

Specified by:

lastIndexOf in interface XGettingSequence<E>

Specified by:

lastIndexOf in interface XReferencing<E>

lastIndexBy

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

Specified by:

lastIndexBy in interface XGettingSequence<E>

Specified by:

lastIndexBy in interface XReferencing<E>

maxIndex

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

Specified by:

maxIndex in interface XGettingSequence<E>

Specified by:

maxIndex in interface XReferencing<E>

minIndex

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

Specified by:

minIndex in interface XGettingSequence<E>

Specified by:

minIndex in interface XReferencing<E>

peek

public E peek()

Specified by:

peek in interface XGettingSequence<E>

Specified by:

peek in interface XReferencing<E>

poll

public E poll()

Specified by:

poll in interface XGettingSequence<E>

Specified by:

poll in interface XReferencing<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>

Specified by:

scan in interface XReferencing<E>

Returns:

the index of the last positively tested element.

view

public SingletonView<E> view()

Specified by:

view in interface XGettingBag<E>

Specified by:

view in interface XGettingCollection<E>

Specified by:

view in interface XGettingEnum<E>

Specified by:

view in interface XGettingList<E>

Specified by:

view in interface XGettingSequence<E>

Specified by:

view in interface XReferencing<E>

view

public SingletonView<E> view(long lowIndex, long highIndex)

Specified by:

view in interface XGettingEnum<E>

Specified by:

view in interface XGettingList<E>

Specified by:

view in interface XGettingSequence<E>

Specified by:

view in interface XReferencing<E>

containsSearched

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

Specified by:

containsSearched in interface XGettingCollection<E>

Specified by:

containsSearched in interface XReferencing<E>

applies

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

Specified by:

applies in interface XGettingCollection<E>

Specified by:

applies in interface XReferencing<E>

contains

public boolean contains(E element)

Specified by:

contains in interface XGettingCollection<E>

Specified by:

contains in interface XReferencing<E>

containsAll

public boolean containsAll(XGettingCollection<? extends E> elements)

Specified by:

containsAll in interface XGettingCollection<E>

Specified by:

containsAll in interface XReferencing<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>

Specified by:

containsId in interface XReferencing<E>

Parameters:

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

Returns:

whether this collection contains exactely the given element.

copyTo

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

Specified by:

copyTo in interface XGettingCollection<E>

Specified by:

copyTo in interface XReferencing<E>

filterTo

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

Specified by:

filterTo in interface XGettingCollection<E>

Specified by:

filterTo in interface XReferencing<E>

count

public long count(E element)

Specified by:

count in interface XGettingCollection<E>

Specified by:

count in interface XReferencing<E>

countBy

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

Specified by:

countBy in interface XGettingCollection<E>

Specified by:

countBy in interface XReferencing<E>

distinct

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

Specified by:

distinct in interface XGettingCollection<E>

Specified by:

distinct in interface XReferencing<E>

distinct

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

Specified by:

distinct in interface XGettingCollection<E>

Specified by:

distinct in interface XReferencing<E>

toString

public String toString()

Overrides:

toString in class Object

equality

public Equalator<? super E> equality()

Specified by:

equality in interface XGettingCollection<E>

Specified by:

equality in interface XReferencing<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>

Specified by:

equals in interface XReferencing<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>

Specified by:

equalsContent in interface XReferencing<E>

equalator - the equalator to use to determine the equality of each element

Returns:

true if this list is equal to the passed list, false otherwise

except

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

Specified by:

except in interface XGettingCollection<E>

Specified by:

except in interface XReferencing<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>

Specified by:

hasVolatileElements in interface XReferencing<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>

Specified by:

intersect in interface XReferencing<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Sized

Specified by:

isEmpty in interface XReferencing<E>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface XGettingCollection<E>

Specified by:

iterator in interface XReferencing<E>

max

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

Specified by:

max in interface XGettingCollection<E>

Specified by:

max in interface XReferencing<E>

min

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

Specified by:

min in interface XGettingCollection<E>

Specified by:

min in interface XReferencing<E>

nullContained

public boolean nullContained()

Specified by:

nullContained in interface XGettingCollection<E>

Specified by:

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

Specified by:

seek in interface XReferencing<E>

search

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

Specified by:

search in interface XGettingCollection<E>

Specified by:

search in interface XReferencing<E>

size

public long size()

Specified by:

size in interface Sized

Specified by:

size in interface XGettingCollection<E>

Specified by:

size in interface XReferencing<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface XGettingCollection<E>

Specified by:

toArray in interface XReferencing<E>

toArray

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

Specified by:

toArray in interface XGettingCollection<E>

Specified by:

toArray in interface XReferencing<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>

Specified by:

union in interface XReferencing<E>

nullAllowed

public boolean nullAllowed()

Specified by:

nullAllowed in interface ExtendedCollection<E>

Specified by:

nullAllowed in interface XReferencing<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

Specified by:

remainingCapacity in interface XReferencing<E>

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

Specified by:

isFull in interface XReferencing<E>

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

Specified by:

maximumCapacity in interface XReferencing<E>

Returns:

the maximum amount of elements this carrier instance can contain.