com.github.fge.filesystem.driver

Interface FileSystemDriver

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

FileSystemDriverBase, ReadOnlyFileSystemDriver, UnixLikeFileSystemDriverBase

@ParametersAreNonnullByDefault
public interface FileSystemDriver
extends Closeable

The core filesystem class

This is the interface you have to implement in order to provide the guts of a FileSystem implementation. Do not implement this class directly: extend FileSystemDriverBase instead, or UnixLikeFileSystemDriverBase.

All methods dealing with I/O are implemented here and not in FileSystemProvider; it also contains methods specifically used by FileSystem.

Note: when entering methods in this class, it is guaranteed that all options are supported.

See Also:

GenericFileSystem, FileSystemProviderBase, FileSystemRepositoryBase

Method Summary

Methods

Modifier and Type	Method and Description
void	checkAccess(Path path, AccessMode... modes) Check access modes for a path on this filesystem
void	copy(Path source, Path target, Set<CopyOption> options) Copy a file, or empty directory, from one path to another on this filesystem
void	createDirectory(Path dir, FileAttribute<?>... attrs) Create a new directory from a path on this filesystem
void	delete(Path path) Delete a file, or empty directory, matching a path on this filesystem
<V extends FileAttributeView> V	getFileAttributeView(Path path, Class<V> type, LinkOption... options) Read an attribute view for a given path on this filesystem
FileStore	getFileStore() Get the FileStore associated with this filesystem
Object	getPathMetadata(Path path)
UserPrincipalLookupService	getUserPrincipalLookupService() Get a user/group lookup service for this filesystem
boolean	isHidden(Path path) Tell whether a path is to be considered hidden by this filesystem
boolean	isSameFile(Path path, Path path2) Tell whether two paths actually refer to the same resource on this filesystem
void	move(Path source, Path target, Set<CopyOption> options) Move a file, or empty directory, from one path to another on this filesystem
SeekableByteChannel	newByteChannel(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs) Obtain a new SeekableByteChannel from a path for this filesystem
DirectoryStream<Path>	newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter) Create a new directory stream from a path for this filesystem
InputStream	newInputStream(Path path, Set<OpenOption> options) Obtain a new InputStream from a path for this filesystem
OutputStream	newOutputStream(Path path, Set<OpenOption> options) Obtain a new OutputStream from a path for this filesystem
WatchService	newWatchService() Get a file watch service for this filesystem
<A extends BasicFileAttributes> A	readAttributes(Path path, Class<A> type, LinkOption... options) Read attributes from a path on this filesystem
Map<String,Object>	readAttributes(Path path, String attributes, LinkOption... options) Read a list of attributes from a path on this filesystem
void	setAttribute(Path path, String attribute, Object value, LinkOption... options) Set an attribute for a path on this filesystem

Methods inherited from interface java.io.Closeable

close

Method Detail

getFileStore

@Nonnull
FileStore getFileStore()

Get the FileStore associated with this filesystem

Returns:

a FileStore

See Also:

FileSystem.getFileStores(), FileStoreBase

getUserPrincipalLookupService

@Nonnull
UserPrincipalLookupService getUserPrincipalLookupService()

Get a user/group lookup service for this filesystem

Returns:

a user/group lookup service

See Also:

FileSystem.getUserPrincipalLookupService()

newWatchService

@Nonnull
WatchService newWatchService()

Get a file watch service for this filesystem

Returns:

a watch service

See Also:

FileSystem.newWatchService()

newInputStream

@Nonnull
InputStream newInputStream(Path path,
                                 Set<OpenOption> options)
                           throws IOException

Obtain a new InputStream from a path for this filesystem

Parameters:

path - the path

options - the set of open options

Returns:

a new input stream

Throws:

IOException - filesystem level error, or plain I/O error

See Also:

FileSystemProvider.newInputStream(Path, OpenOption...)

newOutputStream

@Nonnull
OutputStream newOutputStream(Path path,
                                   Set<OpenOption> options)
                             throws IOException

Obtain a new OutputStream from a path for this filesystem

Parameters:

path - the path

options - the set of open options

Returns:

a new output stream

Throws:

IOException - filesystem level error, or plain I/O error

See Also:

FileSystemProvider.newOutputStream(Path, OpenOption...)

newByteChannel

@Nonnull
SeekableByteChannel newByteChannel(Path path,
                                         Set<? extends OpenOption> options,
                                         FileAttribute<?>... attrs)
                                   throws IOException

Obtain a new SeekableByteChannel from a path for this filesystem

Note that a SeekableByteChannel supports both reads and writes.

Parameters:

path - the path

options - the set of open options

attrs - the attributes to create the file with (if it does not exist)

Returns:

a channel

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.newByteChannel(Path, Set, FileAttribute[])

newDirectoryStream

@Nonnull
DirectoryStream<Path> newDirectoryStream(Path dir,
                                               DirectoryStream.Filter<? super Path> filter)
                                         throws IOException

Create a new directory stream from a path for this filesystem

Parameters:

dir - the directory

filter - a directory entry filter

Returns:

a directory stream

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.newDirectoryStream(Path, DirectoryStream.Filter)

createDirectory

void createDirectory(Path dir,
                   FileAttribute<?>... attrs)
                     throws IOException

Create a new directory from a path on this filesystem

Parameters:

dir - the directory to create

attrs - the attributes with which the directory should be created

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.createDirectory(Path, FileAttribute[])

delete

void delete(Path path)
            throws IOException

Delete a file, or empty directory, matching a path on this filesystem

Parameters:

path - the victim

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.delete(Path)

copy

void copy(Path source,
        Path target,
        Set<CopyOption> options)
          throws IOException

Copy a file, or empty directory, from one path to another on this filesystem

Parameters:

source - the source path

target - the target path

options - the copy options

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.copy(Path, Path, CopyOption...)

move

void move(Path source,
        Path target,
        Set<CopyOption> options)
          throws IOException

Move a file, or empty directory, from one path to another on this filesystem

Parameters:

source - the source path

target - the target path

options - the copy options

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.move(Path, Path, CopyOption...)

isSameFile

boolean isSameFile(Path path,
                 Path path2)
                   throws IOException

Tell whether two paths actually refer to the same resource on this filesystem

Note that this DOES NOT apply to symbolic links, if the filesystem supports them; that is, if path is a symlink to path2, they are not the same file. Also, in spite of the method name, this method can be called on paths which are not regular files but directories, symlinks or others.

Two paths which are equal are always the same.

Parameters:

path - the first path

path2 - the second path

Returns:

true if and only if both path

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.isSameFile(Path, Path)

isHidden

boolean isHidden(Path path)
                 throws IOException

Tell whether a path is to be considered hidden by this filesystem

Typically, on Unix systems, it means the last name element of the path starts with a dot (".").

Parameters:

path - the path to test

Returns:

true if this path is considered hidden

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.isHidden(Path)

checkAccess

void checkAccess(Path path,
               AccessMode... modes)
                 throws IOException

Check access modes for a path on this filesystem

If no modes are provided to check for, this simply checks for the existence of the path.

Parameters:

path - the path to check

modes - the modes to check for, if any

Throws:

IOException - filesystem level error, or a plain I/O error

See Also:

FileSystemProvider.checkAccess(Path, AccessMode...)

getFileAttributeView

@Nullable
<V extends FileAttributeView> V getFileAttributeView(Path path,
                                                            Class<V> type,
                                                            LinkOption... options)

Read an attribute view for a given path on this filesystem

Type Parameters:

V - type parameter of the attribute view class

Parameters:

path - the path to read attributes from

type - the class of attribute view to return

options - the link options

Returns:

the attributes view; null if this view is not supported

See Also:

FileSystemProvider.getFileAttributeView(Path, Class, LinkOption...)

readAttributes

<A extends BasicFileAttributes> A readAttributes(Path path,
                                               Class<A> type,
                                               LinkOption... options)
                                             throws IOException

Read attributes from a path on this filesystem

Type Parameters:

A - parameter type for the attributs class

Parameters:

path - the path to read attributes from

type - the class of attributes to read

options - the link options

Returns:

the attributes

Throws:

IOException - filesystem level error, or a plain I/O error

UnsupportedOperationException - attribute type not supported

See Also:

FileSystemProvider.readAttributes(Path, Class, LinkOption...)

readAttributes

Map<String,Object> readAttributes(Path path,
                                String attributes,
                                LinkOption... options)
                                  throws IOException

Read a list of attributes from a path on this filesystem

Parameters:

path - the path to read attributes from

attributes - the list of attributes to read

options - the link options

Returns:

the relevant attributes as a map

Throws:

IOException - filesystem level error, or a plain I/O error

IllegalArgumentException - malformed attributes string; or a specified attribute does not exist

UnsupportedOperationException - one or more attribute(s) is/are not supported

See Also:

Files.readAttributes(Path, String, LinkOption...), FileSystemProvider.readAttributes(Path, String, LinkOption...)

setAttribute

void setAttribute(Path path,
                String attribute,
                Object value,
                LinkOption... options)
                  throws IOException

Set an attribute for a path on this filesystem

Parameters:

path - the victim

attribute - the name of the attribute to set

value - the value to set

options - the link options

Throws:

IOException - filesystem level error, or a plain I/O error

IllegalArgumentException - malformed attribute, or the specified attribute does not exist

UnsupportedOperationException - the attribute to set is not supported by this filesystem

ClassCastException - attribute value is of the wrong class for the specified attribute

See Also:

Files.setAttribute(Path, String, Object, LinkOption...), FileSystemProvider.setAttribute(Path, String, Object, LinkOption...)

getPathMetadata

@Nonnull
Object getPathMetadata(Path path)
                       throws IOException

Throws:

IOException