Class AbstractOSFileStore

java.lang.Object

oshi.software.common.AbstractOSFileStore

All Implemented Interfaces:

OSFileStore

Direct Known Subclasses:

AixOSFileStore, FreeBsdOSFileStore, LinuxOSFileStore, MacOSFileStore, OpenBsdOSFileStore, SolarisOSFileStore, WindowsOSFileStore

@ThreadSafe
public abstract class AbstractOSFileStore
extends Object
implements OSFileStore

Common implementations for OSFileStore

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOSFileStore()
protected	AbstractOSFileStore(String name, String volume, String label, String mount, String options, String uuid, boolean local)

Method Summary

Modifier and Type	Method	Description
String	getLabel()	Label of the File System.
String	getMount()	Mount point of the File System.
String	getName()	Name of the File System.
String	getOptions()	Filesystem options.
String	getUUID()	UUID/GUID of the File System.
String	getVolume()	Volume name of the File System.
boolean	isLocal()	Indicates whether this file store is local, providing low-latency access.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface OSFileStore

getDescription, getFreeInodes, getFreeSpace, getLogicalVolume, getTotalInodes, getTotalSpace, getType, getUsableSpace, updateAttributes

Constructor Details

AbstractOSFileStore

protected AbstractOSFileStore(String name,
 String volume,
 String label,
 String mount,
 String options,
 String uuid,
 boolean local)

AbstractOSFileStore

protected AbstractOSFileStore()

Method Details

getName

public String getName()

Description copied from interface: OSFileStore

Name of the File System. A human-readable label that does not necessarily correspond to a file system path.

Specified by:

getName in interface OSFileStore

Returns:

The file system name

getVolume

public String getVolume()

Description copied from interface: OSFileStore

Volume name of the File System. Generally a path representing the device (e.g., /dev/foo which is being mounted.

Specified by:

getVolume in interface OSFileStore

Returns:

The volume name of the file system

getLabel

public String getLabel()

Description copied from interface: OSFileStore

Label of the File System. An optional replacement for the name on Windows and Linux.

Specified by:

getLabel in interface OSFileStore

Returns:

The volume label of the file system. Only relevant on Windows and on Linux, if assigned; otherwise defaults to the FileSystem name. On other operating systems is redundant with the name.

getMount

public String getMount()

Description copied from interface: OSFileStore

Mount point of the File System. The directory users will normally use to interface with the file store.

Specified by:

getMount in interface OSFileStore

Returns:

The mountpoint of the file system

getOptions

public String getOptions()

Description copied from interface: OSFileStore

Filesystem options.

Specified by:

getOptions in interface OSFileStore

Returns:

A comma-deimited string of options

getUUID

public String getUUID()

Description copied from interface: OSFileStore

UUID/GUID of the File System.

Specified by:

getUUID in interface OSFileStore

Returns:

The file system UUID/GUID

isLocal

public boolean isLocal()

Description copied from interface: OSFileStore

Indicates whether this file store is local, providing low-latency access.

Local file stores are directly attached storage that return immediate results for file operations. This excludes network-mounted file systems (e.g., NFS, CIFS/SMB, AFP) which may have higher latency or require network round-trips.

On macOS, this corresponds to the MNT_LOCAL mount flag. On other platforms, this returns false for file systems with network types such as nfs, cifs, smbfs, and afs.

Specified by:

isLocal in interface OSFileStore

Returns:

true if the file store is locally attached (not a network drive); false otherwise

toString

public String toString()

Overrides:

toString in class Object