Package one.microstream.collections.types

Interface XImmutableList<E>

All Superinterfaces:

CapacityCarrying, Copyable, ExtendedBag<E>, ExtendedCollection<E>, ExtendedList<E>, ExtendedSequence<E>, HashImmutable, Immutable, Iterable<E>, Sized, ThreadSafe, XGettingBag<E>, XGettingCollection<E>, XGettingList<E>, XGettingSequence<E>, XImmutableBag<E>, XImmutableCollection<E>, XImmutableSequence<E>, XIndexIterable<E>, XIterable<E>, XJoinable<E>

All Known Subinterfaces:

XImmutableTable.Values<K,V>

All Known Implementing Classes:

Constant, ConstHashTable.Values, ConstList, Empty, EqConstHashTable.Values, EqConstList, LinkingReferencing.Default

public interface XImmutableList<E>
extends XImmutableSequence<E>, XImmutableBag<E>, XGettingList<E>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	XImmutableList.Factory<E>

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

XIterable.Executor<E>

Method Summary

Modifier and Type	Method	Description
XImmutableList<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.
XImmutableList<E>	immure()	Always returns the already immutable collection instance itself
XImmutableList<E>	range(long fromIndex, long toIndex)
XImmutableList<E>	toReversed()	Creates a new XGettingSequence with the reversed order of elements.
XImmutableList<E>	view()	Creates a view of this collection and returns it.
XImmutableList<E>	view(long lowIndex, long highIndex)	Creates a sub-view of this collection and returns it.

Methods inherited from interface one.microstream.collections.interfaces.CapacityCarrying

isFull, maximumCapacity, remainingCapacity

Methods inherited from interface one.microstream.collections.interfaces.ExtendedCollection

nullAllowed

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

isEmpty

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

applies, contains, containsAll, containsId, containsSearched, copyTo, count, countBy, distinct, distinct, equality, equals, equals, equalsContent, except, filterTo, hashCode, hasVolatileElements, intersect, intSize, iterator, join, max, min, nullContained, search, seek, size, toArray, toArray, union

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

listIterator, listIterator, old

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

at, copySelection, first, get, hasIndex, indexBy, indexOf, isSorted, last, lastIndexBy, lastIndexOf, maxIndex, minIndex, peek, poll, scan

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

iterateIndexed

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

iterate

Method Details

copy

XImmutableList<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 XGettingBag<E>

Specified by:

copy in interface XGettingCollection<E>

Specified by:

copy in interface XGettingList<E>

Specified by:

copy in interface XGettingSequence<E>

Specified by:

copy in interface XImmutableBag<E>

Specified by:

copy in interface XImmutableCollection<E>

Specified by:

copy in interface XImmutableSequence<E>

Returns:

a copy of this list

immure

XImmutableList<E> immure()

Always returns the already immutable collection instance itself

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

Specified by:

immure in interface XGettingBag<E>

Specified by:

immure in interface XGettingCollection<E>

Specified by:

immure in interface XGettingList<E>

Specified by:

immure in interface XGettingSequence<E>

Specified by:

immure in interface XImmutableBag<E>

Specified by:

immure in interface XImmutableCollection<E>

Specified by:

immure in interface XImmutableSequence<E>

Returns:

a reference to the instance itself.

See Also:

XImmutableCollection.copy()

toReversed

XImmutableList<E> toReversed()

Description copied from interface: XGettingSequence

Creates a new XGettingSequence with the reversed order of elements.

This method creates a new collection and does not change the existing collection.

Specified by:

toReversed in interface XGettingList<E>

Specified by:

toReversed in interface XGettingSequence<E>

Specified by:

toReversed in interface XImmutableSequence<E>

Returns:

New copy of the collection

range

XImmutableList<E> range(long fromIndex, long toIndex)

Specified by:

range in interface XGettingList<E>

Specified by:

range in interface XGettingSequence<E>

view

XImmutableList<E> view()

Description copied from interface: XGettingCollection

Creates a view of this collection and returns it. It is a read-only collection, which wraps around this collection and only allows read methods.

A view is different from immutable collection (XGettingCollection.immure()) in the way, that changes in this collection are still affecting the view. The immutable collection on the other hand has no reference to this collection and changes therefore do not affect the immutable collection.

Specified by:

view in interface XGettingBag<E>

Specified by:

view in interface XGettingCollection<E>

Specified by:

view in interface XGettingList<E>

Specified by:

view in interface XGettingSequence<E>

Returns:

new read-only collection to view this collection

view

XImmutableList<E> view(long lowIndex, long highIndex)

Description copied from interface: XGettingSequence

Creates a sub-view of this collection and returns it. It is a read-only collection, which wraps around this collection and only allows read methods.
The view is limited to a range from the lowIndex to the highIndex.

A view is different from immutable collection (XGettingCollection.immure()) in the way, that changes in this collection are still affecting the view. The immutable collection on the other hand has no reference to this collection and changes therefore do not affect the immutable collection.

Specified by:

view in interface XGettingList<E>

Specified by:

view in interface XGettingSequence<E>

Parameters:

lowIndex - defines lower boundary for the view of the collection.

highIndex - defines higher boundary for the view of the collection.

Returns:

new read-only collection to view a range of elements in this collection