LongValueObject (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.vib.valueobjects.ValueObject
- - com.ergotech.vib.valueobjects.LongValueObject

All Implemented Interfaces:

ValueObjectInterface, java.lang.Cloneable
```
public class LongValueObject
extends ValueObject
```
This is the instance of ValueObject that is created when you use the setBoolValue(), setIntValue(), setFloatValue() and setStringValue(). Notice that this method does not store Objects. This is because we can not copy an Object and all ValueObjects must be able to copy themselves.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String cvsRev
- Fields inherited from class com.ergotech.vib.valueobjects.ValueObject
  defaultTTL, locale, traceDefault, valueForTrue
- Fields inherited from interface com.ergotech.vib.valueobjects.ValueObjectInterface
  ANYTYPE, ARRAYTYPE, BINARYTYPE, BOOLEANTYPE, BYTETYPE, CHARTYPE, DISPLAYVALUE, DOUBLETYPE, FLOATTYPE, GROUP_NAME, INITIALVALUE, INTTYPE, LOG_MESSAGE, LONGTYPE, NAME, OBJECTTYPE, ORDER, PASSWORD_DIGEST, PROPERTYTYPE, QUALITY_BAD, QUALITY_COMM_FAILURE, QUALITY_DEVICE_FAILURE, QUALITY_EGU_EXCEEDED, QUALITY_EVALUATION_EXPIRED, QUALITY_GOOD, QUALITY_IMPOSSIBLE, QUALITY_INITIAL, QUALITY_LAST_USABLE, QUALITY_OUT_OF_SERVICE, QUALITY_PROPERTYONLY, QUALITY_REMOTE_PROXY_INIT, QUALITY_SIMULATED, QUALITY_SOURCE_REMOVED, QUALITY_TRANSITIONAL, QUALITY_UNKNOWN, QUALITY_WARNING, QUALITY_WORST, QUALITY_WRITE_IN_PROGRESS, REQUESTCURRENTVALUE, REQUESTHISTORICAL, SHORTTYPE, STRINGTYPE, TRACE, TWODTYPE, UNSIGNEDBYTETYPE, UNSIGNEDINTTYPE, UNSIGNEDLONGTYPE, UNSIGNEDSHORTTYPE, USER_NAME

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`cvsRev`

Constructor Summary

Constructors
Constructor and Description
`LongValueObject()` The default constructor.
`LongValueObject(boolean newValue)` Creates a value object with the current integer value.
`LongValueObject(boolean newValue, java.awt.Color newColor)` Creates a value object with the current integer value.
`LongValueObject(byte newValue)` Creates a value object with the current integer value.
`LongValueObject(byte newValue, java.awt.Color newColor)` Creates a value object with the current integer value.
`LongValueObject(char newValue)` Creates a value object with the current integer value.
`LongValueObject(char newValue, java.awt.Color newColor)` Creates a value object with the current integer value.
`LongValueObject(int newValue)` Creates a value object with the current integer value.
`LongValueObject(int newValue, java.awt.Color newColor)` Creates a value object with the current integer value.
`LongValueObject(long newValue)` Creates a value object with the current integer value.
`LongValueObject(long newValue, java.awt.Color newColor)` Creates a value object with the current integer value.
`LongValueObject(short newValue)` Creates a value object with the current integer value.
`LongValueObject(short newValue, java.awt.Color newColor)` Creates a value object with the current integer value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ValueObjectInterface`	`copy()` Returns a deep copy of the value object.
`boolean`	`equals(java.lang.Object theObject)` This will return true if theObject is an instance of ValueObject and it's double value is the same as ours.
`byte[]`	`getBinaryValue()` This will return the current value of the ValueObject as a byte array.
`boolean`	`getBoolValue()` Returns the current value represented as a boolean.
`byte`	`getByteValue()` Returns the current value represented as an byte.
`double`	`getDoubleValue()` Returns the current value represented as a float.
`float`	`getFloatValue()` Returns the current value represented as an float.
`int`	`getIntValue()` Returns the current value represented as an integer.
`long`	`getLongValue()` Returns the current value represented as a long.
`double`	`getNumericValue()` Returns the double value, but will throw an exception if the object isn't convertable.
`java.lang.Object`	`getObjectValue()` Returns the current value represented as an Object.
`short`	`getShortValue()` Returns the current value represented as a short.
`java.lang.String`	`getStringValue()` Returns the current value represented as an String.
`int`	`hashCode()`

Methods inherited from class com.ergotech.vib.valueobjects.ValueObject
acquireLatestPropertiesFrom, acquirePropertiesFrom, attributeNames, compareTo, convertToLowestPrecisionNumber, decrementTTL, escapeJSON, getAlwaysSend, getColor, getDate, getLocale, getLowestPrecisionValueObject, getProperties, getProperty, getQuality, getQualityString, getTime, getTimeMillis, getTTL, getType, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, replaces, setAlwaysSend, setColor, setDate, setLocale, setProperty, setQuality, setTimeMillis, setTTL, setType, setValueForTrue, shouldTrace, toJSON, toJSON, toJSON, toString

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

- Field Detail
  - cvsRev
```
public static final java.lang.String cvsRev
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LongValueObject
```
public LongValueObject()
```
    The default constructor. It sets the current value to an integer value of 0.
  - LongValueObject
```
public LongValueObject(boolean newValue)
```
    Creates a value object with the current integer value.
    
    Parameters:
    
    newValue - The value stored
  - LongValueObject
```
public LongValueObject(boolean newValue,
                       java.awt.Color newColor)
```
    Creates a value object with the current integer value. and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color assocaiated with the newValue.
  - LongValueObject
```
public LongValueObject(byte newValue)
```
    Creates a value object with the current integer value.
    
    Parameters:
    
    newValue - The value stored
  - LongValueObject
```
public LongValueObject(byte newValue,
                       java.awt.Color newColor)
```
    Creates a value object with the current integer value. and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color assocaiated with the newValue.
  - LongValueObject
```
public LongValueObject(char newValue)
```
    Creates a value object with the current integer value.
    
    Parameters:
    
    newValue - The value stored
  - LongValueObject
```
public LongValueObject(char newValue,
                       java.awt.Color newColor)
```
    Creates a value object with the current integer value. and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color assocaiated with the newValue.
  - LongValueObject
```
public LongValueObject(int newValue)
```
    Creates a value object with the current integer value.
    
    Parameters:
    
    newValue - The value stored
  - LongValueObject
```
public LongValueObject(int newValue,
                       java.awt.Color newColor)
```
    Creates a value object with the current integer value. and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color assocaiated with the newValue.
  - LongValueObject
```
public LongValueObject(long newValue)
```
    Creates a value object with the current integer value.
    
    Parameters:
    
    newValue - The value stored
  - LongValueObject
```
public LongValueObject(long newValue,
                       java.awt.Color newColor)
```
    Creates a value object with the current integer value. and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color assocaiated with the newValue.
  - LongValueObject
```
public LongValueObject(short newValue)
```
    Creates a value object with the current integer value.
    
    Parameters:
    
    newValue - The value stored
  - LongValueObject
```
public LongValueObject(short newValue,
                       java.awt.Color newColor)
```
    Creates a value object with the current integer value. and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color assocaiated with the newValue.
- Method Detail
  - copy
```
public ValueObjectInterface copy()
```
    Returns a deep copy of the value object.
    
    Returns:
    
    a deep copy of the value object
  - equals
```
public boolean equals(java.lang.Object theObject)
```
    This will return true if theObject is an instance of ValueObject and it's double value is the same as ours.
    
    Specified by:
    
    equals in interface ValueObjectInterface
    
    Overrides:
    
    equals in class ValueObject
    
    Returns:
    
    a boolean result of the equals operation
  - getBinaryValue
```
public byte[] getBinaryValue()
```
    This will return the current value of the ValueObject as a byte array. This returns new byte[] = {getByteValue()};
    
    Specified by:
    
    getBinaryValue in interface ValueObjectInterface
    
    Overrides:
    
    getBinaryValue in class ValueObject
    
    Returns:
    
    the value as a String
  - getBoolValue
```
public boolean getBoolValue()
```
    Returns the current value represented as a boolean. This is defined as true if the currentValue is not equal to 0, and false if it is.
    
    Returns:
    
    the current value as a boolean
  - getByteValue
```
public byte getByteValue()
```
    Returns the current value represented as an byte.
    
    Returns:
    
    the current value as a byte
  - getDoubleValue
```
public double getDoubleValue()
```
    Returns the current value represented as a float.
    
    Returns:
    
    the current value as a double
    
    See Also:
    
    ValueObjectInterface.getNumericValue()
  - getFloatValue
```
public float getFloatValue()
```
    Returns the current value represented as an float.
    
    Returns:
    
    the current value as an float
  - getIntValue
```
public int getIntValue()
```
    Returns the current value represented as an integer.
    
    Returns:
    
    the current value as an integer
  - getLongValue
```
public long getLongValue()
```
    Returns the current value represented as a long.
    
    Returns:
    
    the current value as a long
  - getNumericValue
```
public double getNumericValue()
                       throws java.lang.NumberFormatException
```
    Returns the double value, but will throw an exception if the object isn't convertable.
    
    Returns:
    
    the current value as a double
    
    Throws:
    
    java.lang.NumberFormatException
    
    See Also:
    
    ValueObjectInterface.getDoubleValue()
  - getObjectValue
```
public java.lang.Object getObjectValue()
```
    Returns the current value represented as an Object.
    
    Returns:
    
    the current value as an Object
  - getShortValue
```
public short getShortValue()
```
    Returns the current value represented as a short.
    
    Returns:
    
    the current value as a short
  - getStringValue
```
public java.lang.String getStringValue()
```
    Returns the current value represented as an String.
    
    Returns:
    
    the current value as a String
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class ValueObject

Class LongValueObject

Field Summary

Fields inherited from class com.ergotech.vib.valueobjects.ValueObject

Fields inherited from interface com.ergotech.vib.valueobjects.ValueObjectInterface

Constructor Summary

Method Summary

Methods inherited from class com.ergotech.vib.valueobjects.ValueObject

Methods inherited from class java.lang.Object

Field Detail

cvsRev

Constructor Detail

LongValueObject

LongValueObject

LongValueObject

LongValueObject

LongValueObject

LongValueObject

LongValueObject

LongValueObject

LongValueObject

LongValueObject

LongValueObject

LongValueObject

LongValueObject

Method Detail

copy

equals

getBinaryValue

getBoolValue

getByteValue

getDoubleValue

getFloatValue

getIntValue

getLongValue

getNumericValue

getObjectValue

getShortValue

getStringValue

hashCode