org.bytedeco.arrow

Class FileOutputStream

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.FileInterface

org.bytedeco.arrow.OutputStream

org.bytedeco.arrow.FileOutputStream

All Implemented Interfaces:

AutoCloseable

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

\brief An operating system file open in write-only mode.

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

Method Summary

Modifier and Type	Method and Description
Status	Close() \brief Close the stream cleanly For writable streams, this will attempt to flush any pending data before releasing the underlying resource.
boolean	closed() \brief Return whether the stream is closed
int	file_descriptor() \endcond
static FileOutputStreamResult	Open(BytePointer path)
static FileOutputStreamResult	Open(BytePointer path, boolean append)
static FileOutputStreamResult	Open(int fd) \brief Open a file descriptor for writing.
static FileOutputStreamResult	Open(String path)
static FileOutputStreamResult	Open(String path, boolean append) \brief Open a local file for writing, truncating any existing file
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, 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

FileOutputStream

public FileOutputStream(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Open

@ByVal
public static FileOutputStreamResult Open(@StdString
                                                 String path,
                                                 @Cast(value="bool")
                                                 boolean append)

\brief Open a local file for writing, truncating any existing file

Parameters:

path - [in] with UTF8 encoding

append - [in] append to existing file, otherwise truncate to 0 bytes

Returns:

an open FileOutputStream When opening a new file, any existing file with the indicated path is truncated to 0 bytes, deleting any existing data

Open

@ByVal
public static FileOutputStreamResult Open(@StdString
                                                 String path)

Open

@ByVal
public static FileOutputStreamResult Open(@StdString
                                                 BytePointer path,
                                                 @Cast(value="bool")
                                                 boolean append)

Open

@ByVal
public static FileOutputStreamResult Open(@StdString
                                                 BytePointer path)

Open

@ByVal
public static FileOutputStreamResult Open(int fd)

\brief Open a file descriptor for writing. The underlying file isn't truncated.

Parameters:

fd - [in] file descriptor

Returns:

an open FileOutputStream The file descriptor becomes owned by the OutputStream, and will be closed on Close() or destruction.

Close

@ByVal
public Status Close()

Description copied from class: FileInterface

\brief Close the stream cleanly For writable streams, this will attempt to flush any pending data before releasing the underlying resource. After Close() is called, closed() returns true and the stream is not available for further operations.

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)

file_descriptor

public int file_descriptor()

\endcond