org.bytedeco.javacpp

Class tensorflow.FileSystem

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.tensorflow.FileSystem

All Implemented Interfaces:

AutoCloseable

Enclosing class:

tensorflow

@Namespace(value="tensorflow")
public static class tensorflow.FileSystem
extends Pointer

A generic interface for accessing a file system. Implementations of custom filesystem adapters must implement this interface, RandomAccessFile, WritableFile, and ReadOnlyMemoryRegion classes.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator

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
tensorflow.Status	CopyFile(BytePointer src, BytePointer target) \brief Copy the src to target.
tensorflow.Status	CopyFile(String src, String target)
tensorflow.Status	CreateDir(BytePointer dirname) \brief Creates the specified directory.
tensorflow.Status	CreateDir(String dirname)
tensorflow.Status	DeleteDir(BytePointer dirname) \brief Deletes the specified directory.
tensorflow.Status	DeleteDir(String dirname)
tensorflow.Status	DeleteFile(BytePointer fname) \brief Deletes the named file.
tensorflow.Status	DeleteFile(String fname)
tensorflow.Status	DeleteRecursively(BytePointer dirname, long[] undeleted_files, long... undeleted_dirs)
tensorflow.Status	DeleteRecursively(BytePointer dirname, LongBuffer undeleted_files, LongBuffer undeleted_dirs)
tensorflow.Status	DeleteRecursively(BytePointer dirname, LongPointer undeleted_files, LongPointer undeleted_dirs) \brief Deletes the specified directory and all subdirectories and files underneath it.
tensorflow.Status	DeleteRecursively(String dirname, long[] undeleted_files, long... undeleted_dirs)
tensorflow.Status	DeleteRecursively(String dirname, LongBuffer undeleted_files, LongBuffer undeleted_dirs)
tensorflow.Status	DeleteRecursively(String dirname, LongPointer undeleted_files, LongPointer undeleted_dirs)
tensorflow.Status	FileExists(BytePointer fname) Returns OK if the named path exists and NOT_FOUND otherwise.
tensorflow.Status	FileExists(String fname)
boolean	FilesExist(tensorflow.StringVector files, tensorflow.Status status) Returns true if all the listed files exist, false otherwise.
void	FlushCaches() \brief Flushes any cached filesystem objects from memory.
tensorflow.Status	GetChildren(BytePointer dir, tensorflow.StringVector result) \brief Returns the immediate children in the given directory.
tensorflow.Status	GetChildren(String dir, tensorflow.StringVector result)
tensorflow.Status	GetFileSize(BytePointer fname, long... file_size)
tensorflow.Status	GetFileSize(BytePointer fname, LongBuffer file_size)
tensorflow.Status	GetFileSize(BytePointer fname, LongPointer file_size) \brief Stores the size of fname in *file_size.
tensorflow.Status	GetFileSize(String fname, long... file_size)
tensorflow.Status	GetFileSize(String fname, LongBuffer file_size)
tensorflow.Status	GetFileSize(String fname, LongPointer file_size)
tensorflow.Status	GetMatchingPaths(BytePointer pattern, tensorflow.StringVector results) \brief Given a pattern, stores in *results the set of paths that matches that pattern.
tensorflow.Status	GetMatchingPaths(String pattern, tensorflow.StringVector results)
tensorflow.Status	IsDirectory(BytePointer fname) \brief Returns whether the given path is a directory or not.
tensorflow.Status	IsDirectory(String fname)
tensorflow.Status	NewAppendableFile(BytePointer fname, tensorflow.WritableFile result) \brief Creates an object that either appends to an existing file, or writes to a new file (if the file does not exist to begin with).
tensorflow.Status	NewAppendableFile(String fname, tensorflow.WritableFile result)
tensorflow.Status	NewRandomAccessFile(BytePointer fname, tensorflow.RandomAccessFile result) \brief Creates a brand new random access read-only file with the specified name.
tensorflow.Status	NewRandomAccessFile(String fname, tensorflow.RandomAccessFile result)
tensorflow.Status	NewReadOnlyMemoryRegionFromFile(BytePointer fname, tensorflow.ReadOnlyMemoryRegion result) \brief Creates a readonly region of memory with the file context.
tensorflow.Status	NewReadOnlyMemoryRegionFromFile(String fname, tensorflow.ReadOnlyMemoryRegion result)
tensorflow.Status	NewWritableFile(BytePointer fname, tensorflow.WritableFile result) \brief Creates an object that writes to a new file with the specified name.
tensorflow.Status	NewWritableFile(String fname, tensorflow.WritableFile result)
tensorflow.Status	RecursivelyCreateDir(BytePointer dirname) \brief Creates the specified directory and all the necessary subdirectories.
tensorflow.Status	RecursivelyCreateDir(String dirname)
tensorflow.Status	RenameFile(BytePointer src, BytePointer target) \brief Overwrites the target if it exists.
tensorflow.Status	RenameFile(String src, String target)
tensorflow.Status	Stat(BytePointer fname, tensorflow.FileStatistics stat) \brief Obtains statistics for the given path.
tensorflow.Status	Stat(String fname, tensorflow.FileStatistics stat)
BytePointer	TranslateName(BytePointer name) \brief Translate an URI to a filename for the FileSystem implementation.
String	TranslateName(String 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, hashCode, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, setNull, sizeof, toString, totalBytes, 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(Pointer).

Method Detail

NewRandomAccessFile

@ByVal
public tensorflow.Status NewRandomAccessFile(@StdString
                                                     BytePointer fname,
                                                     @UniquePtr
                                                     tensorflow.RandomAccessFile result)

\brief Creates a brand new random access read-only file with the specified name. On success, stores a pointer to the new file in *result and returns OK. On failure stores NULL in *result and returns non-OK. If the file does not exist, returns a non-OK status. The returned file may be concurrently accessed by multiple threads. The ownership of the returned RandomAccessFile is passed to the caller and the object should be deleted when is not used.

NewRandomAccessFile

@ByVal
public tensorflow.Status NewRandomAccessFile(@StdString
                                                     String fname,
                                                     @UniquePtr
                                                     tensorflow.RandomAccessFile result)

NewWritableFile

@ByVal
public tensorflow.Status NewWritableFile(@StdString
                                                 BytePointer fname,
                                                 @UniquePtr
                                                 tensorflow.WritableFile result)

\brief Creates an object that writes to a new file with the specified name. Deletes any existing file with the same name and creates a new file. On success, stores a pointer to the new file in *result and returns OK. On failure stores NULL in *result and returns non-OK. The returned file will only be accessed by one thread at a time. The ownership of the returned WritableFile is passed to the caller and the object should be deleted when is not used.

NewWritableFile

@ByVal
public tensorflow.Status NewWritableFile(@StdString
                                                 String fname,
                                                 @UniquePtr
                                                 tensorflow.WritableFile result)

NewAppendableFile

@ByVal
public tensorflow.Status NewAppendableFile(@StdString
                                                   BytePointer fname,
                                                   @UniquePtr
                                                   tensorflow.WritableFile result)

\brief Creates an object that either appends to an existing file, or writes to a new file (if the file does not exist to begin with). On success, stores a pointer to the new file in *result and returns OK. On failure stores NULL in *result and returns non-OK. The returned file will only be accessed by one thread at a time. The ownership of the returned WritableFile is passed to the caller and the object should be deleted when is not used.

NewAppendableFile

@ByVal
public tensorflow.Status NewAppendableFile(@StdString
                                                   String fname,
                                                   @UniquePtr
                                                   tensorflow.WritableFile result)

NewReadOnlyMemoryRegionFromFile

@ByVal
public tensorflow.Status NewReadOnlyMemoryRegionFromFile(@StdString
                                                                 BytePointer fname,
                                                                 @UniquePtr
                                                                 tensorflow.ReadOnlyMemoryRegion result)

\brief Creates a readonly region of memory with the file context. On success, it returns a pointer to read-only memory region from the content of file fname. The ownership of the region is passed to the caller. On failure stores nullptr in *result and returns non-OK. The returned memory region can be accessed from many threads in parallel. The ownership of the returned ReadOnlyMemoryRegion is passed to the caller and the object should be deleted when is not used.

NewReadOnlyMemoryRegionFromFile

@ByVal
public tensorflow.Status NewReadOnlyMemoryRegionFromFile(@StdString
                                                                 String fname,
                                                                 @UniquePtr
                                                                 tensorflow.ReadOnlyMemoryRegion result)

FileExists

@ByVal
public tensorflow.Status FileExists(@StdString
                                            BytePointer fname)

Returns OK if the named path exists and NOT_FOUND otherwise.

FileExists

@ByVal
public tensorflow.Status FileExists(@StdString
                                            String fname)

FilesExist

@Cast(value="bool")
public boolean FilesExist(@Const @ByRef
                                               tensorflow.StringVector files,
                                               @StdVector
                                               tensorflow.Status status)

Returns true if all the listed files exist, false otherwise. if status is not null, populate the vector with a detailed status for each file.

GetChildren

@ByVal
public tensorflow.Status GetChildren(@StdString
                                             BytePointer dir,
                                             tensorflow.StringVector result)

\brief Returns the immediate children in the given directory. The returned paths are relative to 'dir'.

GetChildren

@ByVal
public tensorflow.Status GetChildren(@StdString
                                             String dir,
                                             tensorflow.StringVector result)

GetMatchingPaths

@ByVal
public tensorflow.Status GetMatchingPaths(@StdString
                                                  BytePointer pattern,
                                                  tensorflow.StringVector results)

\brief Given a pattern, stores in *results the set of paths that matches that pattern. *results is cleared. pattern must match all of a name, not just a substring. pattern: { term } term: '*': matches any sequence of non-'/' characters '?': matches a single non-'/' character '[' [ '^' ] { match-list } ']': matches any single character (not) on the list c: matches character c (c != '*', '?', '\\', '[') '\\' c: matches character c character-range: c: matches character c (c != '\\', '-', ']') '\\' c: matches character c lo '-' hi: matches character c for lo <= c <= hi Typical return codes: * OK - no errors * UNIMPLEMENTED - Some underlying functions (like GetChildren) are not implemented

GetMatchingPaths

@ByVal
public tensorflow.Status GetMatchingPaths(@StdString
                                                  String pattern,
                                                  tensorflow.StringVector results)

Stat

@ByVal
public tensorflow.Status Stat(@StdString
                                      BytePointer fname,
                                      tensorflow.FileStatistics stat)

\brief Obtains statistics for the given path.

Stat

@ByVal
public tensorflow.Status Stat(@StdString
                                      String fname,
                                      tensorflow.FileStatistics stat)

DeleteFile

@ByVal
public tensorflow.Status DeleteFile(@StdString
                                            BytePointer fname)

\brief Deletes the named file.

DeleteFile

@ByVal
public tensorflow.Status DeleteFile(@StdString
                                            String fname)

CreateDir

@ByVal
public tensorflow.Status CreateDir(@StdString
                                           BytePointer dirname)

\brief Creates the specified directory. Typical return codes: * OK - successfully created the directory. * ALREADY_EXISTS - directory with name dirname already exists. * PERMISSION_DENIED - dirname is not writable.

CreateDir

@ByVal
public tensorflow.Status CreateDir(@StdString
                                           String dirname)

RecursivelyCreateDir

@ByVal
public tensorflow.Status RecursivelyCreateDir(@StdString
                                                      BytePointer dirname)

\brief Creates the specified directory and all the necessary subdirectories. Typical return codes: * OK - successfully created the directory and sub directories, even if they were already created. * PERMISSION_DENIED - dirname or some subdirectory is not writable.

RecursivelyCreateDir

@ByVal
public tensorflow.Status RecursivelyCreateDir(@StdString
                                                      String dirname)

DeleteDir

@ByVal
public tensorflow.Status DeleteDir(@StdString
                                           BytePointer dirname)

\brief Deletes the specified directory.

DeleteDir

@ByVal
public tensorflow.Status DeleteDir(@StdString
                                           String dirname)

DeleteRecursively

@ByVal
public tensorflow.Status DeleteRecursively(@StdString
                                                   BytePointer dirname,
                                                   @Cast(value="tensorflow::int64*")
                                                   LongPointer undeleted_files,
                                                   @Cast(value="tensorflow::int64*")
                                                   LongPointer undeleted_dirs)

\brief Deletes the specified directory and all subdirectories and files underneath it. undeleted_files and undeleted_dirs stores the number of files and directories that weren't deleted (unspecified if the return status is not OK). REQUIRES: undeleted_files, undeleted_dirs to be not null. Typical return codes: * OK - dirname exists and we were able to delete everything underneath. * NOT_FOUND - dirname doesn't exist * PERMISSION_DENIED - dirname or some descendant is not writable * UNIMPLEMENTED - Some underlying functions (like Delete) are not implemented

DeleteRecursively

@ByVal
public tensorflow.Status DeleteRecursively(@StdString
                                                   String dirname,
                                                   @Cast(value="tensorflow::int64*")
                                                   LongBuffer undeleted_files,
                                                   @Cast(value="tensorflow::int64*")
                                                   LongBuffer undeleted_dirs)

DeleteRecursively

@ByVal
public tensorflow.Status DeleteRecursively(@StdString
                                                   BytePointer dirname,
                                                   @Cast(value="tensorflow::int64*")
                                                   long[] undeleted_files,
                                                   @Cast(value="tensorflow::int64*")
                                                   long... undeleted_dirs)

DeleteRecursively

@ByVal
public tensorflow.Status DeleteRecursively(@StdString
                                                   String dirname,
                                                   @Cast(value="tensorflow::int64*")
                                                   LongPointer undeleted_files,
                                                   @Cast(value="tensorflow::int64*")
                                                   LongPointer undeleted_dirs)

DeleteRecursively

@ByVal
public tensorflow.Status DeleteRecursively(@StdString
                                                   BytePointer dirname,
                                                   @Cast(value="tensorflow::int64*")
                                                   LongBuffer undeleted_files,
                                                   @Cast(value="tensorflow::int64*")
                                                   LongBuffer undeleted_dirs)

DeleteRecursively

@ByVal
public tensorflow.Status DeleteRecursively(@StdString
                                                   String dirname,
                                                   @Cast(value="tensorflow::int64*")
                                                   long[] undeleted_files,
                                                   @Cast(value="tensorflow::int64*")
                                                   long... undeleted_dirs)

GetFileSize

@ByVal
public tensorflow.Status GetFileSize(@StdString
                                             BytePointer fname,
                                             @Cast(value="tensorflow::uint64*")
                                             LongPointer file_size)

\brief Stores the size of fname in *file_size.

GetFileSize

@ByVal
public tensorflow.Status GetFileSize(@StdString
                                             String fname,
                                             @Cast(value="tensorflow::uint64*")
                                             LongBuffer file_size)

GetFileSize

@ByVal
public tensorflow.Status GetFileSize(@StdString
                                             BytePointer fname,
                                             @Cast(value="tensorflow::uint64*")
                                             long... file_size)

GetFileSize

@ByVal
public tensorflow.Status GetFileSize(@StdString
                                             String fname,
                                             @Cast(value="tensorflow::uint64*")
                                             LongPointer file_size)

GetFileSize

@ByVal
public tensorflow.Status GetFileSize(@StdString
                                             BytePointer fname,
                                             @Cast(value="tensorflow::uint64*")
                                             LongBuffer file_size)

GetFileSize

@ByVal
public tensorflow.Status GetFileSize(@StdString
                                             String fname,
                                             @Cast(value="tensorflow::uint64*")
                                             long... file_size)

RenameFile

@ByVal
public tensorflow.Status RenameFile(@StdString
                                            BytePointer src,
                                            @StdString
                                            BytePointer target)

\brief Overwrites the target if it exists.

RenameFile

@ByVal
public tensorflow.Status RenameFile(@StdString
                                            String src,
                                            @StdString
                                            String target)

CopyFile

@ByVal
public tensorflow.Status CopyFile(@StdString
                                          BytePointer src,
                                          @StdString
                                          BytePointer target)

\brief Copy the src to target.

CopyFile

@ByVal
public tensorflow.Status CopyFile(@StdString
                                          String src,
                                          @StdString
                                          String target)

TranslateName

@StdString
public BytePointer TranslateName(@StdString
                                             BytePointer name)

\brief Translate an URI to a filename for the FileSystem implementation. The implementation in this class cleans up the path, removing duplicate /'s, resolving .. and . (more details in tensorflow::lib::io::CleanPath).

TranslateName

@StdString
public String TranslateName(@StdString
                                        String name)

IsDirectory

@ByVal
public tensorflow.Status IsDirectory(@StdString
                                             BytePointer fname)

\brief Returns whether the given path is a directory or not. Typical return codes (not guaranteed exhaustive): * OK - The path exists and is a directory. * FAILED_PRECONDITION - The path exists and is not a directory. * NOT_FOUND - The path entry does not exist. * PERMISSION_DENIED - Insufficient permissions. * UNIMPLEMENTED - The file factory doesn't support directories.

IsDirectory

@ByVal
public tensorflow.Status IsDirectory(@StdString
                                             String fname)

FlushCaches

public void FlushCaches()

\brief Flushes any cached filesystem objects from memory.