org.bytedeco.arrow

Class BufferOutputStream

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.FileInterface

org.bytedeco.arrow.OutputStream

org.bytedeco.arrow.BufferOutputStream

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::io")
 @NoOffset
 @Properties(inherit=arrow.class)
public class BufferOutputStream
extends OutputStream

\brief An output stream that writes to a resizable buffer

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
BufferOutputStream(Pointer p) Pointer cast constructor.
BufferOutputStream(ResizableBuffer buffer)

Method Summary

Modifier and Type	Method and Description
long	_capacity()
Status	Close() Close the stream, preserving the buffer (retrieve it with Finish()).
boolean	closed() \brief Return whether the stream is closed
static BufferOutputStreamResult	Create()
static BufferOutputStreamResult	Create(long initial_capacity, MemoryPool pool) \brief Create in-memory output stream with indicated capacity using a memory pool
BufferResult	Finish() \endcond
Status	Reset()
Status	Reset(long initial_capacity, MemoryPool pool) \brief Initialize state of OutputStream with newly allocated memory and set position to 0
LongResult	Tell() \brief Return the position in this stream
Status	Write(Pointer data, long nbytes)

Methods inherited from class org.bytedeco.arrow.OutputStream

asWritable, asWritable

Methods inherited from class org.bytedeco.arrow.FileInterface

Abort, mode

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, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, 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

BufferOutputStream

public BufferOutputStream(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

BufferOutputStream

public BufferOutputStream(@Const @SharedPtr @ByRef
                          ResizableBuffer buffer)

Method Detail

Create

@ByVal
public static BufferOutputStreamResult Create(@Cast(value="int64_t")
                                                      long initial_capacity,
                                                      MemoryPool pool)

\brief Create in-memory output stream with indicated capacity using a memory pool

Parameters:

initial_capacity - [in] the initial allocated internal capacity of the OutputStream

pool - [in,out] a MemoryPool to use for allocations

Returns:

the created stream

Create

@ByVal
public static BufferOutputStreamResult Create()

Close

@ByVal
public Status Close()

Close the stream, preserving the buffer (retrieve it with Finish()).

Overrides:

Close in class FileInterface

closed

@Cast(value="bool")
public boolean closed()

Description copied from class: FileInterface

\brief Return whether the stream is closed

Overrides:

closed in class FileInterface

Tell

@ByVal
public LongResult Tell()

Description copied from class: FileInterface

\brief Return the position in this stream

Overrides:

Tell in class FileInterface

Write

@ByVal
public Status Write(@Const
                            Pointer data,
                            @Cast(value="int64_t")
                            long nbytes)

Finish

@ByVal
public BufferResult Finish()

\endcond

Close the stream and return the buffer

Reset

@ByVal
public Status Reset(@Cast(value="int64_t")
                            long initial_capacity,
                            MemoryPool pool)

\brief Initialize state of OutputStream with newly allocated memory and set position to 0

Parameters:

initial_capacity - [in] the starting allocated capacity

pool - [in,out] the memory pool to use for allocations

Returns:

Status

Reset

@ByVal
public Status Reset()

_capacity

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