public interface PofValue
PofValueParser.parse(ReadBuffer, PofContext)
Modifier and Type | Method and Description |
---|---|
Binary |
applyChanges()
Apply all the changes that were made to this value and return a binary
representation of the new value.
|
BigDecimal |
getBigDecimal()
Return the BigDecimal which this PofValue represents.
|
BigInteger |
getBigInteger()
Return the BigInteger which this PofValue represents.
|
boolean |
getBoolean()
Return the boolean which this PofValue represents.
|
boolean[] |
getBooleanArray()
Return the boolean[] which this PofValue represents.
|
byte |
getByte()
Return the byte which this PofValue represents.
|
byte[] |
getByteArray()
Return the byte[] which this PofValue represents.
|
ReadBuffer |
getChanges()
Return a buffer containing changes made to this PofValue in the format
defined by the
BinaryDeltaCompressor . |
char |
getChar()
Return the char which this PofValue represents.
|
char[] |
getCharArray()
Return the char[] which this PofValue represents.
|
PofValue |
getChild(int nIndex)
Locate a child PofValue contained within this PofValue.
|
Collection |
getCollection(Collection coll)
Return the Collection which this PofValue represents.
|
Date |
getDate()
Return the Date which this PofValue represents.
|
double |
getDouble()
Return the double which this PofValue represents.
|
double[] |
getDoubleArray()
Return the double[] which this PofValue represents.
|
float |
getFloat()
Return the float which this PofValue represents.
|
float[] |
getFloatArray()
Return the float[] which this PofValue represents.
|
int |
getInt()
Return the int which this PofValue represents.
|
int[] |
getIntArray()
Return the int[] which this PofValue represents.
|
long |
getLong()
Return the long which this PofValue represents.
|
long[] |
getLongArray()
Return the long[] which this PofValue represents.
|
Map |
getMap(Map map)
Return the Map which this PofValue represents.
|
Object[] |
getObjectArray()
Return the Object[] which this PofValue represents.
|
PofValue |
getParent()
Return the parent of this value.
|
PofValue |
getRoot()
Return the root of the hierarchy this value belongs to.
|
short |
getShort()
Return the short which this PofValue represents.
|
short[] |
getShortArray()
Return the short[] which this PofValue represents.
|
String |
getString()
Return the String which this PofValue represents.
|
int |
getTypeId()
Obtain the POF type identifier for this value.
|
Object |
getValue()
Return the deserialized value which this PofValue represents.
|
Object |
getValue(Class clz)
Return the deserialized value which this PofValue represents.
|
Object |
getValue(int nType)
Return the deserialized value which this PofValue represents.
|
void |
setValue(Object oValue)
Update this PofValue.
|
int getTypeId()
PofValue getRoot()
PofValue getParent()
PofValue getChild(int nIndex)
Note: the returned PofValue could represent a non-existent (null) value.
nIndex
- index of the child valuePofNavigationException
- if this value is a "terminal" or the child
value cannot be located for any other reasonObject getValue()
Note: For primitive types such as int or boolean, the POF type
is not stored in the POF stream. Therefore, for primitive types, the
type or class must be explicitly specified via getValue(int)
or getValue(Class)
.
Object getValue(Class clz)
Note: For primitive types such as int or boolean, the POF type is not stored in the POF stream. Therefore, for primitive types, the clz parameter must not be null.
clz
- the required class of the returned value or null if the class
is to be inferred from the serialized stateClassCastException
- if the value is incompatible with the
specified classObject getValue(int nType)
Note: For primitive types such as int or boolean, the POF type is not stored in the POF stream. Therefore, for primitive types, the type must be explicitly specified with the nType parameter.
nType
- the required POF type of the returned value or
PofConstants.T_UNKNOWN
if the type is to be
inferred from the serialized stateClassCastException
- if the value is incompatible with the
specified typevoid setValue(Object oValue)
The changes made using this method will be immediately reflected in the
result of getValue()
method, but will not be applied to the
underlying POF stream until the applyChanges()
method is invoked
on the root PofValue.
oValue
- new deserialized value for this PofValueBinary applyChanges()
Any format prefixes and/or decorations that were present in the original buffer this value orginated from will be preserved.
Note: this method can only be called on the root PofValue.
UnsupportedOperationException
- if called on a non-root PofValueReadBuffer getChanges()
BinaryDeltaCompressor
.
Note: this method can only be called on the root PofValue
UnsupportedOperationException
- if called on a non-root PofValueboolean getBoolean()
byte getByte()
char getChar()
short getShort()
int getInt()
long getLong()
float getFloat()
double getDouble()
boolean[] getBooleanArray()
byte[] getByteArray()
char[] getCharArray()
short[] getShortArray()
int[] getIntArray()
long[] getLongArray()
float[] getFloatArray()
double[] getDoubleArray()
BigInteger getBigInteger()
BigDecimal getBigDecimal()
String getString()
Date getDate()
Object[] getObjectArray()
Collection getCollection(Collection coll)
coll
- the optional Collection to use to store the values