HWDiskStore (oshi-core 3.12.2 API)

java.lang.Object
- oshi.hardware.HWDiskStore

All Implemented Interfaces:

Serializable, Comparable<HWDiskStore>
```
public class HWDiskStore
extends Object
implements Serializable, 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 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 an object with empty/default values

HWDiskStore(HWDiskStore diskStore)
Copy constructor

Constructors
Constructor and Description
`HWDiskStore()` Create an object with empty/default values
`HWDiskStore(HWDiskStore diskStore)` Copy constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(HWDiskStore store)`
`boolean`	`equals(Object obj)`
`long`	`getCurrentQueueLength()`
`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`	`setCurrentQueueLength(long currentQueueLength)`
`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)`
`boolean`	`updateDiskStats()` Make a best effort to update all the statistics about the drive without needing to recreate the drive list.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HWDiskStore
```
public HWDiskStore()
```
    Create an object with empty/default values
  - HWDiskStore
```
public HWDiskStore(HWDiskStore diskStore)
```
    Copy constructor
    
    Parameters:
    
    diskStore - The object to copy
- Method Detail
  - updateDiskStats
```
public boolean updateDiskStats()
```
    Make a best effort to update all the statistics about the drive without needing to recreate the drive list. This method provides for more frequent periodic updates of drive statistics. It will not detect if a removable drive has been removed and replaced by a different drive in between method calls.
    
    Returns:
    
    True if the update was (probably) successful, false if the disk was not found
  - 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
  - getCurrentQueueLength
```
public long getCurrentQueueLength()
```
    Returns:
    
    the length of the disk queue (#I/O's in progress). Includes I/O requests that have been issued to the device driver but have not yet completed. Not supported on macOS.
  - getTransferTime
```
public long getTransferTime()
```
    Returns:
    
    the milliseconds spent reading or writing
  - getPartitions
```
public HWPartition[] getPartitions()
```
    Returns:
    
    Returns the partitions on this drive.
  - 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
  - setCurrentQueueLength
```
public void setCurrentQueueLength(long currentQueueLength)
```
    Parameters:
    
    currentQueueLength - the length of the disk queue (#I/O's in progress) 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 - The partitions to set.
  - setTimeStamp
```
public void setTimeStamp(long timeStamp)
```
    Parameters:
    
    timeStamp - The timeStamp to set.
  - 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 java.lang.Object

Constructor Detail

HWDiskStore

HWDiskStore

Method Detail

updateDiskStats

getName

getModel

getSerial

getSize

getReads

getReadBytes

getWrites

getWriteBytes

getCurrentQueueLength

getTransferTime

getPartitions

getTimeStamp

setName

setModel

setSerial

setSize

setReads

setReadBytes

setWrites

setWriteBytes

setCurrentQueueLength

setTransferTime

setPartitions

setTimeStamp

compareTo

hashCode

equals