Interface GFileSystem
- All Superinterfaces:
AutoCloseable
,Closeable
,ExtensionPoint
- All Known Implementing Classes:
AbstractFileSystem
,GFileSystemBase
,LocalFileSystem
,LocalFileSystemSub
Operations take a TaskMonitor
if they need to be cancel-able.
Use a FileSystemService instance
to discover and
open instances of filesystems in files or to open a known FSRL
path or to
deal with creating temp files
.
NOTE:
ALL GFileSystem sub-CLASSES MUST END IN "FileSystem". If not, the ClassSearcher will not find them.
Also note that this interface came after the original abstract class GFileSystem and its many implementations, and usage is being migrated to this interface where possible and as time permits.
-
Method Summary
Modifier and TypeMethodDescriptiongetByteProvider
(GFile file, TaskMonitor monitor) Returns aByteProvider
that contains the contents of the specifiedGFile
.default String
Returns a description of this file system.default FileAttributes
getFileAttributes
(GFile file, TaskMonitor monitor) Returns a container ofFileAttribute
values.default int
Returns the number of files in the filesystem, if known, otherwise -1 if not known.getFSRL()
File system's FSRLdefault InputStream
getInputStream
(GFile file, TaskMonitor monitor) Returns anInputStream
that contains the contents of the specifiedGFile
.static InputStream
getInputStreamHelper
(GFile file, GFileSystem fs, TaskMonitor monitor) getListing
(GFile directory) Returns a list offiles
that reside in the specified directory on this filesystem.getName()
File system volume name.Returns theref manager
that is responsible for creating and releasingrefs
to this filesystem.default GFile
Returns the file system's root directory.default String
getType()
Returns the type of this file system.boolean
isClosed()
Returns true if the filesystem has beenclosed
default boolean
isStatic()
Indicates if this filesystem is a static snapshot or changes.Retrieves aGFile
from this filesystem based on its full path and filename, using this filesystem's default name comparison logic (eg.default GFile
resolveSymlinks
(GFile file) Converts the specified (symlink) file into it's destination, or if not a symlink, returns the original file unchanged.
-
Method Details
-
getName
String getName()File system volume name.Typically the name of the container file, or a internally stored 'volume' name.
- Returns:
- string filesystem volume name.
-
getType
Returns the type of this file system.This default implementation returns the type value in
FileSystemInfo
annotation.- Returns:
- type string
-
getDescription
Returns a description of this file system.This default implementation returns the description value in
FileSystemInfo
annotation.- Returns:
- description string
-
getFSRL
FSRLRoot getFSRL()File system's FSRL- Returns:
FSRLRoot
of this filesystem.
-
isClosed
boolean isClosed()Returns true if the filesystem has beenclosed
- Returns:
- boolean true if the filesystem has been closed.
-
isStatic
default boolean isStatic()Indicates if this filesystem is a static snapshot or changes.- Returns:
- boolean true if the filesystem is static or false if dynamic content.
-
getRefManager
FileSystemRefManager getRefManager()Returns theref manager
that is responsible for creating and releasingrefs
to this filesystem.- Returns:
FileSystemRefManager
that manages references to this filesystem.
-
getFileCount
default int getFileCount()Returns the number of files in the filesystem, if known, otherwise -1 if not known.- Returns:
- number of files in this filesystem, -1 if not known.
-
lookup
Retrieves aGFile
from this filesystem based on its full path and filename, using this filesystem's default name comparison logic (eg. case sensitive vs insensitive).- Parameters:
path
- string path and filename of a file located in this filesystem. Usenull
or "/" to retrieve the root directory- Returns:
GFile
instance of requested file, null if not found.- Throws:
IOException
- if IO error when looking up file.
-
getRootDir
Returns the file system's root directory.Note: using
null
when callinggetListing(GFile)
is also valid.- Returns:
- file system's root directory
-
getInputStream
default InputStream getInputStream(GFile file, TaskMonitor monitor) throws IOException, CancelledException Returns anInputStream
that contains the contents of the specifiedGFile
.The caller is responsible for closing the stream.
- Parameters:
file
-GFile
to get an InputStream formonitor
-TaskMonitor
to watch and update progress- Returns:
- new
InputStream
contains the contents of the file or NULL if the file doesn't have data. - Throws:
IOException
- if IO problemCancelledException
- if user cancels.
-
getByteProvider
ByteProvider getByteProvider(GFile file, TaskMonitor monitor) throws IOException, CancelledException Returns aByteProvider
that contains the contents of the specifiedGFile
.The caller is responsible for closing the provider.
- Parameters:
file
-GFile
to get bytes formonitor
-TaskMonitor
to watch and update progress- Returns:
- new
ByteProvider
that contains the contents of the file, or NULL if file doesn't have data - Throws:
IOException
- if errorCancelledException
- if user cancels
-
getListing
Returns a list offiles
that reside in the specified directory on this filesystem.- Parameters:
directory
- NULL means root of filesystem.- Returns:
List
ofGFile
instances of file in the requested directory.- Throws:
IOException
- if IO problem.
-
getFileAttributes
Returns a container ofFileAttribute
values.Implementors of this method are not required to add FSRL, NAME, or PATH values unless the values are non-standard.
- Parameters:
file
-GFile
to get the attributes formonitor
-TaskMonitor
- Returns:
FileAttributes
instance (possibly read-only), maybe empty but never null
-
resolveSymlinks
Converts the specified (symlink) file into it's destination, or if not a symlink, returns the original file unchanged.- Parameters:
file
- symlink file to follow- Returns:
- destination of symlink, or original file if not a symlink
- Throws:
IOException
- if error following symlink path, typically outside of the hosting file system
-
getInputStreamHelper
static InputStream getInputStreamHelper(GFile file, GFileSystem fs, TaskMonitor monitor) throws CancelledException, IOException - Parameters:
file
-GFile
fs
- thefilesystem
containing the filemonitor
-TaskMonitor
to allow canceling- Returns:
- new
InputStream
containing bytes of the file - Throws:
CancelledException
- if canceledIOException
- if error
-