XProcessingBag (MicroStream API)

All Superinterfaces:

CapacityCarrying, Clearable, ConsolidatableCollection, Copyable, ExtendedBag<E>, ExtendedCollection<E>, Iterable<E>, OptimizableCollection, Processable<E>, ReleasingCollection<E>, Sized, Truncateable, XGettingBag<E>, XGettingCollection<E>, XIterable<E>, XJoinable<E>, XProcessingCollection<E>, XRemovingBag<E>, XRemovingCollection<E>

All Known Subinterfaces:

XBag<E>, XBasicList<E>, XBasicTable.Values<K,V>, XChart.Values<K,V>, XDecreasingList<E>, XLadder<E>, XList<E>, XMap.Values<K,V>, XProcessingList<E>, XProcessingMap.Values<K,V>, XTable.Values<K,V>

All Known Implementing Classes:

ArrayCollector, BulkList, EqBulkList, EqHashTable.Values, HashTable.Values, LimitList, ListProcessor, LockedList, Single, SubList, SubListProcessor, SynchList
```
public interface XProcessingBag<E>
extends XRemovingBag<E>, XGettingBag<E>, XProcessingCollection<E>
```

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface XProcessingBag.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
`XProcessingBag<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.
`XImmutableBag<E>`	`immure()`	Provides an instance of an immutable collection type with equal behavior and data as this instance.
`XGettingBag<E>`	`view()`

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 java.lang.Iterable
forEach, spliterator

Methods inherited from interface one.microstream.functional.Processable
process

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

Methods inherited from interface one.microstream.collections.types.XProcessingCollection
fetch, iterate, moveTo, pinch, removeBy, removeDuplicates, retrieve, retrieveBy

Methods inherited from interface one.microstream.collections.types.XRemovingCollection
clear, consolidate, nullRemove, optimize, remove, removeAll, removeDuplicates, removeOne, retainAll, truncate

- Method Detail
  - copy
```
XProcessingBag<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>
    
    Returns:
    
    a copy of this list
  - view
```
XGettingBag<E> view()
```
    Specified by:
    
    view in interface XGettingBag<E>
    
    Specified by:
    
    view in interface XGettingCollection<E>
  - immure
```
XImmutableBag<E> immure()
```
    Description copied from interface: XGettingCollection
    
    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>
    
    Returns:
    
    an immutable copy of this collection instance.