org.bytedeco.arrow

Class BufferBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.BufferBuilder

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class BufferBuilder
extends Pointer

\class BufferBuilder \brief A class for incrementally building a contiguous chunk of in-memory data

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
BufferBuilder()
BufferBuilder(long size) Native array allocator.
BufferBuilder(MemoryPool pool)
BufferBuilder(Pointer p) Pointer cast constructor.
BufferBuilder(ResizableBuffer buffer)
BufferBuilder(ResizableBuffer buffer, MemoryPool pool) \brief Constructs new Builder that will start using the provided buffer until Finish/Reset are called.

Method Summary

Modifier and Type	Method and Description
long	_capacity()
Status	Advance(long length)
Status	Append(long num_copies, byte value) \brief Append copies of a value to the buffer The buffer is automatically expanded if necessary.
Status	Append(Pointer data, long length) \brief Append the given data to the buffer The buffer is automatically expanded if necessary.
BytePointer	data()
BufferResult	Finish()
Status	Finish(ArrowBuffer out)
Status	Finish(ArrowBuffer out, boolean shrink_to_fit) \brief Return result of builder as a Buffer object.
BufferResult	Finish(boolean shrink_to_fit)
BufferResult	FinishWithLength(long final_length)
BufferResult	FinishWithLength(long final_length, boolean shrink_to_fit) \brief Like Finish, but override the final buffer size This is useful after writing data directly into the builder memory without calling the Append methods (basically, when using BufferBuilder mostly for memory allocation).
BufferBuilder	getPointer(long i)
static long	GrowByFactor(long current_capacity, long new_capacity) \brief Return a capacity expanded by the desired growth factor
long	length()
BytePointer	mutable_data()
BufferBuilder	position(long position)
Status	Reserve(long additional_bytes) \brief Ensure that builder can accommodate the additional number of bytes without the need to perform allocations
void	Reset()
Status	Resize(long new_capacity)
Status	Resize(long new_capacity, boolean shrink_to_fit) \brief Resize the buffer to the nearest multiple of 64 bytes
void	Rewind(long _position) \brief Set size to a smaller value without modifying builder contents.
void	UnsafeAdvance(long length)
void	UnsafeAppend(long num_copies, byte value)
void	UnsafeAppend(Pointer data, long length)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BufferBuilder

public BufferBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

BufferBuilder

public BufferBuilder(long size)

Native array allocator. Access with Pointer.position(long).

BufferBuilder

public BufferBuilder(MemoryPool pool)

BufferBuilder

public BufferBuilder()

BufferBuilder

public BufferBuilder(@SharedPtr @ByVal
                     ResizableBuffer buffer,
                     MemoryPool pool)

\brief Constructs new Builder that will start using the provided buffer until Finish/Reset are called. The buffer is not resized.

BufferBuilder

public BufferBuilder(@SharedPtr @ByVal
                     ResizableBuffer buffer)

Method Detail

position

public BufferBuilder position(long position)

Overrides:

position in class Pointer

getPointer

public BufferBuilder getPointer(long i)

Overrides:

getPointer in class Pointer

Resize

@ByVal
public Status Resize(@Cast(value="const int64_t")
                             long new_capacity,
                             @Cast(value="bool")
                             boolean shrink_to_fit)

\brief Resize the buffer to the nearest multiple of 64 bytes

Parameters:

new_capacity - the new capacity of the of the builder. Will be rounded up to a multiple of 64 bytes for padding

shrink_to_fit - if new capacity is smaller than the existing, reallocate internal buffer. Set to false to avoid reallocations when shrinking the builder.

Returns:

Status

Resize

@ByVal
public Status Resize(@Cast(value="const int64_t")
                             long new_capacity)

Reserve

@ByVal
public Status Reserve(@Cast(value="const int64_t")
                              long additional_bytes)

\brief Ensure that builder can accommodate the additional number of bytes without the need to perform allocations

Parameters:

additional_bytes - [in] number of additional bytes to make space for

Returns:

Status

GrowByFactor

@Cast(value="int64_t")
public static long GrowByFactor(@Cast(value="int64_t")
                                                        long current_capacity,
                                                        @Cast(value="int64_t")
                                                        long new_capacity)

\brief Return a capacity expanded by the desired growth factor

Append

@ByVal
public Status Append(@Const
                             Pointer data,
                             @Cast(value="const int64_t")
                             long length)

\brief Append the given data to the buffer The buffer is automatically expanded if necessary.

Append

@ByVal
public Status Append(@Cast(value="const int64_t")
                             long num_copies,
                             @Cast(value="uint8_t")
                             byte value)

\brief Append copies of a value to the buffer The buffer is automatically expanded if necessary.

Advance

@ByVal
public Status Advance(@Cast(value="const int64_t")
                              long length)

UnsafeAdvance

public void UnsafeAdvance(@Cast(value="const int64_t")
                          long length)

UnsafeAppend

public void UnsafeAppend(@Const
                         Pointer data,
                         @Cast(value="const int64_t")
                         long length)

UnsafeAppend

public void UnsafeAppend(@Cast(value="const int64_t")
                         long num_copies,
                         @Cast(value="uint8_t")
                         byte value)

Finish

@ByVal
public Status Finish(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::Buffer>*"})
                             ArrowBuffer out,
                             @Cast(value="bool")
                             boolean shrink_to_fit)

\brief Return result of builder as a Buffer object. The builder is reset and can be reused afterwards.

Parameters:

out - [out] the finalized Buffer object

shrink_to_fit - if the buffer size is smaller than its capacity, reallocate to fit more tightly in memory. Set to false to avoid a reallocation, at the expense of potentially more memory consumption.

Returns:

Status

Finish

@ByVal
public Status Finish(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::Buffer>*"})
                             ArrowBuffer out)

Finish

@ByVal
public BufferResult Finish(@Cast(value="bool")
                                   boolean shrink_to_fit)

Finish

@ByVal
public BufferResult Finish()

FinishWithLength

@ByVal
public BufferResult FinishWithLength(@Cast(value="int64_t")
                                             long final_length,
                                             @Cast(value="bool")
                                             boolean shrink_to_fit)

\brief Like Finish, but override the final buffer size This is useful after writing data directly into the builder memory without calling the Append methods (basically, when using BufferBuilder mostly for memory allocation).

FinishWithLength

@ByVal
public BufferResult FinishWithLength(@Cast(value="int64_t")
                                             long final_length)

Reset

public void Reset()

Rewind

public void Rewind(@Cast(value="int64_t")
                   long _position)

\brief Set size to a smaller value without modifying builder contents. For reusable BufferBuilder classes

Parameters:

position - [in] must be non-negative and less than or equal to the current length()

_capacity

@Cast(value="int64_t")
 @Name(value="capacity")
public long _capacity()

length

@Cast(value="int64_t")
public long length()

data

@Cast(value="const uint8_t*")
public BytePointer data()

mutable_data

@Cast(value="uint8_t*")
public BytePointer mutable_data()