com.github.fge.filesystem.filestore

Class FileStoreBase

java.lang.Object

java.nio.file.FileStore

com.github.fge.filesystem.filestore.FileStoreBase

Direct Known Subclasses:

UnsizedFileStoreBase

@ParametersAreNonnullByDefault
public abstract class FileStoreBase
extends FileStore

Base implementation of a FileStore

Limitations:

• no support for FileStoreAttributeViews

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileStoreBase(String name, boolean readOnly)
protected	FileStoreBase(String name, String type, boolean readOnly)

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(String attribute) Reads the value of a file store attribute.
<V extends FileStoreAttributeView> V	getFileStoreAttributeView(Class<V> type) Returns a FileStoreAttributeView of the given type.
boolean	isReadOnly() Tells whether this file store is read-only.
String	name() Returns the name of this file store.
String	type() Returns the type of this file store.

Methods inherited from class java.nio.file.FileStore

getTotalSpace, getUnallocatedSpace, getUsableSpace, supportsFileAttributeView, supportsFileAttributeView

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStoreBase

protected FileStoreBase(String name,
             String type,
             boolean readOnly)

FileStoreBase

protected FileStoreBase(String name,
             boolean readOnly)

Method Detail

name

public final String name()

Returns the name of this file store. The format of the name is highly implementation specific. It will typically be the name of the storage pool or volume.

The string returned by this method may differ from the string returned by the toString method.

Specified by:

name in class FileStore

Returns:

the name of this file store

type

public final String type()

Returns the type of this file store. The format of the string returned by this method is highly implementation specific. It may indicate, for example, the format used or if the file store is local or remote.

Specified by:

type in class FileStore

Returns:

a string representing the type of this file store

isReadOnly

public final boolean isReadOnly()

Tells whether this file store is read-only. A file store is read-only if it does not support write operations or other changes to files. Any attempt to create a file, open an existing file for writing etc. causes an IOException to be thrown.

Specified by:

isReadOnly in class FileStore

Returns:

true if, and only if, this file store is read-only

getFileStoreAttributeView

public final <V extends FileStoreAttributeView> V getFileStoreAttributeView(Class<V> type)

Returns a FileStoreAttributeView of the given type.

This method is intended to be used where the file store attribute view defines type-safe methods to read or update the file store attributes. The type parameter is the type of the attribute view required and the method returns an instance of that type if supported.

Specified by:

getFileStoreAttributeView in class FileStore

Parameters:

type - the Class object corresponding to the attribute view

Returns:

a file store attribute view of the specified type or null if the attribute view is not available

getAttribute

public final Object getAttribute(String attribute)
                          throws IOException

Reads the value of a file store attribute.

The attribute parameter identifies the attribute to be read and takes the form:

view-name:attribute-name

where the character ':' stands for itself.

view-name is the name of a AttributeView that identifies a set of file attributes. attribute-name is the name of the attribute.

Usage Example: Suppose we want to know if ZFS compression is enabled (assuming the "zfs" view is supported):

    boolean compression = (Boolean)fs.getAttribute("zfs:compression");
 

Specified by:

getAttribute in class FileStore

Parameters:

attribute - the attribute to read

Returns:

the attribute value; null may be a valid valid for some attributes

Throws:

UnsupportedOperationException - if the attribute view is not available or it does not support reading the attribute

IOException - if an I/O error occurs