GenericValueObject (ErgoTech VIB/TransSECS Scripting API)

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

All Implemented Interfaces:

ValueObjectInterface, java.lang.Cloneable
```
public class GenericValueObject
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
`GenericValueObject()` The default constructor.
`GenericValueObject(boolean newValue)` Creates a value object with the current boolean value.
`GenericValueObject(boolean newValue, java.awt.Color newColor)` Creates a value object with the current value a boolean and the color associated with that value newColor
`GenericValueObject(byte newValue)` Creates a value object with the current byte value.
`GenericValueObject(byte newValue, java.awt.Color newColor)` Creates a value object with the current byte value and the color associated with that value (newColor).
`GenericValueObject(char newValue)` Creates a value object with the current char value.
`GenericValueObject(char newValue, java.awt.Color newColor)` Creates a value object with the current char value and the color associated with that value (newColor).
`GenericValueObject(double newValue)` Creates a value object with the current double value.
`GenericValueObject(double newValue, java.awt.Color newColor)` Creates a value object with the current double value and the color associated with that value (newColor).
`GenericValueObject(float newValue)` Creates a value object with the current float value.
`GenericValueObject(float newValue, java.awt.Color newColor)` Creates a value object with the current float value and the color associated with that value (newColor).
`GenericValueObject(int newValue)` Creates a value object with the current integer value.
`GenericValueObject(int newValue, java.awt.Color newColor)` Creates a value object with the current integer value.
`GenericValueObject(long newValue)` Creates a value object with the current long value.
`GenericValueObject(long newValue, java.awt.Color newColor)` Creates a value object with the current long value and the color associated with that value (newColor).
`GenericValueObject(java.lang.Object newValue)` Creates a value object with the current value a Serializable Object.
`GenericValueObject(java.io.Serializable newValue)` Creates a value object with the current value a Serializable Object.
`GenericValueObject(java.io.Serializable newValue, boolean copy)` Creates a value object with the current value a Serializable Object.
`GenericValueObject(java.io.Serializable newValue, java.awt.Color newColor)` Creates a value object with the current value a Serializable Object and the color associated with that value.
`GenericValueObject(short newValue)` Creates a value object with the current short value.
`GenericValueObject(short newValue, java.awt.Color newColor)` Creates a value object with the current short value and the color associated with that value (newColor).
`GenericValueObject(java.lang.String newValue)` Creates a value object with the current String value.
`GenericValueObject(java.lang.String newValue, java.awt.Color newColor)` Creates a value object with the current String value and the color associated with that 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 if possible.
`java.io.Serializable`	`copyObject(java.io.Serializable theObject)` make a copy of any serializable object
`boolean`	`equals(java.lang.Object theObject)` Compare the string values
`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 double.
`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 current value represented as a double.
`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, getBinaryValue, 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
  - GenericValueObject
```
public GenericValueObject()
```
    The default constructor. It sets the current value to an integer value of 0 and sets a time stamp
  - GenericValueObject
```
public GenericValueObject(boolean newValue)
```
    Creates a value object with the current boolean value. The type char is 'Z'.
    
    Parameters:
    
    newValue - The value stored
  - GenericValueObject
```
public GenericValueObject(boolean newValue,
                          java.awt.Color newColor)
```
    Creates a value object with the current value a boolean and the color associated with that value newColor
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color associated with the newValue.
  - GenericValueObject
```
public GenericValueObject(byte newValue)
```
    Creates a value object with the current byte value. The type char is 'B'.
    
    Parameters:
    
    newValue - The value stored
  - GenericValueObject
```
public GenericValueObject(byte newValue,
                          java.awt.Color newColor)
```
    Creates a value object with the current byte value and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color associated with the newValue.
  - GenericValueObject
```
public GenericValueObject(char newValue)
```
    Creates a value object with the current char value. The type char is 'C'.
    
    Parameters:
    
    newValue - The value stored
  - GenericValueObject
```
public GenericValueObject(char newValue,
                          java.awt.Color newColor)
```
    Creates a value object with the current char value and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color associated with the newValue.
  - GenericValueObject
```
public GenericValueObject(double newValue)
```
    Creates a value object with the current double value. The type char is 'D'.
    
    Parameters:
    
    newValue - The value stored
  - GenericValueObject
```
public GenericValueObject(double newValue,
                          java.awt.Color newColor)
```
    Creates a value object with the current double value and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color associated with the newValue.
  - GenericValueObject
```
public GenericValueObject(float newValue)
```
    Creates a value object with the current float value. The type char is 'F'.
    
    Parameters:
    
    newValue - The value stored
  - GenericValueObject
```
public GenericValueObject(float newValue,
                          java.awt.Color newColor)
```
    Creates a value object with the current float value and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color associated with the newValue.
  - GenericValueObject
```
public GenericValueObject(int newValue)
```
    Creates a value object with the current integer value. The type char is 'I'.
    
    Parameters:
    
    newValue - The value stored
  - GenericValueObject
```
public GenericValueObject(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 associated with the newValue.
  - GenericValueObject
```
public GenericValueObject(long newValue)
```
    Creates a value object with the current long value. The type char is 'J'.
    
    Parameters:
    
    newValue - The value stored
  - GenericValueObject
```
public GenericValueObject(long newValue,
                          java.awt.Color newColor)
```
    Creates a value object with the current long value and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color associated with the newValue.
  - GenericValueObject
```
public GenericValueObject(java.lang.Object newValue)
```
    Creates a value object with the current value a Serializable Object. The type char is 'L'.
    
    Parameters:
    
    newValue - The value stored
  - GenericValueObject
```
public GenericValueObject(java.io.Serializable newValue)
```
    Creates a value object with the current value a Serializable Object. The type char is 'L'.
    
    Parameters:
    
    newValue - The value stored
  - GenericValueObject
```
public GenericValueObject(java.io.Serializable newValue,
                          boolean copy)
```
    Creates a value object with the current value a Serializable Object. The type char is 'L'.
    
    Parameters:
    
    newValue - The value stored
  - GenericValueObject
```
public GenericValueObject(java.io.Serializable newValue,
                          java.awt.Color newColor)
```
    Creates a value object with the current value a Serializable Object and the color associated with that value.
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color associated with the newValue.
  - GenericValueObject
```
public GenericValueObject(short newValue)
```
    Creates a value object with the current short value. The type char is 'S'.
    
    Parameters:
    
    newValue - The value stored
  - GenericValueObject
```
public GenericValueObject(short newValue,
                          java.awt.Color newColor)
```
    Creates a value object with the current short value and the color associated with that value (newColor).
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color associated with the newValue.
  - GenericValueObject
```
public GenericValueObject(java.lang.String newValue)
```
    Creates a value object with the current String value. The type char is 's'.
    
    Parameters:
    
    newValue - The value stored
  - GenericValueObject
```
public GenericValueObject(java.lang.String newValue,
                          java.awt.Color newColor)
```
    Creates a value object with the current String value and the color associated with that value.
    
    Parameters:
    
    newValue - the value stored
    
    newColor - the color associated with the newValue.
- Method Detail
  - copy
```
public ValueObjectInterface copy()
```
    Returns a deep copy of the value object if possible. If the value cannot be copied, that is, it is not a known type (or Serializable) then a shallow copy is returned with the currentValue being the same in both objects.
    
    Returns:
    
    a copy of the value object
  - copyObject
```
public java.io.Serializable copyObject(java.io.Serializable theObject)
                                throws java.io.IOException,
                                       java.lang.ClassNotFoundException
```
    make a copy of any serializable object
    
    Returns:
    
    the new object
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException
  - equals
```
public boolean equals(java.lang.Object theObject)
```
    Description copied from class: ValueObject
    
    Compare the string values
    
    Specified by:
    
    equals in interface ValueObjectInterface
    
    Overrides:
    
    equals in class ValueObject
    
    Returns:
    
    a boolean result of the equals operation
  - 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 double.
    
    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 current value represented as a double.
    
    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 GenericValueObject

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

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

GenericValueObject

Method Detail

copy

copyObject

equals

getBoolValue

getByteValue

getDoubleValue

getFloatValue

getIntValue

getLongValue

getNumericValue

getObjectValue

getShortValue

getStringValue

hashCode