|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xmlBlaster.util.EncodableData
public class EncodableData
This class encapsulates one client property in a QoS.
Examples:<clientProperty name='transactionId' type='int'>120001</clientProperty> <clientProperty name='myKey'>Hello World</clientProperty> <clientProperty name='myBlob' type='byte[]' encoding='base64'>OKFKAL==</clientProperty> <clientProperty name='myText' type='String' encoding='base64' charset='cp1252'>Hello</clientProperty>If the attribute
type
is missing we assume a 'String' property
The encoding charset must be "UTF-8", it can be locally overwritten for base64 encoded strings
Field Summary | |
---|---|
private java.lang.String |
charset
Mark the charset for a base64 encoded String |
private java.lang.String |
encoding
|
private boolean |
forceCdata
|
static boolean |
isChunked
Needed for Base64 encoding |
protected java.lang.String |
ME
|
private java.lang.String |
name
|
private static long |
serialVersionUID
|
private long |
size
|
protected java.lang.String |
tagName
|
private java.lang.String |
type
|
private java.lang.String |
value
The value encoded as specified with encoding |
Constructor Summary | |
---|---|
EncodableData(java.lang.String tagName,
java.lang.String name,
byte[] value)
Set binary data, will be of type "byte[]" and base64 encoded |
|
EncodableData(java.lang.String tagName,
java.lang.String name,
java.lang.String type,
java.lang.String encoding)
|
|
EncodableData(java.lang.String tagName,
java.lang.String name,
java.lang.String type,
java.lang.String encoding,
java.lang.String value)
|
Method Summary | |
---|---|
static java.lang.Object |
convertPropertyObject(java.lang.String type,
java.lang.String val)
Helper to convert 'val' to the given object of type 'type'. |
void |
forceCdata(boolean forceCdata)
|
byte[] |
getBlobValue()
|
boolean |
getBooleanValue()
|
byte |
getByteValue()
|
java.lang.String |
getCharset()
|
double |
getDoubleValue()
|
java.lang.String |
getEncoding()
|
float |
getFloatValue()
|
int |
getIntValue()
|
long |
getLongValue()
|
java.lang.String |
getName()
|
java.lang.Object |
getObjectValue()
Depending on the type we return a Float, Long, Integer, ... |
static java.lang.String |
getPropertyType(java.lang.Object val)
Helper which returns the type of the object as a string |
short |
getShortValue()
|
long |
getSize()
The real, raw content size (not the base64 size) |
java.lang.String |
getStringValue()
The string representation of the value. |
java.lang.String |
getStringValue(java.lang.String defaultValue)
|
java.lang.String |
getType()
|
private java.lang.String |
getValidatedValueForXml()
|
java.lang.String |
getValueRaw()
The raw still encoded value |
boolean |
isBase64()
|
boolean |
isStringType()
|
static void |
main(java.lang.String[] args)
|
void |
setCharset(java.lang.String charset)
|
void |
setSize(long size)
The real, raw content size (not the base64 size) |
void |
setValue(byte[] value)
Set binary data, will be of type "byte[]" and base64 encoded |
void |
setValue(java.lang.String value)
Set the value, it will be encoded with the encoding specified in the constructor. |
void |
setValue(java.lang.String value,
java.lang.String encoding)
Set the real value which will be encoded as specified. |
void |
setValueRaw(java.lang.String value)
Set the already correctly encoded value |
java.lang.String |
toXml()
Dump state of this object into a XML ASCII string. |
java.lang.String |
toXml(java.lang.String offset)
Dump state of this object into a XML ASCII string. |
java.lang.String |
toXml(java.lang.String extraOffset,
java.lang.String tmpTagName)
Dump state of this object into a XML ASCII string. |
java.lang.String |
toXml(java.lang.String extraOffset,
java.lang.String tmpTagName,
boolean forceReadable)
You may set forceReadable==true to have nicer human readable output. |
java.lang.String |
toXml(java.lang.String extraOffset,
java.lang.String tmpTagName,
boolean forceReadable,
boolean inhibitContentCDATAWrapper)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final long serialVersionUID
protected java.lang.String ME
private final java.lang.String name
private java.lang.String type
private java.lang.String value
private java.lang.String encoding
private java.lang.String charset
public static final boolean isChunked
protected java.lang.String tagName
private long size
private boolean forceCdata
Constructor Detail |
---|
public EncodableData(java.lang.String tagName, java.lang.String name, java.lang.String type, java.lang.String encoding)
name
- The unique property keytype
- The data type of the value, Constants.TYPE_INT etc.encoding
- Constants.ENCODING_NONE=null or Constants.ENCODING_BASE64="base64"public EncodableData(java.lang.String tagName, java.lang.String name, java.lang.String type, java.lang.String encoding, java.lang.String value)
name
- The unique property keytype
- The data type of the value, Constants.TYPE_INT etc.encoding
- Constants.ENCODING_NONE=null or Constants.ENCODING_BASE64="base64"public EncodableData(java.lang.String tagName, java.lang.String name, byte[] value)
name
- The unique property keyvalue
- The binary data (will instantly be base64 encoded)Method Detail |
---|
public java.lang.String getName()
public java.lang.String getType()
public boolean isStringType()
public long getSize()
public void forceCdata(boolean forceCdata)
public void setSize(long size)
size
- If set >= 0 force to dump the size attributepublic boolean isBase64()
public java.lang.String getValueRaw()
public java.lang.String getStringValue()
public java.lang.String getStringValue(java.lang.String defaultValue)
public byte[] getBlobValue()
public int getIntValue()
java.lang.NumberFormatException
public boolean getBooleanValue()
public double getDoubleValue()
java.lang.NumberFormatException
public float getFloatValue()
java.lang.NumberFormatException
public byte getByteValue()
public long getLongValue()
java.lang.NumberFormatException
public short getShortValue()
java.lang.NumberFormatException
public java.lang.Object getObjectValue()
public java.lang.String getEncoding()
public java.lang.String getCharset()
public void setCharset(java.lang.String charset)
charset
- The charset to set.public void setValue(java.lang.String value)
public void setValue(byte[] value)
public void setValueRaw(java.lang.String value)
public void setValue(java.lang.String value, java.lang.String encoding)
value
- The not encoded valueencoding
- null or Constants.ENCODING_BASE64="base64"private java.lang.String getValidatedValueForXml()
public static final java.lang.String getPropertyType(java.lang.Object val)
val
-
public static final java.lang.Object convertPropertyObject(java.lang.String type, java.lang.String val)
type
- the type of the objectval
- the object itself
public final java.lang.String toXml()
public final java.lang.String toXml(java.lang.String offset)
public final java.lang.String toXml(java.lang.String extraOffset, java.lang.String tmpTagName)
extraOffset
- indenting of tags for nice outputtmpTagName
- the tag name to be used for this output. If you
specify 'null' the default will be used, i.e. what has been passed in the constructor.
public final java.lang.String toXml(java.lang.String extraOffset, java.lang.String tmpTagName, boolean forceReadable)
extraOffset
- The indenting prefixtmpTagName
- If null the default is chosenforceReadable
- If true the base64 is decoded to a 'readable' string
public final java.lang.String toXml(java.lang.String extraOffset, java.lang.String tmpTagName, boolean forceReadable, boolean inhibitContentCDATAWrapper)
public static void main(java.lang.String[] args)
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |