org.apache.parquet.bytes

Class TrackingByteBufferAllocator

java.lang.Object

org.apache.parquet.bytes.TrackingByteBufferAllocator

All Implemented Interfaces:

AutoCloseable, ByteBufferAllocator

public final class TrackingByteBufferAllocator
extends Object
implements ByteBufferAllocator, AutoCloseable

A wrapper ByteBufferAllocator implementation that tracks whether all allocated buffers are released. It throws the related exception at close() if any buffer remains un-released. It also clears the buffers at release so if they continued being used it'll generate errors.

To be used for testing purposes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrackingByteBufferAllocator.ByteBufferAllocationStacktraceException
static class	TrackingByteBufferAllocator.LeakDetectorHeapByteBufferAllocatorException
static class	TrackingByteBufferAllocator.LeakedByteBufferException
static class	TrackingByteBufferAllocator.ReleasingUnallocatedByteBufferException

Method Summary

Modifier and Type	Method and Description
ByteBuffer	allocate(int size)
void	close()
boolean	isDirect() Indicates if this allocator will produce ByteBuffers backed by direct memory.
void	release(ByteBuffer b) For RefCounted implementations using direct memory, the release method needs to be called to free references to the allocated memory.
static TrackingByteBufferAllocator	wrap(ByteBufferAllocator allocator)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

wrap

public static TrackingByteBufferAllocator wrap(ByteBufferAllocator allocator)

allocate

public ByteBuffer allocate(int size)

Specified by:

allocate in interface ByteBufferAllocator

release

public void release(ByteBuffer b)
             throws TrackingByteBufferAllocator.ReleasingUnallocatedByteBufferException

Description copied from interface: ByteBufferAllocator

For RefCounted implementations using direct memory, the release method needs to be called to free references to the allocated memory.

Specified by:

release in interface ByteBufferAllocator

Parameters:

b - a ByteBuffer

Throws:

TrackingByteBufferAllocator.ReleasingUnallocatedByteBufferException

isDirect

public boolean isDirect()

Description copied from interface: ByteBufferAllocator

Indicates if this allocator will produce ByteBuffers backed by direct memory.

Specified by:

isDirect in interface ByteBufferAllocator

Returns:

true if direct memory backed buffers will be created by this allocator, else false

close

public void close()
           throws TrackingByteBufferAllocator.LeakedByteBufferException

Specified by:

close in interface AutoCloseable

Throws:

TrackingByteBufferAllocator.LeakedByteBufferException