Package io.deephaven.chunk.util.pools

Interface ByteChunkPool

All Known Implementing Classes:

ByteChunkSoftPool, MultiChunkPool

public interface ByteChunkPool

Interface for pools of WritableByteChunk, ResettableByteChunk, and ResettableWritableByteChunk.

Method Summary

Modifier and Type	Method	Description
ChunkPool	asChunkPool()
<ATTR extends Any> ResettableByteChunk<ATTR>	takeResettableByteChunk()	Take a ResettableByteChunk.
<ATTR extends Any> ResettableWritableByteChunk<ATTR>	takeResettableWritableByteChunk()	Take a ResettableWritableByteChunk.
<ATTR extends Any> WritableByteChunk<ATTR>	takeWritableByteChunk(int capacity)	Take a WritableByteChunk of at least the specified capacity.

Method Details

asChunkPool

ChunkPool asChunkPool()

Returns:

This ByteChunkPool as a ChunkPool. This is useful for passing this pool to methods that expect a ChunkPool but do not need to know the specific type.

takeWritableByteChunk

<ATTR extends Any> WritableByteChunk<ATTR> takeWritableByteChunk(int capacity)

Take a WritableByteChunk of at least the specified capacity. The result belongs to the caller until closed.

Parameters:

capacity - The minimum capacity for the result

Returns:

A WritableByteChunk of at least the specified capacity that belongs to the caller until closed

takeResettableByteChunk

<ATTR extends Any> ResettableByteChunk<ATTR> takeResettableByteChunk()

Take a ResettableByteChunk. The result belongs to the caller until closed.

Returns:

A ResettableByteChunk that belongs to the caller until closed

takeResettableWritableByteChunk

<ATTR extends Any>
ResettableWritableByteChunk<ATTR> takeResettableWritableByteChunk()

Take a ResettableWritableByteChunk. The result belongs to the caller until closed.

Returns:

A ResettableWritableByteChunk that belongs to the caller until closed