Package one.microstream.collections

Class SubView<E>

java.lang.Object

one.microstream.collections.SubView<E>

All Implemented Interfaces:

Iterable<E>, CapacityCarrying, ExtendedCollection<E>, ExtendedSequence<E>, Sized, XGettingCollection<E>, XGettingSequence<E>, XIndexIterable<E>, XIterable<E>, XJoinable<E>, Copyable

Direct Known Subclasses:

SubCollector, SubProcessor

public class SubView<E>
extends Object
implements XGettingSequence<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.XGettingSequence

XGettingSequence.Factory<E>

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

XIterable.Executor<E>

Constructor Summary

Constructors

Constructor	Description
SubView()

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)
XGettingSequence<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(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.
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.
XImmutableSequence<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)
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()
OldCollection<E>	old()
E	peek()
E	poll()
XGettingSequence<E>	range(long lowIndex, long highIndex)
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)
XGettingSequence<E>	toReversed()
<T extends Consumer<? super E>> T	union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, T target)
XGettingSequence<E>	view()
XGettingSequence<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 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 Details

SubView

public SubView()

Method Details

copy

public XGettingSequence<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 XGettingCollection<E>

Specified by:

copy in interface XGettingSequence<E>

Returns:

a copy of this list

copySelection

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

Specified by:

copySelection in interface XGettingSequence<E>

iterate

public final <P extends Consumer<? super E>> P iterate(P procedure)

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

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 XGettingCollection<E>

Specified by:

get in interface XGettingSequence<E>

Returns:

the first element.

See Also:

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

first

public E first()

Specified by:

first in interface XGettingSequence<E>

at

public E at(long index)

Specified by:

at in interface XGettingSequence<E>

immure

public XImmutableSequence<E> immure()

Description copied from interface: XGettingSequence

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 XGettingCollection<E>

Specified by:

immure in interface XGettingSequence<E>

Returns:

an immutable copy of this collection instance.

indexOf

public long indexOf(E element)

Specified by:

indexOf in interface XGettingSequence<E>

indexBy

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

Specified by:

indexBy in interface XGettingSequence<E>

isSorted

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

Specified by:

isSorted in interface XGettingSequence<E>

last

public E last()

Specified by:

last in interface XGettingSequence<E>

lastIndexOf

public long lastIndexOf(E element)

Specified by:

lastIndexOf in interface XGettingSequence<E>

lastIndexBy

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

Specified by:

lastIndexBy in interface XGettingSequence<E>

maxIndex

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

Specified by:

maxIndex in interface XGettingSequence<E>

minIndex

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

Specified by:

minIndex in interface XGettingSequence<E>

peek

public E peek()

Specified by:

peek in interface XGettingSequence<E>

poll

public E poll()

Specified by:

poll in interface XGettingSequence<E>

range

public XGettingSequence<E> range(long lowIndex, long highIndex)

Specified by:

range in interface XGettingSequence<E>

scan

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

Description copied from interface: XGettingSequence

Iterates through the collection and returns the index of the last element that the passed Predicateapplied to ("scanning").

Specified by:

scan in interface XGettingSequence<E>

Returns:

the index of the last positively tested element.

toReversed

public XGettingSequence<E> toReversed()

Specified by:

toReversed in interface XGettingSequence<E>

view

public XGettingSequence<E> view()

Specified by:

view in interface XGettingCollection<E>

Specified by:

view in interface XGettingSequence<E>

view

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

Specified by:

view in interface XGettingSequence<E>

containsSearched

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

Specified by:

containsSearched in interface XGettingCollection<E>

applies

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

Specified by:

applies in interface XGettingCollection<E>

contains

public boolean contains(E element)

Specified by:

contains in interface XGettingCollection<E>

containsAll

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

Specified by:

containsAll in interface XGettingCollection<E>

containsId

public boolean containsId(E element)

Description copied from interface: XGettingCollection

Special version of contains() that guarantees to use identity comparison (" == ") when searching for the given element regardless of the collection's internal logic.
This method has the same behavior as XGettingCollection.containsSearched(Predicate) with a Predicate implementation that checks for object identity. The only difference is a performance and usability advantage

Specified by:

containsId in interface XGettingCollection<E>

Parameters:

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

Returns:

whether this collection contains exactely the given element.

copyTo

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

Specified by:

copyTo in interface XGettingCollection<E>

filterTo

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

Specified by:

filterTo in interface XGettingCollection<E>

count

public long count(E element)

Specified by:

count in interface XGettingCollection<E>

countBy

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

Specified by:

countBy in interface XGettingCollection<E>

distinct

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

Specified by:

distinct in interface XGettingCollection<E>

distinct

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

Specified by:

distinct in interface XGettingCollection<E>

equality

public Equalator<? super E> equality()

Specified by:

equality in interface XGettingCollection<E>

equals

public boolean equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)

Description copied from interface: XGettingCollection

Returns true if the passed collection is of the same type as this collection andthis.equalsContent(list, equalator) yields true.

Specified by:

equals in interface XGettingCollection<E>

equalsContent

public boolean equalsContent(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)

Description copied from interface: XGettingCollection

Returns true if all elements of this list and the passed list are sequentially equal as defined by the passed equalator.

Note that for colletion types that don't have a defined order of elements, this method is hardly usable (as is XGettingCollection.equals(Object) for them as defined in Collection). The core problem of comparing collections that have no defined order is that they aren't really reliably comparable to any other collection.

Specified by:

equalsContent in interface XGettingCollection<E>

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

Returns:

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

except

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

Specified by:

except in interface XGettingCollection<E>

hasVolatileElements

public boolean hasVolatileElements()

Description copied from interface: XGettingCollection

Tells if this collection contains volatile elements.
An element is volatile, if it can become no longer reachable by the collection without being removed from the collection. Examples are WeakReference of SoftReference or implementations of collection entries that remove the element contained in an entry by some means outside the collection.
Note that WeakReference instances that are added to a a simple (non-volatile) implementation of a collection do NOT make the collection volatile, as the elements themselves (the reference instances) are still strongly referenced.

Specified by:

hasVolatileElements in interface ExtendedCollection<E>

Specified by:

hasVolatileElements in interface XGettingCollection<E>

Returns:

true if the collection contains volatile elements.

intersect

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

Specified by:

intersect in interface XGettingCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Sized

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface XGettingCollection<E>

max

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

Specified by:

max in interface XGettingCollection<E>

min

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

Specified by:

min in interface XGettingCollection<E>

nullContained

public boolean nullContained()

Specified by:

nullContained in interface XGettingCollection<E>

old

public OldCollection<E> old()

Specified by:

old in interface XGettingCollection<E>

seek

public E seek(E sample)

Description copied from interface: XGettingCollection

Returns the first contained element matching the passed sample as defined by the collection's equality logic or null, if no fitting element is contained. (For collections using referential equality, this method is basically just a variation of XGettingCollection.contains(Object) with a different return type. For collections with data-dependant equality, the returned element might be the same as the passed one or a data-wise equal one, depending on the content of the collection)

Specified by:

seek in interface XGettingCollection<E>

search

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

Specified by:

search in interface XGettingCollection<E>

size

public long size()

Specified by:

size in interface Sized

Specified by:

size in interface XGettingCollection<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface XGettingCollection<E>

toArray

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

Specified by:

toArray in interface XGettingCollection<E>

union

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

Specified by:

union in interface XGettingCollection<E>

nullAllowed

public boolean nullAllowed()

Specified by:

nullAllowed in interface ExtendedCollection<E>

remainingCapacity

public long remainingCapacity()

Description copied from interface: CapacityCarrying

Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.

Specified by:

remainingCapacity in interface CapacityCarrying

isFull

public boolean isFull()

Description copied from interface: CapacityCarrying

Returns true if the current capacity cannot be increased any more.

Specified by:

isFull in interface CapacityCarrying

maximumCapacity

public long maximumCapacity()

Description copied from interface: CapacityCarrying

Returns the maximum amount of elements this carrier instance can contain.
The actual value may be depend on the configuration of the concrete instance or may depend only on the implementation of the carrier (meaning it is constant for all instances of the implementation, e.g. Integer.MAX_VALUE)

Specified by:

maximumCapacity in interface CapacityCarrying

Returns:

the maximum amount of elements this carrier instance can contain.