Rio Project 4.2 API Documentation

org.rioproject.system.measurable.disk
Class CalculableDiskSpace

java.lang.Object
  org.rioproject.watch.Calculable
      org.rioproject.system.measurable.disk.CalculableDiskSpace

All Implemented Interfaces:

Serializable

public class CalculableDiskSpace
extends Calculable

A Calculable used to collect DiskSpace utilization

Author:

Dennis Reedy

See Also:

Serialized Form

Constructor Summary

CalculableDiskSpace(String id, DiskSpaceUtilization diskSpaceUtilization, long when)
Creates new CalculableDiskSpace

Method Summary

String	getArchiveRecord() Gets an archival representation for this Calculable
double	getAvailable() Getter for property available.
double	getCapacity() Getter for property capacity.
DiskSpaceUtilization	getDiskSpaceUtilization() Get the DiskSpaceUtilization
String	toString() Returns a string representation of the object.

Methods inherited from class org.rioproject.watch.Calculable

equals, getDate, getDetail, getId, getValue, getWhen, hashCode, setDetail, setId, setValue, setWhen

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CalculableDiskSpace

public CalculableDiskSpace(String id,
                           DiskSpaceUtilization diskSpaceUtilization,
                           long when)

Creates new CalculableDiskSpace

Parameters:

id - the identifier for this Calculable record

diskSpaceUtilization - The DiskSpaceUtilization

when - the time when the recorded utilization was captured

Method Detail

getCapacity

public double getCapacity()

Getter for property capacity.

Returns:

Value of property capacity.

getAvailable

public double getAvailable()

Getter for property available.

Returns:

Value of property available.

getDiskSpaceUtilization

public DiskSpaceUtilization getDiskSpaceUtilization()

Get the DiskSpaceUtilization

Returns:

DiskSpaceUtilization

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Calculable

Returns:

a string representation of the object.

getArchiveRecord

public String getArchiveRecord()

Gets an archival representation for this Calculable

Overrides:

getArchiveRecord in class Calculable

Returns:

a string representation in archive format