|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.candle.roma.kxm.KxmMsgCreateOptions
Represents the message creation options. This object is used to
provide options to
the KxmMessage.KxmMessage(String format, KxmMsgCreateOptions options)
and
the KxmMessage.KxmMessage(byte[] data, String format, KxmMsgCreateOptions options)
methods.
KxmMessage
,
KxmEncoding
Field Summary | |
static int |
ANY
Message creation option. See setOptions(int options) |
static int |
DISABLE_NAMESPACES
Message creation option. See setOptions(int options) |
static int |
FORMAT_NAME
Message creation option. See setOptions(int options) |
static int |
HANDLE_NAMESPACES
Message creation option. See setOptions(int options) |
static int |
HEX_XML_FORMAT
Message creation option. See setOptions(int options) |
static int |
MDR
Message creation option. See setOptions(int options) |
static int |
OLD_TEXT_FORMAT
Message creation option. See setOptions(int options) |
static int |
PRESERVE_XML_SPACES
Message creation option. See setOptions(int options) |
static int |
SCALAR_AS_ARRAY
Message creation option. See setOptions(int options) |
static int |
STANDALONE
Message creation option. See setOptions(int options) |
Constructor Summary | |
KxmMsgCreateOptions()
Creates the object with no options set. |
|
KxmMsgCreateOptions(int options)
Creates the object and sets the specified options. |
Method Summary | |
java.lang.Object |
clone()
Returns a clone of the object. |
KxmEncoding |
getEncoding()
Returns the encoding that will be used for message data parsing. |
long |
getHandle()
|
java.lang.String |
getNsUri()
Returns the XML namespace URI that will be associated with the root element of the created message. |
int |
getOptions()
Returns the message creation options. |
void |
setEncoding(KxmEncoding encoding)
Sets the encoding that will be used for message data parsing. |
void |
setNsUri(java.lang.String uri)
Sets the XML namespace URI that will be associated with the root element of the created message. |
void |
setOptions(int options)
Sets the message creation options. |
java.lang.String |
toString()
Returns a string representation of the object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int STANDALONE
setOptions(int options)
public static final int MDR
setOptions(int options)
public static final int ANY
setOptions(int options)
public static final int FORMAT_NAME
setOptions(int options)
public static final int HANDLE_NAMESPACES
setOptions(int options)
public static final int OLD_TEXT_FORMAT
setOptions(int options)
public static final int PRESERVE_XML_SPACES
setOptions(int options)
public static final int DISABLE_NAMESPACES
setOptions(int options)
public static final int HEX_XML_FORMAT
setOptions(int options)
public static final int SCALAR_AS_ARRAY
setOptions(int options)
Constructor Detail |
public KxmMsgCreateOptions()
public KxmMsgCreateOptions(int options)
options
- Message creation options.Method Detail |
public int getOptions()
public void setOptions(int options)
options
- Message creation options.KxmMsgCreateOptions.MDR
KxmMsgCreateOptions.STANDALONE
KxmMsgCreateOptions.ANY
KxmMsgCreateOptions.FORMAT_NAME
KxmMsgCreateOptions.PRESERVE_XML_SPACES
KxmMsgCreateOptions.HANDLE_NAMESPACES
KxmField.declareNs(String fieldName, String prefix, String uri)
method or be able to get XML namespace information from message
fields.
KxmMsgCreateOptions.OLD_TEXT_FORMAT
KxmMsgCreateOptions.DISABLE_NAMESPACES
KxmMsgCreateOptions.HEX_XML_FORMAT
KxmMsgCreateOptions.SCALAR_AS_ARRAY
public KxmEncoding getEncoding()
public void setEncoding(KxmEncoding encoding)
encoding
- Message data encoding.public java.lang.String getNsUri()
public void setNsUri(java.lang.String uri)
uri
- XML namespace URI.public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
public long getHandle()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |