|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProcessVariableValue
Represents the value of a process variable on a client that is not running within the server JVM.
This representation is needed because the client who is requesting the values of variables may not
have all the classes in its classpath, and simply returning a value would cause a
ClassNotFoundException
. This class attempts to solve this problem by providing
a representation for values whose class may or may not be known by the client.
This class is also used to pass a short representation of a variable value.
Method Summary | |
---|---|
Object |
deserializeValue()
Convenience method for constructing the value object from its serialized form. |
String |
getDeclaredType()
Returns the declared type of the variable. |
String |
getName()
Returns the name of the process variable whose value is represented |
String |
getOriginalInstanceType()
Returns the original type of the value |
Object |
getValueRepresentation()
Returns a representation of the value of the process variable. |
boolean |
isObjectValueRep()
Returns true if the value of the variable obtained via getValueRepresentation()
is some form of the original value, rather than serialized value. |
boolean |
isSerializedValueRep()
Returns true if the value of the variable is repesented in its serialized form. |
boolean |
isShortRepresentation()
Returns true if this object contains a short String based representation of the variable value. |
boolean |
isTooLarge()
Returns true if the object was too large. |
boolean |
isUnrepresentableValue()
Returns true if the value of the variable cannot be represented outside the server JVM, and therefore is unavailable. |
boolean |
isXMLType()
Returns if the declared type is an XML type. |
Method Detail |
---|
String getName()
String getDeclaredType()
String getOriginalInstanceType()
boolean isXMLType()
Object getValueRepresentation()
Integer
will be returned
if the variable type is int.
Integer
then the original value is returned.
XmlObject
is returned,
regardless of the type of the xml.
RawData
, the result is a byte array
containing the bytes of the raw data.
WrappedThrowable
for more information about simple form of throwables.
deserializeValue()
for obtaining the original value.
isUnrepresentableValue()
before using the value.
Always use isTooLarge()
, isObjectValueRep()
, isSerializedValueRep()
,
isUnrepresentableValue()
to interpret the return value of this method.
boolean isShortRepresentation()
getValueRepresentation()
will always be a String (possibly null)
subject to size limitations.
boolean isTooLarge()
getValueRepresentation()
will always be null.
boolean isObjectValueRep()
getValueRepresentation()
is some form of the original value, rather than serialized value.
boolean isSerializedValueRep()
getValueRepresentation()
returns the serialized form in a byte array.
You should first try to get the deserialized (original) Object via deserializeValue()
.
boolean isUnrepresentableValue()
Object deserializeValue() throws IOException, ClassNotFoundException
isSerializedValueRep()
returns true
IOException
ClassNotFoundException
- if the class for the object being represented is not found.
UnsupportedOperationException
- when isSerializedValueRep()
returns false
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |