com.github.fge.filesystem.driver

Class FileSystemDriverBase

java.lang.Object

com.github.fge.filesystem.driver.FileSystemDriverBase

All Implemented Interfaces:

FileSystemDriver, Closeable, AutoCloseable

Direct Known Subclasses:

UnixLikeFileSystemDriverBase

@ParametersAreNonnullByDefault
public abstract class FileSystemDriverBase
extends Object
implements FileSystemDriver

A FileSystemDriver with some reasonable defaults

The (overridable) defaults are:

• only basic file attributes are supported;
• no support for UserPrincipalLookupServices or WatchServices (both relevant methods throw an UnsupportedOperationException);
• no support for SeekableByteChannels;
• isSameFile(Path, Path) returns true if and only if both arguments are equal.

See Also:

UnixLikeFileSystemDriverBase

Field Summary

Fields

Modifier and Type	Field and Description
protected PathElementsFactory	pathElementsFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileSystemDriverBase(URI uri, PathElementsFactory pathElementsFactory, FileStore fileStore, PathMatcherProvider pathMatcherProvider)

Method Summary

Methods

Modifier and Type	Method and Description
FileStore	getFileStore() Get the FileStore associated with this filesystem
PathElementsFactory	getPathElementsFactory() Get the PathElementsFactory associated with this filesystem
PathMatcherProvider	getPathMatcherProvider() Get a PathMatcher provider for this filesystem
PathElements	getRoot() Get the root path elements for this filesystem
Set<String>	getSupportedFileAttributeViews() Get a non-modifiable set of file attribute views supported by this filesystem
URI	getUri() Get the URI associated with this filesystem
UserPrincipalLookupService	getUserPrincipalLookupService() Get a user/group lookup service for this filesystem
boolean	isSameFile(Path path, Path path2) Tell whether two paths actually refer to the same resource on this filesystem
SeekableByteChannel	newByteChannel(Path path, Set<? extends OpenOption> options, FileAttribute<?>... attrs) Obtain a new SeekableByteChannel from a path for this filesystem
WatchService	newWatchService() Get a file watch service for this filesystem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.github.fge.filesystem.driver.FileSystemDriver

checkAccess, copy, createDirectory, delete, getFileAttributeView, isHidden, move, newDirectoryStream, newInputStream, newOutputStream, readAttributes, readAttributes, setAttribute

Methods inherited from interface java.io.Closeable

close

Field Detail

pathElementsFactory

protected final PathElementsFactory pathElementsFactory

Constructor Detail

FileSystemDriverBase

protected FileSystemDriverBase(URI uri,
                    PathElementsFactory pathElementsFactory,
                    FileStore fileStore,
                    PathMatcherProvider pathMatcherProvider)

Method Detail

getUri

@Nonnull
public final URI getUri()

Description copied from interface: FileSystemDriver

Get the URI associated with this filesystem

Specified by:

getUri in interface FileSystemDriver

Returns:

a URI (always absolute and hierarchical)

getPathElementsFactory

@Nonnull
public final PathElementsFactory getPathElementsFactory()

Description copied from interface: FileSystemDriver

Get the PathElementsFactory associated with this filesystem

Specified by:

getPathElementsFactory in interface FileSystemDriver

Returns:

a path elements factory

getRoot

@Nonnull
public final PathElements getRoot()

Description copied from interface: FileSystemDriver

Get the root path elements for this filesystem

Typically, for Unix-like systems, this will be /.

Specified by:

getRoot in interface FileSystemDriver

Returns:

a PathElements representing the root of the hierarchy

See Also:

FileSystem.getRootDirectories()

getFileStore

@Nonnull
public final FileStore getFileStore()

Description copied from interface: FileSystemDriver

Get the FileStore associated with this filesystem

Specified by:

getFileStore in interface FileSystemDriver

Returns:

a FileStore

See Also:

FileStoreBase

getSupportedFileAttributeViews

@Nonnull
public Set<String> getSupportedFileAttributeViews()

Description copied from interface: FileSystemDriver

Get a non-modifiable set of file attribute views supported by this filesystem

This set (and therefore all implemented filesystems) must at least contain "basic".

Specified by:

getSupportedFileAttributeViews in interface FileSystemDriver

Returns:

an immutable set

See Also:

FileSystem.supportedFileAttributeViews()

getPathMatcherProvider

@Nonnull
public final PathMatcherProvider getPathMatcherProvider()

Description copied from interface: FileSystemDriver

Get a PathMatcher provider for this filesystem

Specified by:

getPathMatcherProvider in interface FileSystemDriver

Returns:

a path matcher provider

See Also:

FileSystem.getPathMatcher(String), com.github.fge.filesystem.path.matchers

getUserPrincipalLookupService

@Nonnull
public UserPrincipalLookupService getUserPrincipalLookupService()

Description copied from interface: FileSystemDriver

Get a user/group lookup service for this filesystem

Specified by:

getUserPrincipalLookupService in interface FileSystemDriver

Returns:

a user/group lookup service

See Also:

FileSystem.getUserPrincipalLookupService()

newWatchService

@Nonnull
public WatchService newWatchService()

Description copied from interface: FileSystemDriver

Get a file watch service for this filesystem

Specified by:

newWatchService in interface FileSystemDriver

Returns:

a watch service

See Also:

FileSystem.newWatchService()

newByteChannel

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

Description copied from interface: FileSystemDriver

Obtain a new SeekableByteChannel from a path for this filesystem

Note that a SeekableByteChannel supports both reads and writes.

Specified by:

newByteChannel in interface FileSystemDriver

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[])

isSameFile

public boolean isSameFile(Path path,
                 Path path2)
                   throws IOException

Description copied from interface: FileSystemDriver

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.

Specified by:

isSameFile in interface FileSystemDriver

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)