com.github.fge.filesystem.filestore

Class FileStoreBase

java.lang.Object

java.nio.file.FileStore

com.github.fge.filesystem.filestore.FileStoreBase

@ParametersAreNonnullByDefault
public abstract class FileStoreBase
extends FileStore

Base implementation of a FileStore

Notes:

• at the moment, there is no support for FileStoreAttributeViews;
• by default, all size methods return Long.MAX_VALUE; as discussed on nio-dev, this is a reasonable value to return when the file store has no information on the actual size.

See Also:

FileStore

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileStoreBase(String name, FileAttributesFactory factory, boolean readOnly) Alternate constructor
protected	FileStoreBase(String name, String type, FileAttributesFactory factory, boolean readOnly) Main constructor

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(String attribute)
<V extends FileStoreAttributeView> V	getFileStoreAttributeView(Class<V> type)
long	getTotalSpace()
long	getUnallocatedSpace()
long	getUsableSpace()
boolean	isReadOnly()
String	name()
boolean	supportsFileAttributeView(Class<? extends FileAttributeView> type)
boolean	supportsFileAttributeView(String name)
String	type()

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,
             FileAttributesFactory factory,
             boolean readOnly)

Main constructor

Parameters:

name - the name of the file store

type - the type of the file store

factory - the associated FileAttributesFactory

readOnly - whether this filestore is read only

FileStoreBase

protected FileStoreBase(String name,
             FileAttributesFactory factory,
             boolean readOnly)

Alternate constructor

This constructor assumes that the name and type are the same; apart from that, all arguments are the same as for the other constructor.

Parameters:

name - the name (and type) of the file store

factory - the associated FileAttributesFactory

readOnly - whether this filestore is read only

Method Detail

name

public final String name()

Specified by:

name in class FileStore

type

public final String type()

Specified by:

type in class FileStore

isReadOnly

public final boolean isReadOnly()

Specified by:

isReadOnly in class FileStore

getTotalSpace

public long getTotalSpace()
                   throws IOException

Specified by:

getTotalSpace in class FileStore

Throws:

IOException

getUsableSpace

public long getUsableSpace()
                    throws IOException

Specified by:

getUsableSpace in class FileStore

Throws:

IOException

getUnallocatedSpace

public long getUnallocatedSpace()
                         throws IOException

Specified by:

getUnallocatedSpace in class FileStore

Throws:

IOException

supportsFileAttributeView

public final boolean supportsFileAttributeView(Class<? extends FileAttributeView> type)

Specified by:

supportsFileAttributeView in class FileStore

supportsFileAttributeView

public final boolean supportsFileAttributeView(String name)

Specified by:

supportsFileAttributeView in class FileStore

getFileStoreAttributeView

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

Specified by:

getFileStoreAttributeView in class FileStore

getAttribute

public final Object getAttribute(String attribute)
                          throws IOException

Specified by:

getAttribute in class FileStore

Throws:

IOException