Class Variable

java.lang.Object

org.networkupstools.jnut.Variable

public class Variable
extends Object

Class representing a variable of a device.

It can be used to get and set its value (if possible). A Variable object can be retrieved from a Device instance and cannot be constructed directly.

Author:

Emilien Kia

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Variable(String name, Device device)	Internally create a variable.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Retrieve the variable description from UPSD and store it in a cache.
Device	getDevice()	Return the device to which the variable is related.
String[]	getEnumList()	Retrieve the list of possible values for an ENUM variable.
String	getName()	Return the variable name.
String[]	getRangeList()	Retrieve the list of possible ranges for a RANGE variable.
String	getType()	Retrieve the variable type from UPSD.
String	getValue()	Retrieve the variable value from UPSD and store it in a cache.
TrackingID	setValue(String value)	Set the variable value.
TrackingID	setValue(String value, int waitIntervalSec, int waitMaxCount)	Set the variable value, optionally waiting for completion.

Methods inherited from class Object

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

Constructor Details

Variable

protected Variable(String name,
 Device device)

Internally create a variable.

Parameters:

name - Variable name.

device - Device to which the variable is attached.

Method Details

getDevice

public Device getDevice()

Return the device to which the variable is related.

Returns:

Attached device.

getName

public String getName()

Return the variable name.

Returns:

Command name.

getValue

public String getValue()
                throws IOException,
NutException

Retrieve the variable value from UPSD and store it in a cache.

Returns:

Variable value

Throws:

IOException

NutException

getDescription

public String getDescription()
                      throws IOException,
NutException

Retrieve the variable description from UPSD and store it in a cache.

Returns:

Variable description

Throws:

IOException

NutException

setValue

public TrackingID setValue(String value)
                    throws IOException,
NutException

Set the variable value. Note the new value can be applied with a little delay, depending on UPSD and connection.

Parameters:

value - New value for the variable

Returns:

Tracking ID if tracking is enabled, or null.

Throws:

IOException

NutException

setValue

public TrackingID setValue(String value,
 int waitIntervalSec,
 int waitMaxCount)
                    throws IOException,
NutException

Set the variable value, optionally waiting for completion.

Parameters:

value - New value for the variable.

waitIntervalSec - Interval between checks in seconds (if >= 1).

waitMaxCount - Maximum number of checks (if >= 1).

Returns:

Tracking ID if tracking is enabled (and not waiting), or null.

Throws:

IOException

NutException

getType

public String getType()
               throws IOException,
NutException

Retrieve the variable type from UPSD.

Returns:

Variable type string.

Throws:

IOException

NutException

getEnumList

public String[] getEnumList()
                     throws IOException,
NutException

Retrieve the list of possible values for an ENUM variable.

Returns:

List of values.

Throws:

IOException

NutException

getRangeList

public String[] getRangeList()
                      throws IOException,
NutException

Retrieve the list of possible ranges for a RANGE variable.

Returns:

List of range strings or structured data.

Throws:

IOException

NutException