org.bytedeco.arrow

Class FileSystem

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.FileSystem

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

LocalFileSystem, MockFileSystem, SlowFileSystem, SubTreeFileSystem

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

\brief Abstract file system API

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

Method Summary

Modifier and Type	Method and Description
Status	CopyFile(BytePointer src, BytePointer dest)
Status	CopyFile(String src, String dest) Copy a file.
Status	CreateDir(BytePointer path)
Status	CreateDir(BytePointer path, boolean recursive)
Status	CreateDir(String path)
Status	CreateDir(String path, boolean recursive) Create a directory and subdirectories.
Status	DeleteDir(BytePointer path)
Status	DeleteDir(String path) Delete a directory and its contents, recursively.
Status	DeleteDirContents(BytePointer path)
Status	DeleteDirContents(String path) Delete a directory's contents, recursively.
Status	DeleteFile(BytePointer path)
Status	DeleteFile(String path) Delete a file.
Status	DeleteFiles(StringVector paths) Delete many files.
Status	DeleteRootDirContents() EXPERIMENTAL: Delete the root directory's contents, recursively.
boolean	Equals(FileSystem other)
FileInfoResult	GetFileInfo(BytePointer path)
FileInfoVectorResult	GetFileInfo(FileSelector select) Same, according to a selector.
FileInfoResult	GetFileInfo(String path) Get info for the given target.
FileInfoVectorResult	GetFileInfo(StringVector paths) Same, for many targets at once.
FileInfoVectorFuture	GetFileInfoAsync(StringVector paths) Async version of GetFileInfo
Pointer	GetFileInfoGenerator(FileSelector select) Streaming async version of GetFileInfo The returned generator is not async-reentrant, i.e.
IOContext	io_context() EXPERIMENTAL: The IOContext associated with this filesystem.
Status	Move(BytePointer src, BytePointer dest)
Status	Move(String src, String dest) Move / rename a file or directory.
StringResult	NormalizePath(BytePointer path)
StringResult	NormalizePath(String path) Normalize path for the given filesystem The default implementation of this method is a no-op, but subclasses may allow normalizing irregular path forms (such as Windows local paths).
OutputStreamResult	OpenAppendStream(BytePointer path)
OutputStreamResult	OpenAppendStream(BytePointer path, KeyValueMetadata metadata) Deprecated.
OutputStreamResult	OpenAppendStream(String path)
OutputStreamResult	OpenAppendStream(String path, KeyValueMetadata metadata) Deprecated.
RandomAccessFileResult	OpenInputFile(BytePointer path)
RandomAccessFileResult	OpenInputFile(FileInfo info) Open an input file for random access reading.
RandomAccessFileResult	OpenInputFile(String path) Open an input file for random access reading.
RandomAccessFileFuture	OpenInputFileAsync(BytePointer path)
RandomAccessFileFuture	OpenInputFileAsync(FileInfo info) Async version of OpenInputFile
RandomAccessFileFuture	OpenInputFileAsync(String path) Async version of OpenInputFile
InputStreamResult	OpenInputStream(BytePointer path)
InputStreamResult	OpenInputStream(FileInfo info) Open an input stream for sequential reading.
InputStreamResult	OpenInputStream(String path) Open an input stream for sequential reading.
InputStreamFuture	OpenInputStreamAsync(BytePointer path)
InputStreamFuture	OpenInputStreamAsync(FileInfo info) Async version of OpenInputStream
InputStreamFuture	OpenInputStreamAsync(String path) Async version of OpenInputStream
OutputStreamResult	OpenOutputStream(BytePointer path)
OutputStreamResult	OpenOutputStream(BytePointer path, KeyValueMetadata metadata)
OutputStreamResult	OpenOutputStream(String path)
OutputStreamResult	OpenOutputStream(String path, KeyValueMetadata metadata) Open an output stream for sequential writing.
String	type_name()

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

FileSystem

public FileSystem(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

type_name

@StdString
public String type_name()

io_context

@Const
 @ByRef
public IOContext io_context()

EXPERIMENTAL: The IOContext associated with this filesystem.

NormalizePath

@ByVal
public StringResult NormalizePath(@StdString
                                          String path)

Normalize path for the given filesystem The default implementation of this method is a no-op, but subclasses may allow normalizing irregular path forms (such as Windows local paths).

NormalizePath

@ByVal
public StringResult NormalizePath(@StdString
                                          BytePointer path)

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                           FileSystem other)

GetFileInfo

@ByVal
public FileInfoResult GetFileInfo(@StdString
                                          String path)

Get info for the given target. Any symlink is automatically dereferenced, recursively. A nonexistent or unreachable file returns an Ok status and has a FileType of value NotFound. An error status indicates a truly exceptional condition (low-level I/O error, etc.).

GetFileInfo

@ByVal
public FileInfoResult GetFileInfo(@StdString
                                          BytePointer path)

GetFileInfo

@ByVal
public FileInfoVectorResult GetFileInfo(@Const @ByRef
                                                StringVector paths)

Same, for many targets at once.

GetFileInfo

@ByVal
public FileInfoVectorResult GetFileInfo(@Const @ByRef
                                                FileSelector select)

Same, according to a selector. The selector's base directory will not be part of the results, even if it exists. If it doesn't exist, see FileSelector::allow_not_found.

GetFileInfoAsync

@ByVal
public FileInfoVectorFuture GetFileInfoAsync(@Const @ByRef
                                                     StringVector paths)

Async version of GetFileInfo

GetFileInfoGenerator

@ByVal
 @Cast(value="arrow::fs::FileInfoGenerator*")
public Pointer GetFileInfoGenerator(@Const @ByRef
                                                                                           FileSelector select)

Streaming async version of GetFileInfo The returned generator is not async-reentrant, i.e. you need to wait for the returned future to complete before calling the generator again.

CreateDir

@ByVal
public Status CreateDir(@StdString
                                String path,
                                @Cast(value="bool")
                                boolean recursive)

Create a directory and subdirectories. This function succeeds if the directory already exists.

CreateDir

@ByVal
public Status CreateDir(@StdString
                                String path)

CreateDir

@ByVal
public Status CreateDir(@StdString
                                BytePointer path,
                                @Cast(value="bool")
                                boolean recursive)

CreateDir

@ByVal
public Status CreateDir(@StdString
                                BytePointer path)

DeleteDir

@ByVal
public Status DeleteDir(@StdString
                                String path)

Delete a directory and its contents, recursively.

DeleteDir

@ByVal
public Status DeleteDir(@StdString
                                BytePointer path)

DeleteDirContents

@ByVal
public Status DeleteDirContents(@StdString
                                        String path)

Delete a directory's contents, recursively. Like DeleteDir, but doesn't delete the directory itself. Passing an empty path ("" or "/") is disallowed, see DeleteRootDirContents.

DeleteDirContents

@ByVal
public Status DeleteDirContents(@StdString
                                        BytePointer path)

DeleteRootDirContents

@ByVal
public Status DeleteRootDirContents()

EXPERIMENTAL: Delete the root directory's contents, recursively. Implementations may decide to raise an error if this operation is too dangerous.

DeleteFile

@ByVal
public Status DeleteFile(@StdString
                                 String path)

Delete a file.

DeleteFile

@ByVal
public Status DeleteFile(@StdString
                                 BytePointer path)

DeleteFiles

@ByVal
public Status DeleteFiles(@Const @ByRef
                                  StringVector paths)

Delete many files. The default implementation issues individual delete operations in sequence.

Move

@ByVal
public Status Move(@StdString
                           String src,
                           @StdString
                           String dest)

Move / rename a file or directory. If the destination exists: - if it is a non-empty directory, an error is returned - otherwise, if it has the same type as the source, it is replaced - otherwise, behavior is unspecified (implementation-dependent).

Move

@ByVal
public Status Move(@StdString
                           BytePointer src,
                           @StdString
                           BytePointer dest)

CopyFile

@ByVal
public Status CopyFile(@StdString
                               String src,
                               @StdString
                               String dest)

Copy a file. If the destination exists and is a directory, an error is returned. Otherwise, it is replaced.

CopyFile

@ByVal
public Status CopyFile(@StdString
                               BytePointer src,
                               @StdString
                               BytePointer dest)

OpenInputStream

@ByVal
public InputStreamResult OpenInputStream(@StdString
                                                 String path)

Open an input stream for sequential reading.

OpenInputStream

@ByVal
public InputStreamResult OpenInputStream(@StdString
                                                 BytePointer path)

OpenInputStream

@ByVal
public InputStreamResult OpenInputStream(@Const @ByRef
                                                 FileInfo info)

Open an input stream for sequential reading. This override assumes the given FileInfo validly represents the file's characteristics, and may optimize access depending on them (for example avoid querying the file size or its existence).

OpenInputFile

@ByVal
public RandomAccessFileResult OpenInputFile(@StdString
                                                    String path)

Open an input file for random access reading.

OpenInputFile

@ByVal
public RandomAccessFileResult OpenInputFile(@StdString
                                                    BytePointer path)

OpenInputFile

@ByVal
public RandomAccessFileResult OpenInputFile(@Const @ByRef
                                                    FileInfo info)

Open an input file for random access reading. This override assumes the given FileInfo validly represents the file's characteristics, and may optimize access depending on them (for example avoid querying the file size or its existence).

OpenInputStreamAsync

@ByVal
public InputStreamFuture OpenInputStreamAsync(@StdString
                                                      String path)

Async version of OpenInputStream

OpenInputStreamAsync

@ByVal
public InputStreamFuture OpenInputStreamAsync(@StdString
                                                      BytePointer path)

OpenInputStreamAsync

@ByVal
public InputStreamFuture OpenInputStreamAsync(@Const @ByRef
                                                      FileInfo info)

Async version of OpenInputStream

OpenInputFileAsync

@ByVal
public RandomAccessFileFuture OpenInputFileAsync(@StdString
                                                         String path)

Async version of OpenInputFile

OpenInputFileAsync

@ByVal
public RandomAccessFileFuture OpenInputFileAsync(@StdString
                                                         BytePointer path)

OpenInputFileAsync

@ByVal
public RandomAccessFileFuture OpenInputFileAsync(@Const @ByRef
                                                         FileInfo info)

Async version of OpenInputFile

OpenOutputStream

@ByVal
public OutputStreamResult OpenOutputStream(@StdString
                                                   String path,
                                                   @SharedPtr @Cast(value={"const arrow::KeyValueMetadata*","std::shared_ptr<const arrow::KeyValueMetadata>"})
                                                   KeyValueMetadata metadata)

Open an output stream for sequential writing. If the target already exists, existing data is truncated.

OpenOutputStream

@ByVal
public OutputStreamResult OpenOutputStream(@StdString
                                                   BytePointer path,
                                                   @SharedPtr @Cast(value={"const arrow::KeyValueMetadata*","std::shared_ptr<const arrow::KeyValueMetadata>"})
                                                   KeyValueMetadata metadata)

OpenOutputStream

@ByVal
public OutputStreamResult OpenOutputStream(@StdString
                                                   String path)

OpenOutputStream

@ByVal
public OutputStreamResult OpenOutputStream(@StdString
                                                   BytePointer path)

OpenAppendStream

@Deprecated
 @ByVal
public OutputStreamResult OpenAppendStream(@StdString
                                                                 String path,
                                                                 @SharedPtr @Cast(value={"const arrow::KeyValueMetadata*","std::shared_ptr<const arrow::KeyValueMetadata>"})
                                                                 KeyValueMetadata metadata)

Deprecated.

Open an output stream for appending. If the target doesn't exist, a new empty file is created.

OpenAppendStream

@Deprecated
 @ByVal
public OutputStreamResult OpenAppendStream(@StdString
                                                                 BytePointer path,
                                                                 @SharedPtr @Cast(value={"const arrow::KeyValueMetadata*","std::shared_ptr<const arrow::KeyValueMetadata>"})
                                                                 KeyValueMetadata metadata)

Deprecated.

OpenAppendStream

@ByVal
public OutputStreamResult OpenAppendStream(@StdString
                                                   String path)

OpenAppendStream

@ByVal
public OutputStreamResult OpenAppendStream(@StdString
                                                   BytePointer path)