com.github.fge.filesystem.driver

Class ReadOnlyFileSystemDriver

java.lang.Object

com.github.fge.filesystem.driver.ReadOnlyFileSystemDriver

All Implemented Interfaces:

FileSystemDriver, Closeable, AutoCloseable

@ParametersAreNonnullByDefault
public final class ReadOnlyFileSystemDriver
extends Object
implements FileSystemDriver

A FileSystemDriver composition implementation over another driver for read only filesystems

This class will delegate all read only operations to the underlying driver and will make all write operations throw a ReadOnlyFileSystemException.

Constructor Summary

Constructors

Constructor and Description
ReadOnlyFileSystemDriver(FileSystemDriver delegate)

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	close() Closes this stream and releases any system resources associated with it.
void	copy(Path source, Path target, 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
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	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, 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, OpenOption... options) Obtain a new InputStream from a path for this filesystem
OutputStream	newOutputStream(Path path, 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 class java.lang.Object

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

Constructor Detail

ReadOnlyFileSystemDriver

public ReadOnlyFileSystemDriver(FileSystemDriver delegate)

Method Detail

newOutputStream

@Nonnull
public OutputStream newOutputStream(Path path,
                                   OpenOption... options)
                             throws IOException

Obtain a new OutputStream from a path for this filesystem

Specified by:

newOutputStream in interface FileSystemDriver

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

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

createDirectory

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

Create a new directory from a path on this filesystem

Specified by:

createDirectory in interface FileSystemDriver

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.newDirectoryStream(Path, DirectoryStream.Filter)

delete

public void delete(Path path)
            throws IOException

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

Specified by:

delete in interface FileSystemDriver

Parameters:

path - the victim

Throws:

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

See Also:

FileSystemProvider.delete(Path)

copy

public void copy(Path source,
        Path target,
        CopyOption... options)
          throws IOException

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

Specified by:

copy in interface FileSystemDriver

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

public void move(Path source,
        Path target,
        CopyOption... options)
          throws IOException

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

Specified by:

move in interface FileSystemDriver

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

setAttribute

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

Set an attribute for a path on this filesystem

Specified by:

setAttribute in interface FileSystemDriver

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

getUri

@Nonnull
public URI getUri()

Get the URI associated with this filesystem

Specified by:

getUri in interface FileSystemDriver

Returns:

a URI (always absolute and hierarchical)

getPathElementsFactory

@Nonnull
public PathElementsFactory getPathElementsFactory()

Get the PathElementsFactory associated with this filesystem

Specified by:

getPathElementsFactory in interface FileSystemDriver

Returns:

a path elements factory

getRoot

@Nonnull
public PathElements getRoot()

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 FileStore getFileStore()

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

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 PathMatcherProvider getPathMatcherProvider()

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

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

Get a file watch service for this filesystem

Specified by:

newWatchService in interface FileSystemDriver

Returns:

a watch service

See Also:

FileSystem.newWatchService()

newInputStream

@Nonnull
public InputStream newInputStream(Path path,
                                 OpenOption... options)
                           throws IOException

Obtain a new InputStream from a path for this filesystem

Specified by:

newInputStream in interface FileSystemDriver

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

newDirectoryStream

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

Create a new directory stream from a path for this filesystem

Specified by:

newDirectoryStream in interface FileSystemDriver

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)

isSameFile

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

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)

isHidden

public 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 (".").

Specified by:

isHidden in interface FileSystemDriver

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

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

Specified by:

checkAccess in interface FileSystemDriver

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
public <V extends FileAttributeView> V getFileAttributeView(Path path,
                                                            Class<V> type,
                                                            LinkOption... options)

Read an attribute view for a given path on this filesystem

Specified by:

getFileAttributeView in interface FileSystemDriver

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

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

Read attributes from a path on this filesystem

Specified by:

readAttributes in interface FileSystemDriver

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

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

Read a list of attributes from a path on this filesystem

Specified by:

readAttributes in interface FileSystemDriver

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

close

public void close()
           throws IOException

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O error occurs