org.bytedeco.arrow

Class MockFileSystem

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.FileSystem

org.bytedeco.arrow.MockFileSystem

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

MockAsyncFileSystem

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

A mock FileSystem implementation that holds its contents in memory. Useful for validating the FileSystem API, writing conformance suite, and bootstrapping FileSystem-based APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MockFileSystem.Impl

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
MockFileSystem(Pointer current_time)
MockFileSystem(Pointer current_time, IOContext arg1)

Method Summary

Modifier and Type	Method and Description
MockDirInfo	AllDirs()
MockFileInfo	AllFiles()
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	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.
static FileSystemResult	Make(Pointer current_time, FileInfoVector infos)
Status	Move(BytePointer src, BytePointer dest)
Status	Move(String src, String dest) Move / rename a file or directory.
OutputStreamResult	OpenAppendStream(BytePointer path)
OutputStreamResult	OpenAppendStream(BytePointer path, KeyValueMetadata metadata)
OutputStreamResult	OpenAppendStream(String path)
OutputStreamResult	OpenAppendStream(String path, KeyValueMetadata metadata) Open an output stream for appending.
RandomAccessFileResult	OpenInputFile(BytePointer path)
RandomAccessFileResult	OpenInputFile(String path) Open an input file for random access reading.
InputStreamResult	OpenInputStream(BytePointer path)
InputStreamResult	OpenInputStream(String path) Open an input stream for sequential reading.
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.arrow.FileSystem

DeleteFiles, GetFileInfo, GetFileInfoAsync, GetFileInfoGenerator, io_context, NormalizePath, NormalizePath, OpenInputFile, OpenInputFileAsync, OpenInputFileAsync, OpenInputFileAsync, OpenInputStream, OpenInputStreamAsync, OpenInputStreamAsync, OpenInputStreamAsync

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

MockFileSystem

public MockFileSystem(@ByVal @Cast(value="arrow::fs::TimePoint*")
                      Pointer current_time,
                      @Const @ByRef(nullValue="arrow::io::IOContext(arrow::io::default_io_context())")
                      IOContext arg1)

MockFileSystem

public MockFileSystem(@ByVal @Cast(value="arrow::fs::TimePoint*")
                      Pointer current_time)

Method Detail

type_name

@StdString
public String type_name()

Overrides:

type_name in class FileSystem

Equals

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

Overrides:

Equals in class FileSystem

GetFileInfo

@ByVal
public FileInfoResult GetFileInfo(@StdString
                                          String path)

Description copied from class: FileSystem

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

Overrides:

GetFileInfo in class FileSystem

GetFileInfo

@ByVal
public FileInfoResult GetFileInfo(@StdString
                                          BytePointer path)

Overrides:

GetFileInfo in class FileSystem

GetFileInfo

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

Description copied from class: FileSystem

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.

Overrides:

GetFileInfo in class FileSystem

CreateDir

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

Description copied from class: FileSystem

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

Overrides:

CreateDir in class FileSystem

CreateDir

@ByVal
public Status CreateDir(@StdString
                                String path)

Overrides:

CreateDir in class FileSystem

CreateDir

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

Overrides:

CreateDir in class FileSystem

CreateDir

@ByVal
public Status CreateDir(@StdString
                                BytePointer path)

Overrides:

CreateDir in class FileSystem

DeleteDir

@ByVal
public Status DeleteDir(@StdString
                                String path)

Description copied from class: FileSystem

Delete a directory and its contents, recursively.

Overrides:

DeleteDir in class FileSystem

DeleteDir

@ByVal
public Status DeleteDir(@StdString
                                BytePointer path)

Overrides:

DeleteDir in class FileSystem

DeleteDirContents

@ByVal
public Status DeleteDirContents(@StdString
                                        String path)

Description copied from class: FileSystem

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

Overrides:

DeleteDirContents in class FileSystem

DeleteDirContents

@ByVal
public Status DeleteDirContents(@StdString
                                        BytePointer path)

Overrides:

DeleteDirContents in class FileSystem

DeleteRootDirContents

@ByVal
public Status DeleteRootDirContents()

Description copied from class: FileSystem

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

Overrides:

DeleteRootDirContents in class FileSystem

DeleteFile

@ByVal
public Status DeleteFile(@StdString
                                 String path)

Description copied from class: FileSystem

Delete a file.

Overrides:

DeleteFile in class FileSystem

DeleteFile

@ByVal
public Status DeleteFile(@StdString
                                 BytePointer path)

Overrides:

DeleteFile in class FileSystem

Move

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

Description copied from class: FileSystem

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

Overrides:

Move in class FileSystem

Move

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

Overrides:

Move in class FileSystem

CopyFile

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

Description copied from class: FileSystem

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

Overrides:

CopyFile in class FileSystem

CopyFile

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

Overrides:

CopyFile in class FileSystem

OpenInputStream

@ByVal
public InputStreamResult OpenInputStream(@StdString
                                                 String path)

Description copied from class: FileSystem

Open an input stream for sequential reading.

Overrides:

OpenInputStream in class FileSystem

OpenInputStream

@ByVal
public InputStreamResult OpenInputStream(@StdString
                                                 BytePointer path)

Overrides:

OpenInputStream in class FileSystem

OpenInputFile

@ByVal
public RandomAccessFileResult OpenInputFile(@StdString
                                                    String path)

Description copied from class: FileSystem

Open an input file for random access reading.

Overrides:

OpenInputFile in class FileSystem

OpenInputFile

@ByVal
public RandomAccessFileResult OpenInputFile(@StdString
                                                    BytePointer path)

Overrides:

OpenInputFile in class FileSystem

OpenOutputStream

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

Description copied from class: FileSystem

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

Overrides:

OpenOutputStream in class FileSystem

OpenOutputStream

@ByVal
public OutputStreamResult OpenOutputStream(@StdString
                                                   String path)

Overrides:

OpenOutputStream in class FileSystem

OpenOutputStream

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

Overrides:

OpenOutputStream in class FileSystem

OpenOutputStream

@ByVal
public OutputStreamResult OpenOutputStream(@StdString
                                                   BytePointer path)

Overrides:

OpenOutputStream in class FileSystem

OpenAppendStream

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

Description copied from class: FileSystem

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

Overrides:

OpenAppendStream in class FileSystem

OpenAppendStream

@ByVal
public OutputStreamResult OpenAppendStream(@StdString
                                                   String path)

Overrides:

OpenAppendStream in class FileSystem

OpenAppendStream

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

Overrides:

OpenAppendStream in class FileSystem

OpenAppendStream

@ByVal
public OutputStreamResult OpenAppendStream(@StdString
                                                   BytePointer path)

Overrides:

OpenAppendStream in class FileSystem

AllDirs

@StdVector
public MockDirInfo AllDirs()

AllFiles

@StdVector
public MockFileInfo AllFiles()

Make

@ByVal
public static FileSystemResult Make(@ByVal @Cast(value="arrow::fs::TimePoint*")
                                            Pointer current_time,
                                            @Const @ByRef
                                            FileInfoVector infos)