Package one.microstream.collections.interfaces

Interface CapacityCarrying

All Superinterfaces:

Sized

All Known Subinterfaces:

CapacityExtendable, XAddGetCollection<E>, XAddGetMap<K,V>, XAddGetSet<E>, XAddingBag<E>, XAddingCollection<E>, XAddingEnum<E>, XAddingList<E>, XAddingMap<K,V>, XAddingSequence<E>, XAddingSet<E>, XAddingSortation<E>, XAddingTable<K,V>, XBag<E>, XBasicEnum<E>, XBasicList<E>, XBasicSequence<E>, XBasicTable<K,V>, XBasicTable.Keys<K,V>, XBasicTable.Values<K,V>, XChart<K,V>, XChart.Keys<K,V>, XChart.Values<K,V>, XCollection<E>, XDecreasingEnum<E>, XDecreasingList<E>, XDecreasingSequence<E>, XEnum<E>, XExpandingEnum<E>, XExpandingList<E>, XExpandingSequence<E>, XExtendingEnum<E>, XExtendingList<E>, XExtendingSequence<E>, XGettingBag<E>, XGettingCollection<E>, XGettingEnum<E>, XGettingList<E>, XGettingMap<K,V>, XGettingMap.Keys<K,V>, XGettingMap.Values<K,V>, XGettingSequence<E>, XGettingSet<E>, XGettingSortation<E>, XGettingTable<K,V>, XGettingTable.Keys<K,V>, XGettingTable.Values<K,V>, XImmutableBag<E>, XImmutableCollection<E>, XImmutableEnum<E>, XImmutableEnum.Factory<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>, XIncreasingEnum<E>, XIncreasingList<E>, XIncreasingSequence<E>, XInputtingEnum<E>, XInputtingList<E>, XInputtingSequence<E>, XInsertingEnum<E>, XInsertingList<E>, XInsertingSequence<E>, XLadder<E>, XList<E>, XMap<K,V>, XMap.Keys<K,V>, XMap.Values<K,V>, XPrependingEnum<E>, XPrependingList<E>, XPrependingSequence<E>, XPreputtingEnum<E>, XPreputtingList<E>, XPreputtingSequence<E>, XProcessingBag<E>, XProcessingCollection<E>, XProcessingEnum<E>, XProcessingList<E>, XProcessingMap<K,V>, XProcessingMap.Keys<K,V>, XProcessingMap.Values<K,V>, XProcessingSequence<E>, XProcessingSet<E>, XProcessingSortation<E>, XPutGetBag<E>, XPutGetCollection<E>, XPutGetEnum<E>, XPutGetList<E>, XPutGetMap<K,V>, XPutGetSequence<E>, XPutGetSet<E>, XPutGetSortation<E>, XPuttingBag<E>, XPuttingCollection<E>, XPuttingEnum<E>, XPuttingList<E>, XPuttingMap<K,V>, XPuttingSequence<E>, XPuttingSet<E>, XPuttingSortation<E>, XRank<E>, XReference<E>, XReferencing<E>, XReplacingBag<E>, XSequence<E>, XSet<E>, XSettingEnum<E>, XSettingList<E>, XSettingSequence<E>, XSortableEnum<E>, XSortableSequence<E>, XSortation<E>, XTable<K,V>, XTable.Keys<K,V>, XTable.Values<K,V>

All Known Implementing Classes:

ArrayAccessor, ArrayCollector, ArrayView, BulkList, Collector, Constant, ConstHashEnum, ConstHashTable, ConstHashTable.Keys, ConstHashTable.Values, ConstLinearEnum, ConstList, Empty, EmptyTable, EnumProcessor, EnumView, EqBulkList, EqConstHashEnum, EqConstHashTable, EqConstHashTable.Keys, EqConstHashTable.Values, EqConstList, EqHashEnum, EqHashTable, EqHashTable.Keys, EqHashTable.Values, FixedList, HashEnum, HashTable, HashTable.Keys, HashTable.Values, LimitList, LinkingReferencing.Default, LinkReference.Default, ListAccessor, ListProcessor, ListView, LockedAdder, LockedCollection, LockedGettingMap, LockedList, LockedMap, MappedList, MapView, MutexSet, OpenAdressingMiniSet, SetView, Single, Singleton, SingletonView, SubCollector, SubList, SubListAccessor, SubListProcessor, SubListView, SubProcessor, SubView, SynchAdder, SynchCollection, SynchList, SynchSet, TableView, View

public interface CapacityCarrying
extends Sized

Method Summary

Modifier and Type	Method	Description
default boolean	isFull()	Returns true if the current capacity cannot be increased any more.
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.
default long	remainingCapacity()	Returns the amount of elements this carrier instance can collect before reaching its maximimum capacity.

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

isEmpty, size

Method Details

maximumCapacity

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. Integer.MAX_VALUE)

Returns:

the maximum amount of elements this carrier instance can contain.

remainingCapacity

default long remainingCapacity()

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

isFull

default boolean isFull()

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