java.lang.Object
- one.microstream.collections.LockedCollection<E>

All Implemented Interfaces:

Iterable<E>, Consumer<E>, CapacityCarrying, CapacityExtendable, ConsolidatableCollection, ExtendedCollection<E>, OptimizableCollection, ReleasingCollection<E>, Sized, Truncateable, XAddGetCollection<E>, XAddingCollection<E>, XCollection<E>, XGettingCollection<E>, XIterable<E>, XJoinable<E>, XProcessingCollection<E>, XPutGetCollection<E>, XPuttingCollection<E>, XRemovingCollection<E>, Synchronized, ThreadSafe, Processable<E>, Clearable, Copyable
```
public final class LockedCollection<E>
extends Object
implements XCollection<E>, Synchronized
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class LockedCollection.OldMutexCollection<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.XCollection
  XCollection.Factory<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>
- Nested classes/interfaces inherited from interface one.microstream.collections.types.XPutGetCollection
  XPutGetCollection.Creator<E>

Constructor Summary

Constructors
Constructor Description

LockedCollection(XCollection<E> collection)

LockedCollection(XCollection<E> collection, Object lock)

Method Summary

Modifier and Type	Method	Description
`void`	`accept(E e)`
`boolean`	`add(E e)`
`LockedCollection<E>`	`addAll(E... elements)`
`LockedCollection<E>`	`addAll(E[] elements, int offset, int length)`
`LockedCollection<E>`	`addAll(XGettingCollection<? extends E> elements)`
`boolean`	`applies(Predicate<? super E> predicate)`
`void`	`clear()`	Clears all elements from the collection while leaving the capacity as it is.
`long`	`consolidate()`	Consolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore.
`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)`
`LockedCollection<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.
`<C extends Consumer<? super E>> C`	`copyTo(C target)`
`long`	`count(E element)`
`long`	`countBy(Predicate<? super E> predicate)`
`long`	`currentCapacity()`	Returns the current amount of elements this instance can hold before a storage rebuild becomes necessary.
`<C extends Consumer<? super E>> C`	`distinct(C target)`
`<C extends Consumer<? super E>> C`	`distinct(C target, Equalator<? super E> equalator)`
`LockedCollection<E>`	`ensureCapacity(long minimalCapacity)`
`LockedCollection<E>`	`ensureFreeCapacity(long minimalFreeCapacity)`	Ensures that the next minimalFreeCapacity elements can be actually added in a fast way, meaning for example no internal storage rebuild will be necessary.
`Equalator<? super E>`	`equality()`
`boolean`	`equals(Object o)`	Deprecated.
`boolean`	`equals(XGettingCollection<? extends E> samples, Equalator<? super E> equalator)`	Returns `true` if the passed collection is of the same type as this collection and`this.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.
`<C extends Consumer<? super E>> C`	`except(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)`
`E`	`fetch()`
`<C extends Consumer<? super E>> C`	`filterTo(C target, Predicate<? super E> predicate)`
`E`	`get()`	Gets one element from the collection.
`int`	`hashCode()`	Deprecated.
`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.
`XImmutableCollection<E>`	`immure()`	Provides an instance of an immutable collection type with equal behavior and data as this instance.
`<C extends Consumer<? super E>> C`	`intersect(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)`
`boolean`	`isEmpty()`
`boolean`	`isFull()`	Returns true if the current capacity cannot be increased any more.
`<P extends Consumer<? super E>> P`	`iterate(P procedure)`
`Iterator<E>`	`iterator()`
`<A> A`	`join(BiConsumer<? super E,? super A> joiner, A aggregate)`
`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.
`E`	`min(Comparator<? super E> comparator)`
`<C extends Consumer<? super E>> C`	`moveTo(C target, Predicate<? super E> predicate)`
`boolean`	`nullAdd()`
`boolean`	`nullAllowed()`
`boolean`	`nullContained()`
`boolean`	`nullPut()`
`long`	`nullRemove()`
`LockedCollection.OldMutexCollection<E>`	`old()`
`long`	`optimize()`	Optimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.
`E`	`pinch()`
`<P extends Consumer<? super E>> P`	`process(P procedure)`
`boolean`	`put(E e)`
`LockedCollection<E>`	`putAll(E... elements)`
`LockedCollection<E>`	`putAll(E[] elements, int offset, int length)`
`LockedCollection<E>`	`putAll(XGettingCollection<? extends E> elements)`
`long`	`remainingCapacity()`	Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.
`long`	`remove(E element)`
`long`	`removeAll(XGettingCollection<? extends E> samples)`
`long`	`removeBy(Predicate<? super E> predicate)`
`long`	`removeDuplicates()`
`long`	`removeDuplicates(Equalator<? super E> equalator)`
`boolean`	`removeOne(E element)`
`long`	`retainAll(XGettingCollection<? extends E> samples)`
`E`	`retrieve(E element)`
`E`	`retrieveBy(Predicate<? super E> predicate)`
`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)`
`void`	`truncate()`	Clears (and reinitializes if needed) this collection in the fastest possible way, i.e.
`<C extends Consumer<? super E>> C`	`union(XGettingCollection<? extends E> other, Equalator<? super E> equalator, C target)`
`View<E>`	`view()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface one.microstream.collections.interfaces.CapacityExtendable
currentFreeCapacity

Methods inherited from interface java.util.function.Consumer
andThen

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface one.microstream.collections.types.XCollection
collector

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

- Constructor Detail
  - LockedCollection
```
public LockedCollection(XCollection<E> collection)
```
  - LockedCollection
```
public LockedCollection(XCollection<E> collection,
                        Object lock)
```
- Method Detail
  - get
```
public final E get()
```
    Description copied from interface: XGettingCollection
    
    Gets one element from the collection. If the collection is not ordered XGettingSequence, then it is undefined which element is returned. If the collection is ordered, the element at index 0 is returned.
    
    Specified by:
    
    get in interface XGettingCollection<E>
    
    Returns:
    
    the first / any element.
  - equality
```
public final Equalator<? super E> equality()
```
    Specified by:
    
    equality in interface XGettingCollection<E>
  - addAll
```
@SafeVarargs
public final LockedCollection<E> addAll(E... elements)
```
    Specified by:
    
    addAll in interface XAddGetCollection<E>
    
    Specified by:
    
    addAll in interface XAddingCollection<E>
    
    Specified by:
    
    addAll in interface XCollection<E>
    
    Specified by:
    
    addAll in interface XPutGetCollection<E>
  - nullAdd
```
public final boolean nullAdd()
```
    Specified by:
    
    nullAdd in interface XAddingCollection<E>
  - add
```
public final boolean add(E e)
```
    Specified by:
    
    add in interface XAddingCollection<E>
  - addAll
```
public final LockedCollection<E> addAll(E[] elements,
                                        int offset,
                                        int length)
```
    Specified by:
    
    addAll in interface XAddGetCollection<E>
    
    Specified by:
    
    addAll in interface XAddingCollection<E>
    
    Specified by:
    
    addAll in interface XCollection<E>
    
    Specified by:
    
    addAll in interface XPutGetCollection<E>
  - addAll
```
public final LockedCollection<E> addAll(XGettingCollection<? extends E> elements)
```
    Specified by:
    
    addAll in interface XAddGetCollection<E>
    
    Specified by:
    
    addAll in interface XAddingCollection<E>
    
    Specified by:
    
    addAll in interface XCollection<E>
    
    Specified by:
    
    addAll in interface XPutGetCollection<E>
  - nullPut
```
public final boolean nullPut()
```
    Specified by:
    
    nullPut in interface XPuttingCollection<E>
  - accept
```
public final void accept(E e)
```
    Specified by:
    
    accept in interface Consumer<E>
    
    Specified by:
    
    accept in interface XAddingCollection<E>
  - put
```
public final boolean put(E e)
```
    Specified by:
    
    put in interface XPuttingCollection<E>
  - putAll
```
@SafeVarargs
public final LockedCollection<E> putAll(E... elements)
```
    Specified by:
    
    putAll in interface XCollection<E>
    
    Specified by:
    
    putAll in interface XPutGetCollection<E>
    
    Specified by:
    
    putAll in interface XPuttingCollection<E>
  - putAll
```
public final LockedCollection<E> putAll(E[] elements,
                                        int offset,
                                        int length)
```
    Specified by:
    
    putAll in interface XCollection<E>
    
    Specified by:
    
    putAll in interface XPutGetCollection<E>
    
    Specified by:
    
    putAll in interface XPuttingCollection<E>
  - putAll
```
public final LockedCollection<E> putAll(XGettingCollection<? extends E> elements)
```
    Specified by:
    
    putAll in interface XCollection<E>
    
    Specified by:
    
    putAll in interface XPutGetCollection<E>
    
    Specified by:
    
    putAll in interface XPuttingCollection<E>
  - containsSearched
```
public final boolean containsSearched(Predicate<? super E> predicate)
```
    Specified by:
    
    containsSearched in interface XGettingCollection<E>
  - applies
```
public final boolean applies(Predicate<? super E> predicate)
```
    Specified by:
    
    applies in interface XGettingCollection<E>
  - clear
```
public final void clear()
```
    Description copied from interface: XRemovingCollection
    
    Clears all elements from the collection while leaving the capacity as it is.
    
    Specified by:
    
    clear in interface Clearable
    
    Specified by:
    
    clear in interface XRemovingCollection<E>
  - consolidate
```
public final long consolidate()
```
    Description copied from interface: XRemovingCollection
    
    Consolidates the internal storage of this collection by discarding all elements of the internal storage that have become obsolete or otherwise unneeded anymore. (e.g. WeakReference entries whose reference has been cleared).
    If this is not possible or not needed in the concrete implementation, this method does nothing and returns 0.
    
    Specified by:
    
    consolidate in interface ConsolidatableCollection
    
    Specified by:
    
    consolidate in interface XRemovingCollection<E>
    
    Returns:
    
    the number of discarded entries.
  - contains
```
public final boolean contains(E element)
```
    Specified by:
    
    contains in interface XGettingCollection<E>
  - containsAll
```
public final boolean containsAll(XGettingCollection<? extends E> elements)
```
    Specified by:
    
    containsAll in interface XGettingCollection<E>
  - containsId
```
public final 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.
  - filterTo
```
public final <C extends Consumer<? super E>> C filterTo(C target,
                                                        Predicate<? super E> predicate)
```
    Specified by:
    
    filterTo in interface XGettingCollection<E>
  - copyTo
```
public final <C extends Consumer<? super E>> C copyTo(C target)
```
    Specified by:
    
    copyTo in interface XGettingCollection<E>
  - count
```
public final long count(E element)
```
    Specified by:
    
    count in interface XGettingCollection<E>
  - countBy
```
public final long countBy(Predicate<? super E> predicate)
```
    Specified by:
    
    countBy in interface XGettingCollection<E>
  - distinct
```
public final <C extends Consumer<? super E>> C distinct(C target,
                                                        Equalator<? super E> equalator)
```
    Specified by:
    
    distinct in interface XGettingCollection<E>
  - distinct
```
public final <C extends Consumer<? super E>> C distinct(C target)
```
    Specified by:
    
    distinct in interface XGettingCollection<E>
  - ensureFreeCapacity
```
public final LockedCollection<E> ensureFreeCapacity(long minimalFreeCapacity)
```
    Description copied from interface: CapacityExtendable
    
    Ensures that the next minimalFreeCapacity elements can be actually added in a fast way, meaning for example no internal storage rebuild will be necessary.
    
    Specified by:
    
    ensureFreeCapacity in interface CapacityExtendable
  - ensureCapacity
```
public final LockedCollection<E> ensureCapacity(long minimalCapacity)
```
    Specified by:
    
    ensureCapacity in interface CapacityExtendable
  - equals
```
@Deprecated
public final boolean equals(Object o)
```
    Deprecated.
    
    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
  - equals
```
public final 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 final 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 final <C extends Consumer<? super E>> C except(XGettingCollection<? extends E> other,
                                                      Equalator<? super E> equalator,
                                                      C target)
```
    Specified by:
    
    except in interface XGettingCollection<E>
  - iterate
```
public final <P extends Consumer<? super E>> P iterate(P procedure)
```
    Specified by:
    
    iterate in interface XIterable<E>
    
    Specified by:
    
    iterate in interface XProcessingCollection<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>
  - hashCode
```
@Deprecated
public final int hashCode()
```
    Deprecated.
    
    Specified by:
    
    hashCode in interface XGettingCollection<E>
    
    Overrides:
    
    hashCode in class Object
  - hasVolatileElements
```
public final 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 final <C extends Consumer<? super E>> C intersect(XGettingCollection<? extends E> other,
                                                         Equalator<? super E> equalator,
                                                         C target)
```
    Specified by:
    
    intersect in interface XGettingCollection<E>
  - isEmpty
```
public final boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Sized
  - iterator
```
public final Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface XGettingCollection<E>
  - max
```
public final E max(Comparator<? super E> comparator)
```
    Specified by:
    
    max in interface XGettingCollection<E>
  - min
```
public final E min(Comparator<? super E> comparator)
```
    Specified by:
    
    min in interface XGettingCollection<E>
  - moveTo
```
public final <C extends Consumer<? super E>> C moveTo(C target,
                                                      Predicate<? super E> predicate)
```
    Specified by:
    
    moveTo in interface XProcessingCollection<E>
  - process
```
public final <P extends Consumer<? super E>> P process(P procedure)
```
    Specified by:
    
    process in interface Processable<E>
  - fetch
```
public final E fetch()
```
    Specified by:
    
    fetch in interface XProcessingCollection<E>
  - pinch
```
public final E pinch()
```
    Specified by:
    
    pinch in interface XProcessingCollection<E>
  - removeBy
```
public final long removeBy(Predicate<? super E> predicate)
```
    Specified by:
    
    removeBy in interface XProcessingCollection<E>
  - retrieve
```
public final E retrieve(E element)
```
    Specified by:
    
    retrieve in interface XProcessingCollection<E>
  - retrieveBy
```
public final E retrieveBy(Predicate<? super E> predicate)
```
    Specified by:
    
    retrieveBy in interface XProcessingCollection<E>
  - removeOne
```
public final boolean removeOne(E element)
```
    Specified by:
    
    removeOne in interface XRemovingCollection<E>
  - remove
```
public final long remove(E element)
```
    Specified by:
    
    remove in interface XRemovingCollection<E>
  - removeAll
```
public final long removeAll(XGettingCollection<? extends E> samples)
```
    Specified by:
    
    removeAll in interface XRemovingCollection<E>
  - removeDuplicates
```
public final long removeDuplicates(Equalator<? super E> equalator)
```
    Specified by:
    
    removeDuplicates in interface XProcessingCollection<E>
  - removeDuplicates
```
public final long removeDuplicates()
```
    Specified by:
    
    removeDuplicates in interface XRemovingCollection<E>
  - retainAll
```
public final long retainAll(XGettingCollection<? extends E> samples)
```
    Specified by:
    
    retainAll in interface XRemovingCollection<E>
  - seek
```
public final 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 final E search(Predicate<? super E> predicate)
```
    Specified by:
    
    search in interface XGettingCollection<E>
  - optimize
```
public final long optimize()
```
    Description copied from interface: OptimizableCollection
    
    Optimizes the internal storage of this collection and returns the storage size of the collection after the process is complete.
    
    Specified by:
    
    optimize in interface OptimizableCollection
    
    Specified by:
    
    optimize in interface XRemovingCollection<E>
    
    Returns:
    
    the storage size of the collection after the optimzation.
  - size
```
public final long size()
```
    Specified by:
    
    size in interface Sized
    
    Specified by:
    
    size in interface XGettingCollection<E>
  - toArray
```
public final Object[] toArray()
```
    Specified by:
    
    toArray in interface XGettingCollection<E>
  - toArray
```
public final E[] toArray(Class<E> type)
```
    Specified by:
    
    toArray in interface XGettingCollection<E>
  - truncate
```
public final void truncate()
```
    Description copied from interface: XRemovingCollection
    
    Clears (and reinitializes if needed) this collection in the fastest possible way, i.e. by allocating a new and empty internal storage of default capacity. The collection will be empty after calling this method.
    
    Specified by:
    
    truncate in interface Truncateable
    
    Specified by:
    
    truncate in interface XRemovingCollection<E>
  - union
```
public final <C extends Consumer<? super E>> C union(XGettingCollection<? extends E> other,
                                                     Equalator<? super E> equalator,
                                                     C target)
```
    Specified by:
    
    union in interface XGettingCollection<E>
  - currentCapacity
```
public final long currentCapacity()
```
    Description copied from interface: CapacityExtendable
    
    Returns the current amount of elements this instance can hold before a storage rebuild becomes necessary.
    For carrier implementations that don't have a concept of storage rebuilding (like linked list for example) this method returns the same value as CapacityCarrying.maximumCapacity().
    
    Specified by:
    
    currentCapacity in interface CapacityExtendable
    
    Returns:
    
    the current capacity of this instance before a rebuild is required.
  - maximumCapacity
```
public final 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.
  - isFull
```
public final boolean isFull()
```
    Description copied from interface: CapacityCarrying
    
    Returns true if the current capacity cannot be increased any more.
    
    Specified by:
    
    isFull in interface CapacityCarrying
  - remainingCapacity
```
public final 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
  - nullAllowed
```
public final boolean nullAllowed()
```
    Specified by:
    
    nullAllowed in interface ExtendedCollection<E>
  - nullContained
```
public final boolean nullContained()
```
    Specified by:
    
    nullContained in interface XGettingCollection<E>
  - nullRemove
```
public final long nullRemove()
```
    Specified by:
    
    nullRemove in interface XRemovingCollection<E>
  - copy
```
public final LockedCollection<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 XAddGetCollection<E>
    
    Specified by:
    
    copy in interface XCollection<E>
    
    Specified by:
    
    copy in interface XGettingCollection<E>
    
    Specified by:
    
    copy in interface XPutGetCollection<E>
    
    Returns:
    
    a copy of this list
  - immure
```
public final XImmutableCollection<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 XGettingCollection<E>
    
    Returns:
    
    an immutable copy of this collection instance.
  - view
```
public final View<E> view()
```
    Specified by:
    
    view in interface XGettingCollection<E>
  - old
```
public final LockedCollection.OldMutexCollection<E> old()
```
    Specified by:
    
    old in interface XGettingCollection<E>

Constructor	Description
`LockedCollection(XCollection<E> collection)`
`LockedCollection(XCollection<E> collection, Object lock)`

Class LockedCollection<E>

Nested Class Summary

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

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

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

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

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

Methods inherited from interface java.lang.Iterable

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

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

Constructor Detail

LockedCollection

LockedCollection

Method Detail

get

equality

addAll

nullAdd

add

addAll

addAll

nullPut

accept

put

putAll

putAll

putAll

containsSearched

applies

clear

consolidate

contains

containsAll

containsId

filterTo

copyTo

count

countBy

distinct

distinct

ensureFreeCapacity

ensureCapacity

equals

equals

equalsContent

except

iterate

join

hashCode

hasVolatileElements

intersect

isEmpty

iterator

max

min

moveTo

process

fetch

pinch

removeBy

retrieve

retrieveBy

removeOne

remove

removeAll

removeDuplicates

removeDuplicates

retainAll

seek

search

optimize

size

toArray

toArray