|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.vinci.transport.FrameComponent
org.apache.vinci.transport.FrameLeaf
public class FrameLeaf
Class encapsulating leaf data from a Frame. Internally, leaf data is always represented as UTF-8. Most people will never have to use this class directly unless implementing specialized Frame document types. While FrameLeaf is effectively an immutable class, any descendents that implement setAttributes of the base class FrameComponent are not likely to be immutable.
Field Summary | |
---|---|
static java.lang.String |
NOT_UTF8_ERROR
If you call toString() on a FrameLeaf which contains binary data, you get this string as the result. |
Constructor Summary | |
---|---|
FrameLeaf(boolean bool)
|
|
FrameLeaf(byte[] mydata,
boolean encode)
Create a frameleaf from existing UTF-8 (or true binary) data. |
|
FrameLeaf(double myfloat)
|
|
FrameLeaf(double[] mydouble)
|
|
FrameLeaf(float myfloat_)
|
|
FrameLeaf(float[] myfloat)
|
|
FrameLeaf(int myint_)
|
|
FrameLeaf(int[] myint)
|
|
FrameLeaf(long myint)
|
|
FrameLeaf(long[] mylong)
|
|
FrameLeaf(java.lang.String mydata)
|
|
FrameLeaf(java.lang.String[] mystring)
This method does NOT support null values in the array. |
Method Summary | |
---|---|
byte[] |
getData()
Get the raw (usually UTF-8) frame data. |
boolean |
toBoolean()
Converts the UTF-8 data to a Java boolean. |
byte[] |
toBytes()
Converts the B64 encoded data to binary and returns it. |
double |
toDouble()
Converts the UTF-8 data to a Java double type. |
double[] |
toDoubleArray()
Converts the UTF-8 data to a Java array of double. |
float |
toFloat()
Converts the UTF-8 data to a Java float type. |
float[] |
toFloatArray()
Converts the UTF-8 data to a Java array of float. |
int |
toInt()
Converts the UTF-8 data to a Java int type. |
int[] |
toIntArray()
Converts the UTF-8 data to a Java array of ints. |
long |
toLong()
Converts the UTF-8 data to a Java long type. |
long[] |
toLongArray()
Converts the UTF-8 data to a Java array of longs. |
java.lang.String |
toString()
|
java.lang.String[] |
toStringArray()
|
Methods inherited from class org.apache.vinci.transport.FrameComponent |
---|
getAttributes, setAttributes |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String NOT_UTF8_ERROR
Constructor Detail |
---|
public FrameLeaf(byte[] mydata, boolean encode)
public FrameLeaf(java.lang.String mydata)
public FrameLeaf(java.lang.String[] mystring)
public FrameLeaf(float myfloat_)
public FrameLeaf(float[] myfloat)
public FrameLeaf(double myfloat)
public FrameLeaf(double[] mydouble)
public FrameLeaf(int myint_)
public FrameLeaf(int[] myint)
public FrameLeaf(long myint)
public FrameLeaf(long[] mylong)
public FrameLeaf(boolean bool)
Method Detail |
---|
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String[] toStringArray()
public byte[] getData()
public byte[] toBytes()
LeafCastException
- if the data was not base64 encoded.public long toLong()
LeafCastException
- if the data could not be converted to long.public long[] toLongArray()
LeafCastException
- if the data could not be convered to a long array.public int toInt()
LeafCastException
- if the data could not be converted to int.public int[] toIntArray()
LeafCastException
- if the data could not be convered to an int array.public float toFloat()
LeafCastException
- if the data could not be converted to float.public float[] toFloatArray()
LeafCastException
- if the data could not be convered to a float array.public double toDouble()
LeafCastException
- if the data could not be converted to double.public double[] toDoubleArray()
LeafCastException
- if the data could not be convered to a double array.public boolean toBoolean()
LeafCastException
- if the underlying data was not utf-8 (which in general should not happen).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |