XImmutableCollection (MicroStream API)

All Superinterfaces:

CapacityCarrying, Copyable, ExtendedCollection<E>, HashImmutable, Immutable, Iterable<E>, Sized, ThreadSafe, XGettingCollection<E>, XIterable<E>, XJoinable<E>

All Known Subinterfaces:

XImmutableBag<E>, XImmutableEnum<E>, XImmutableList<E>, XImmutableMap<K,V>, XImmutableMap.Keys<K,V>, XImmutableMap.Values<K,V>, XImmutableSequence<E>, XImmutableSet<E>, XImmutableTable<K,V>, XImmutableTable.Keys<K,V>, XImmutableTable.Values<K,V>

All Known Implementing Classes:

Constant, ConstHashEnum, ConstHashTable, ConstHashTable.Keys, ConstHashTable.Values, ConstLinearEnum, ConstList, Empty, EmptyTable, EqConstHashEnum, EqConstHashTable, EqConstHashTable.Keys, EqConstHashTable.Values, EqConstList, LinkingReferencing.Default
```
public interface XImmutableCollection<E>
extends XGettingCollection<E>, Immutable
```

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface XImmutableCollection.Factory<E>
- Nested classes/interfaces inherited from interface one.microstream.typing.Copyable
  Copyable.Static
- 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
`static <E> Aggregator<E,XImmutableCollection<E>>`	`Builder()`
`static <E> Aggregator<E,XImmutableCollection<E>>`	`Builder(long initialCapacity)`
`XImmutableCollection<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.
`XImmutableCollection<E>`	`immure()`	Always returns the already immutable collection instance itself

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, get, hashCode, hasVolatileElements, intersect, intSize, iterator, join, max, min, nullContained, old, search, seek, size, toArray, toArray, union, view

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

- Method Detail
  - Builder
```
static <E> Aggregator<E,XImmutableCollection<E>> Builder()
```
  - Builder
```
static <E> Aggregator<E,XImmutableCollection<E>> Builder(long initialCapacity)
```
  - copy
```
XImmutableCollection<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>
    
    Returns:
    
    a copy of this list
  - immure
```
XImmutableCollection<E> immure()
```
    Always returns the already immutable collection instance itself
    For spawning a copy of the collection instance, see copy()
    
    Specified by:
    
    immure in interface XGettingCollection<E>
    
    Returns:
    
    a reference to the instance itself.
    
    See Also:
    
    copy()