org.bytedeco.arrow

Class BufferedOutputStream

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.FileInterface

org.bytedeco.arrow.OutputStream

org.bytedeco.arrow.BufferedOutputStream

All Implemented Interfaces:

AutoCloseable

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

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
BufferedOutputStream(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Abort() \brief Close the stream abruptly This method does not guarantee that any pending data is flushed.
long	buffer_size() \brief Return the current size of the internal buffer
long	bytes_buffered() \brief Return the number of remaining bytes that have not been flushed to the raw OutputStream
Status	Close() \brief Close the buffered output stream.
boolean	closed() \brief Return whether the stream is closed
static BufferedOutputStreamResult	Create(long buffer_size, MemoryPool pool, OutputStream raw) \brief Create a buffered output stream wrapping the given output stream.
OutputStreamResult	Detach() \brief Flush any buffered writes and release the raw OutputStream.
Status	Flush()
OutputStream	raw() \brief Return the underlying raw output stream.
Status	SetBufferSize(long new_buffer_size) \brief Resize internal buffer
LongResult	Tell() \brief Return the position in this stream
Status	Write(ArrowBuffer data)
Status	Write(Pointer data, long nbytes)

Methods inherited from class org.bytedeco.arrow.OutputStream

asWritable, asWritable

Methods inherited from class org.bytedeco.arrow.FileInterface

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, offsetAddress, 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

BufferedOutputStream

public BufferedOutputStream(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Create

@ByVal
public static BufferedOutputStreamResult Create(@Cast(value="int64_t")
                                                       long buffer_size,
                                                       MemoryPool pool,
                                                       @SharedPtr
                                                       OutputStream raw)

\brief Create a buffered output stream wrapping the given output stream.

Parameters:

buffer_size - [in] the size of the temporary write buffer

pool - [in] a MemoryPool to use for allocations

raw - [in] another OutputStream

Returns:

the created BufferedOutputStream

SetBufferSize

@ByVal
public Status SetBufferSize(@Cast(value="int64_t")
                                   long new_buffer_size)

\brief Resize internal buffer

Parameters:

new_buffer_size - [in] the new buffer size

Returns:

Status

buffer_size

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

\brief Return the current size of the internal buffer

bytes_buffered

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

\brief Return the number of remaining bytes that have not been flushed to the raw OutputStream

Detach

@ByVal
public OutputStreamResult Detach()

\brief Flush any buffered writes and release the raw OutputStream. Further operations on this object are invalid

Returns:

the underlying OutputStream

Close

@ByVal
public Status Close()

\brief Close the buffered output stream. This implicitly closes the underlying raw output stream.

Overrides:

Close in class FileInterface

Abort

@ByVal
public Status Abort()

Description copied from class: FileInterface

\brief Close the stream abruptly This method does not guarantee that any pending data is flushed. It merely releases any underlying resource used by the stream for its operation. After Abort() is called, closed() returns true and the stream is not available for further operations.

Overrides:

Abort 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)

Write

@ByVal
public Status Write(@SharedPtr
                           ArrowBuffer data)

Flush

@ByVal
public Status Flush()

raw

@SharedPtr
public OutputStream raw()

\brief Return the underlying raw output stream.