speiger.src.collections.utils

Interface ITrimmable

All Known Subinterfaces:

IArray, IBooleanArray, IByteArray, ICharArray, IDoubleArray, IFloatArray, IIntArray, ILongArray, IObjectArray<T>, IShortArray

All Known Implementing Classes:

BooleanArrayFIFOQueue, BooleanArrayList, ByteArrayFIFOQueue, ByteArrayList, ByteLinkedOpenCustomHashSet, ByteLinkedOpenHashSet, ByteOpenCustomHashSet, ByteOpenHashSet, CharArrayFIFOQueue, CharArrayList, CharLinkedOpenCustomHashSet, CharLinkedOpenHashSet, CharOpenCustomHashSet, CharOpenHashSet, DoubleArrayFIFOQueue, DoubleArrayList, DoubleLinkedOpenCustomHashSet, DoubleLinkedOpenHashSet, DoubleOpenCustomHashSet, DoubleOpenHashSet, FloatArrayFIFOQueue, FloatArrayList, FloatLinkedOpenCustomHashSet, FloatLinkedOpenHashSet, FloatOpenCustomHashSet, FloatOpenHashSet, IntArrayFIFOQueue, IntArrayList, IntLinkedOpenCustomHashSet, IntLinkedOpenHashSet, IntOpenCustomHashSet, IntOpenHashSet, LongArrayFIFOQueue, LongArrayList, LongLinkedOpenCustomHashSet, LongLinkedOpenHashSet, LongOpenCustomHashSet, LongOpenHashSet, ObjectArrayFIFOQueue, ObjectArrayList, ObjectLinkedOpenCustomHashSet, ObjectLinkedOpenHashSet, ObjectOpenCustomHashSet, ObjectOpenHashSet, ShortArrayFIFOQueue, ShortArrayList, ShortLinkedOpenCustomHashSet, ShortLinkedOpenHashSet, ShortOpenCustomHashSet, ShortOpenHashSet

public interface ITrimmable

Interface that allows to test for if a collection is trimmable. This also allows that synchronization-wrappers are trimmable without extracting the original collection.

Method Summary

Modifier and Type	Method and Description
default void	clearAndTrim() Trims the collection down to the original size and clears all present elements with it.
void	clearAndTrim(int size) Trims the collection down to the requested size and clears all elements while doing so
default boolean	trim() Trims the original collection down to the size of the current elements
boolean	trim(int size) Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Method Detail

trim

default boolean trim()

Trims the original collection down to the size of the current elements

Returns:

if the internal array has been trimmed.

trim

boolean trim(int size)

Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Parameters:

size - the requested trim size.

Returns:

if the internal array has been trimmed.

clearAndTrim

default void clearAndTrim()

Trims the collection down to the original size and clears all present elements with it.

clearAndTrim

void clearAndTrim(int size)

Trims the collection down to the requested size and clears all elements while doing so

Parameters:

size - the amount of elements that should be allowed

Note:

this will enforce minimum size of the collection itself