HWDiskStore (oshi-json 3.4.2 API)

java.lang.Object
- oshi.json.json.AbstractOshiJsonObject
- - oshi.json.hardware.HWDiskStore

All Implemented Interfaces:

Serializable, Comparable<HWDiskStore>, OshiJsonObject
```
public class HWDiskStore
extends AbstractOshiJsonObject
implements Comparable<HWDiskStore>
```
A storage mechanism where data are recorded by various electronic, magnetic, optical, or mechanical changes to a surface layer of one or more rotating disks or flash storage such as a removable or solid state drive. In constrast to a File System, defining the way an Operating system uses the storage, the Disk Store represents the hardware which a FileSystem uses for its File Stores.

Author:

enrico[dot]bianchi[at]gmail[dot]com

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`HWDiskStore()` Create a new HWDiskStore with default/empty values
`HWDiskStore(String name, String model, String serial, long size, long reads, long readBytes, long writes, long writeBytes, long transferTime, HWPartition[] partitions, long timeStamp)` Create an object with all values

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(HWDiskStore store)`
`boolean`	`equals(Object obj)`
`String`	`getModel()`
`String`	`getName()`
`HWPartition[]`	`getPartitions()`
`long`	`getReadBytes()`
`long`	`getReads()`
`String`	`getSerial()`
`long`	`getSize()`
`long`	`getTimeStamp()`
`long`	`getTransferTime()`
`long`	`getWriteBytes()`
`long`	`getWrites()`
`int`	`hashCode()`
`void`	`setModel(String model)`
`void`	`setName(String name)`
`void`	`setPartitions(HWPartition[] partitions)`
`void`	`setReadBytes(long readBytes)`
`void`	`setReads(long reads)`
`void`	`setSerial(String serial)`
`void`	`setSize(long size)`
`void`	`setTimeStamp(long timeStamp)`
`void`	`setTransferTime(long transferTime)`
`void`	`setWriteBytes(long writeBytes)`
`void`	`setWrites(long writes)`
`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, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HWDiskStore
```
public HWDiskStore(String name,
                   String model,
                   String serial,
                   long size,
                   long reads,
                   long readBytes,
                   long writes,
                   long writeBytes,
                   long transferTime,
                   HWPartition[] partitions,
                   long timeStamp)
```
    Create an object with all values
    
    Parameters:
    
    name - Name of the disk (e.g., /dev/disk1)
    
    model - Model of the disk
    
    serial - Disk serial number, if available
    
    size - Disk capacity in bytes
    
    reads - Number of reads from the disk
    
    readBytes - Number of bytes read from the disk
    
    writes - Number of writes to the disk
    
    writeBytes - Number of bytes written to the disk
    
    transferTime - milliseconds spent reading or writing to the disk
    
    partitions - Partitions on this disk
    
    timeStamp - milliseconds since the epoch
  - HWDiskStore
```
public HWDiskStore()
```
    Create a new HWDiskStore with default/empty values
- Method Detail
  - getName
```
public String getName()
```
    Returns:
    
    the name
  - getModel
```
public String getModel()
```
    Returns:
    
    the model
  - getSerial
```
public String getSerial()
```
    Returns:
    
    the serial
  - getSize
```
public long getSize()
```
    Returns:
    
    Get size of disk (in bytes)
  - getReads
```
public long getReads()
```
    Returns:
    
    the reads
  - getReadBytes
```
public long getReadBytes()
```
    Returns:
    
    the bytes read
  - getWrites
```
public long getWrites()
```
    Returns:
    
    the writes
  - getWriteBytes
```
public long getWriteBytes()
```
    Returns:
    
    the bytes written
  - getTransferTime
```
public long getTransferTime()
```
    Returns:
    
    the milliseconds spent reading or writing
  - getPartitions
```
public HWPartition[] getPartitions()
```
    Returns:
    
    the partitions of this disk
  - getTimeStamp
```
public long getTimeStamp()
```
    Returns:
    
    Returns the timeStamp.
  - setName
```
public void setName(String name)
```
    Parameters:
    
    name - the name to set
  - setModel
```
public void setModel(String model)
```
    Parameters:
    
    model - the model to set
  - setSerial
```
public void setSerial(String serial)
```
    Parameters:
    
    serial - the serial to set
  - setSize
```
public void setSize(long size)
```
    Parameters:
    
    size - Set size of disk (in bytes)
  - setReads
```
public void setReads(long reads)
```
    Parameters:
    
    reads - the reads to set
  - setReadBytes
```
public void setReadBytes(long readBytes)
```
    Parameters:
    
    readBytes - the bytes read to set
  - setWrites
```
public void setWrites(long writes)
```
    Parameters:
    
    writes - the writes to set
  - setWriteBytes
```
public void setWriteBytes(long writeBytes)
```
    Parameters:
    
    writeBytes - the bytes written to set
  - setTransferTime
```
public void setTransferTime(long transferTime)
```
    Parameters:
    
    transferTime - milliseconds spent reading or writing to set
  - setPartitions
```
public void setPartitions(HWPartition[] partitions)
```
    Parameters:
    
    partitions - Partitions of this disk
  - setTimeStamp
```
public void setTimeStamp(long timeStamp)
```
    Parameters:
    
    timeStamp - The timeStamp to set.
  - 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().
    
    Specified by:
    
    toJSON in interface OshiJsonObject
    
    Parameters:
    
    properties - Properties to configure returned results
    
    Returns:
    
    a JsonObject for this class.
  - compareTo
```
public int compareTo(HWDiskStore store)
```
    Specified by:
    
    compareTo in interface Comparable<HWDiskStore>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class HWDiskStore

Constructor Summary

Method Summary

Methods inherited from class oshi.json.json.AbstractOshiJsonObject

Methods inherited from class java.lang.Object

Constructor Detail

HWDiskStore

HWDiskStore

Method Detail

getName

getModel

getSerial

getSize

getReads

getReadBytes

getWrites

getWriteBytes

getTransferTime

getPartitions

getTimeStamp

setName

setModel

setSerial

setSize

setReads

setReadBytes

setWrites

setWriteBytes

setTransferTime

setPartitions

setTimeStamp

toJSON

compareTo

hashCode

equals