org.bytedeco.arrow

Class BufferedInputStream

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.FileInterface

org.bytedeco.arrow.InputStream

org.bytedeco.arrow.BufferedInputStreamConcurrencyWrapper

org.bytedeco.arrow.BufferedInputStream

All Implemented Interfaces:

AutoCloseable

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

\class BufferedInputStream \brief An InputStream that performs buffered reads from an unbuffered InputStream, which can mitigate the overhead of many small reads in some cases

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

Method Summary

Modifier and Type	Method and Description
long	buffer_size() \brief Return the current size of the internal buffer
long	bytes_buffered() \brief Return the number of remaining bytes in the read buffer
boolean	closed() \brief Return whether the stream is closed
static BufferedInputStreamResult	Create(long buffer_size, MemoryPool pool, InputStream raw)
static BufferedInputStreamResult	Create(long buffer_size, MemoryPool pool, InputStream raw, long raw_read_bound) \brief Create a BufferedInputStream from a raw InputStream
InputStream	Detach() \brief Release the raw InputStream.
InputStream	raw() \brief Return the unbuffered InputStream
Status	SetBufferSize(long new_buffer_size) \brief Resize internal read buffer; calls to Read(...) will read at least

Methods inherited from class org.bytedeco.arrow.BufferedInputStreamConcurrencyWrapper

Abort, Close, Peek, Read, Read, Tell

Methods inherited from class org.bytedeco.arrow.InputStream

Advance, asReadable, asReadable, supports_zero_copy

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

BufferedInputStream

public BufferedInputStream(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Create

@ByVal
public static BufferedInputStreamResult Create(@Cast(value="int64_t")
                                                       long buffer_size,
                                                       MemoryPool pool,
                                                       @SharedPtr
                                                       InputStream raw,
                                                       @Cast(value="int64_t")
                                                       long raw_read_bound)

\brief Create a BufferedInputStream from a raw InputStream

Parameters:

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

pool - [in] a MemoryPool to use for allocations

raw - [in] a raw InputStream

raw_read_bound - [in] a bound on the maximum number of bytes to read from the raw input stream. The default -1 indicates that it is unbounded

Returns:

the created BufferedInputStream

Create

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

SetBufferSize

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

\brief Resize internal read buffer; calls to Read(...) will read at least

Parameters:

new_buffer_size - [in] the new read buffer size

Returns:

Status

bytes_buffered

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

\brief Return the number of remaining bytes in the read buffer

buffer_size

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

\brief Return the current size of the internal buffer

Detach

@SharedPtr
public InputStream Detach()

\brief Release the raw InputStream. Any data buffered will be discarded. Further operations on this object are invalid

Returns:

raw the underlying InputStream

raw

@SharedPtr
public InputStream raw()

\brief Return the unbuffered InputStream

closed

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

Description copied from class: FileInterface

\brief Return whether the stream is closed

Overrides:

closed in class FileInterface