com.github.fge.filesystem.filestore

Class UnsizedFileStoreBase

java.lang.Object

java.nio.file.FileStore

com.github.fge.filesystem.filestore.FileStoreBase

com.github.fge.filesystem.filestore.UnsizedFileStoreBase

public abstract class UnsizedFileStoreBase
extends FileStoreBase

A FileStoreBase for which the different sizes are unknown

All size operations return Long.MAX_VALUE.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
long	getTotalSpace() Returns the size, in bytes, of the file store.
long	getUnallocatedSpace() Returns the number of unallocated bytes in the file store.
long	getUsableSpace() Returns the number of bytes available to this Java virtual machine on the file store.

Methods inherited from class com.github.fge.filesystem.filestore.FileStoreBase

getAttribute, getFileStoreAttributeView, isReadOnly, name, type

Methods inherited from class java.nio.file.FileStore

supportsFileAttributeView, supportsFileAttributeView

Methods inherited from class java.lang.Object

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

Constructor Detail

UnsizedFileStoreBase

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

UnsizedFileStoreBase

protected UnsizedFileStoreBase(String name,
                    boolean readOnly)

Method Detail

getTotalSpace

public final long getTotalSpace()
                         throws IOException

Returns the size, in bytes, of the file store.

Specified by:

getTotalSpace in class FileStore

Returns:

the size of the file store, in bytes

Throws:

IOException - if an I/O error occurs

getUsableSpace

public long getUsableSpace()
                    throws IOException

Returns the number of bytes available to this Java virtual machine on the file store.

The returned number of available bytes is a hint, but not a guarantee, that it is possible to use most or any of these bytes. The number of usable bytes is most likely to be accurate immediately after the space attributes are obtained. It is likely to be made inaccurate by any external I/O operations including those made on the system outside of this Java virtual machine.

Specified by:

getUsableSpace in class FileStore

Returns:

the number of bytes available

Throws:

IOException - if an I/O error occurs

getUnallocatedSpace

public long getUnallocatedSpace()
                         throws IOException

Returns the number of unallocated bytes in the file store.

The returned number of unallocated bytes is a hint, but not a guarantee, that it is possible to use most or any of these bytes. The number of unallocated bytes is most likely to be accurate immediately after the space attributes are obtained. It is likely to be made inaccurate by any external I/O operations including those made on the system outside of this virtual machine.

Specified by:

getUnallocatedSpace in class FileStore

Returns:

the number of unallocated bytes

Throws:

IOException - if an I/O error occurs