com.ergotech.vib.valueobjects

Class StringValueObject

java.lang.Object

com.ergotech.vib.valueobjects.ValueObject

com.ergotech.vib.valueobjects.StringValueObject

All Implemented Interfaces:

ValueObjectInterface, java.lang.Cloneable

public class StringValueObject
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

Constructor Summary

Constructors

Constructor and Description
StringValueObject() The default constructor.
StringValueObject(java.util.Locale locale) The default constructor.
StringValueObject(java.lang.String newValue) Creates a value object with the current integer value.
StringValueObject(java.lang.String newValue, java.awt.Color newColor) Creates a value object with the current double value.
StringValueObject(java.lang.String newValue, java.util.Locale locale) Creates a value object with the current integer value.

Method Summary

Modifier and Type	Method and Description
ValueObjectInterface	convertToLowestPrecisionNumber() This will convert the StringValueObject to the lowest precision type, either a LongValueObject or a DoubleValueObject.
ValueObjectInterface	copy() Returns a deep copy of the value object.
boolean	equals(java.lang.Object theObject) Returns whether or not the String values are equivalent.
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.
java.util.Locale	getLocale() This method returns the Locale that this object was created in.
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 convertible.
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, decrementTTL, escapeJSON, getAlwaysSend, getBinaryValue, getColor, getDate, 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

StringValueObject

public StringValueObject()

The default constructor. It sets the current value to an integer value of 0 and the Locale to the default locale.

StringValueObject

public StringValueObject(java.util.Locale locale)

The default constructor. It sets the current value to an integer value of 0 and the Locale to the provided locale.

StringValueObject

public StringValueObject(java.lang.String newValue)

Creates a value object with the current integer value.

Parameters:

newValue - The value stored

StringValueObject

public StringValueObject(java.lang.String 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 assocaiated with the newValue.

StringValueObject

public StringValueObject(java.lang.String newValue,
                         java.util.Locale locale)

Creates a value object with the current integer value.

Parameters:

newValue - The value stored

Method Detail

convertToLowestPrecisionNumber

public ValueObjectInterface convertToLowestPrecisionNumber()

This will convert the StringValueObject to the lowest precision type, either a LongValueObject or a DoubleValueObject. If a SVO can convert to a Long without loss of precision then it will be returned as a LongValueObject. Otherwise it will be returned as a DoubleValueObject.

Specified by:

convertToLowestPrecisionNumber in interface ValueObjectInterface

Overrides:

convertToLowestPrecisionNumber in class ValueObject

Parameters:

voi - the StringValueObject to convert

Returns:

a LongValueObject or a DoubleValueObject

See Also:

StringValueObject

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)

Returns whether or not the String values are equivalent. This uses String.equals.

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 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

getLocale

public java.util.Locale getLocale()

This method returns the Locale that this object was created in. It may return null if the object has no interest in Locales.

Specified by:

getLocale in interface ValueObjectInterface

Overrides:

getLocale in class ValueObject

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 convertible.

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 represented as an String.

Returns:

the current value as a String

hashCode

public int hashCode()

Overrides:

hashCode in class ValueObject