Package com.illumon.iris.db.v2.sources.chunk.util.pools

Interface ChunkPool

All Known Implementing Classes:

BooleanChunkPool, ByteChunkPool, CharChunkPool, DoubleChunkPool, FloatChunkPool, IntChunkPool, LongChunkPool, ObjectChunkPool, ShortChunkPool

public interface ChunkPool

Interface for pools of Chunks.

Method Summary

Modifier and Type	Method	Description
<ATTR extends Attributes.Any> void	giveResettableChunk(ResettableReadOnlyChunk<ATTR> resettableChunk)	Return a ResettableReadOnlyChunk of to the pool.
<ATTR extends Attributes.Any> void	giveResettableWritableChunk(ResettableWritableChunk<ATTR> resettableWritableChunk)	Return a ResettableWritableChunk of to the pool.
<ATTR extends Attributes.Any> void	giveWritableChunk(WritableChunk<ATTR> writableChunk)	Return a WritableChunk to the pool.
<ATTR extends Attributes.Any> ResettableReadOnlyChunk<ATTR>	takeResettableChunk()	Take a ResettableReadOnlyChunk.
<ATTR extends Attributes.Any> ResettableWritableChunk<ATTR>	takeResettableWritableChunk()	Take a ResettableWritableChunk.
<ATTR extends Attributes.Any> WritableChunk<ATTR>	takeWritableChunk(int capacity)	Take a WritableChunk of at least the specified capacity.

Method Details

takeWritableChunk

<ATTR extends Attributes.Any> WritableChunk<ATTR> takeWritableChunk(int capacity)

Take a WritableChunk of at least the specified capacity. The result belongs to the caller until released.

Parameters:

capacity - The minimum capacity for the result

Returns:

A WritableChunk of at least the specified capacity that belongs to the caller until released

giveWritableChunk

<ATTR extends Attributes.Any> void giveWritableChunk(@NotNull WritableChunk<ATTR> writableChunk)

Return a WritableChunk to the pool.

Parameters:

writableChunk - The chunk to give

takeResettableChunk

<ATTR extends Attributes.Any> ResettableReadOnlyChunk<ATTR> takeResettableChunk()

Take a ResettableReadOnlyChunk. The result belongs to the caller until released.

Returns:

A ResettableReadOnlyChunk that belongs to the caller until released

giveResettableChunk

<ATTR extends Attributes.Any> void giveResettableChunk(@NotNull ResettableReadOnlyChunk<ATTR> resettableChunk)

Return a ResettableReadOnlyChunk of to the pool.

Parameters:

resettableChunk - The chunk to give

takeResettableWritableChunk

<ATTR extends Attributes.Any> ResettableWritableChunk<ATTR> takeResettableWritableChunk()

Take a ResettableWritableChunk. The result belongs to the caller until released.

Returns:

A ResettableWritableChunk that belongs to the caller until released

giveResettableWritableChunk

<ATTR extends Attributes.Any> void giveResettableWritableChunk(@NotNull ResettableWritableChunk<ATTR> resettableWritableChunk)

Return a ResettableWritableChunk of to the pool.

Parameters:

resettableWritableChunk - The chunk to give