oshi.json.software.os

Class OSFileStore

java.lang.Object

oshi.json.json.AbstractOshiJsonObject

oshi.json.software.os.OSFileStore

All Implemented Interfaces:

Serializable, OshiJsonObject

public class OSFileStore
extends AbstractOshiJsonObject

A File Store is a storage pool, device, partition, volume, concrete file system or other implementation specific means of file storage. See subclasses for definitions as they apply to specific platforms.

Author:

widdis[at]gmail[dot]com

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OSFileStore(String newName, String newVolume, String newMount, String newDescription, String newType, String newUuid, long newUsableSpace, long newTotalSpace) Creates an OSFileStore with the specified parameters.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Description of the File System
String	getMount() Mountpoint of the File System
String	getName() Name of the File System
long	getTotalSpace() Total space/capacity of the drive.
String	getType() Type of the File System (FAT, NTFS, etx2, ext4, etc)
long	getUsableSpace() Usable space on the drive.
String	getUUID() UUID/GUID of the File System
String	getVolume() Volume of the File System
void	setDescription(String value) Sets the File System description
void	setMount(String value) Sets the mountpoint of the File System
void	setName(String value) Sets the File System name
void	setTotalSpace(long value) Sets the total space on the drive.
void	setType(String value) Sets the File System type
void	setUsableSpace(long value) Sets usable space on the drive.
void	setUUID(String value) Sets the File System UUID/GUID
void	setVolume(String value) Sets the volume of the File System
javax.json.JsonObject	toJSON(Properties properties) Returns this object as a JsonObject.

Methods inherited from class oshi.json.json.AbstractOshiJsonObject

toCompactJSON, toCompactJSON, toJSON, toPrettyJSON, toPrettyJSON, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

OSFileStore

public OSFileStore(String newName,
                   String newVolume,
                   String newMount,
                   String newDescription,
                   String newType,
                   String newUuid,
                   long newUsableSpace,
                   long newTotalSpace)

Creates an OSFileStore with the specified parameters.

Parameters:

newName - Name of the filestore

newVolume - Volume of the filestore

newMount - Mountpoint of the filestore

newDescription - Description of the file store

newType - Type of the filestore, e.g. FAT, NTFS, etx2, ext4, etc.

newUuid - UUID/GUID of the filestore

newUsableSpace - Available/usable bytes

newTotalSpace - Total bytes

Method Detail

getName

public String getName()

Name of the File System

Returns:

The file system name

setName

public void setName(String value)

Sets the File System name

Parameters:

value - The name

getVolume

public String getVolume()

Volume of the File System

Returns:

The volume of the file system

setVolume

public void setVolume(String value)

Sets the volume of the File System

Parameters:

value - The volume

getMount

public String getMount()

Mountpoint of the File System

Returns:

The mountpoint of the file system

setMount

public void setMount(String value)

Sets the mountpoint of the File System

Parameters:

value - The mountpoint

getDescription

public String getDescription()

Description of the File System

Returns:

The file system description

setDescription

public void setDescription(String value)

Sets the File System description

Parameters:

value - The description

getType

public String getType()

Type of the File System (FAT, NTFS, etx2, ext4, etc)

Returns:

The file system type

setType

public void setType(String value)

Sets the File System type

Parameters:

value - The type

getUUID

public String getUUID()

UUID/GUID of the File System

Returns:

The file system UUID/GUID

setUUID

public void setUUID(String value)

Sets the File System UUID/GUID

Parameters:

value - The UUID/GUID

getUsableSpace

public long getUsableSpace()

Usable space on the drive.

Returns:

Usable space on the drive (in bytes)

setUsableSpace

public void setUsableSpace(long value)

Sets usable space on the drive.

Parameters:

value - Bytes of writable space.

getTotalSpace

public long getTotalSpace()

Total space/capacity of the drive.

Returns:

Total capacity of the drive (in bytes)

setTotalSpace

public void setTotalSpace(long value)

Sets the total space on the drive.

Parameters:

value - Bytes of total space.

toJSON

public javax.json.JsonObject toJSON(Properties properties)

Returns this object as a JsonObject. The provided properties will be set on this object to configure the type of information returned using this and future invocations of OshiJsonObject.toJSON().

Parameters:

properties - Properties to configure returned results

Returns:

a JsonObject for this class.