|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OMText
Represents character data in an XML document. A node of this type is used to
represent character data that may appear in element content as well as the
prolog and epilog of a document. Note that this node type is used for normal
character data, CDATA sections and ignorable whitespace. The
OMNode.getType()
method may be used to distinguish between these
different types of character data.
By default, Axiom uses StAX parsers configured in coalescing mode. As a
consequence, CDATA sections will not result in nodes of type
OMNode.CDATA_SECTION_NODE
nodes, but of type OMNode.TEXT_NODE
(See the Javadoc of StAXUtils
for
information about how to change this behavior). In addition, the object model
instance will never contain two adjacent OMText
siblings.
The same is not necessarily true for Axiom trees that have been built or
updated programmatically or that contain nodes resulting from the expansion
of an OMSourcedElement
. Therefore, code that manipulates character
data MUST NOT assume that text nodes are always coalesced. In particular,
when extracting character data from an element, OMElement.getText()
should be used instead of getText()
.
An OMText
node stores the character data as String
,
char[]
or a DataHandler
. The latter is
used for base64 encoded binary data.
Field Summary |
---|
Fields inherited from interface org.apache.axiom.om.OMNode |
---|
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE |
Method Summary | |
---|---|
String |
getContentID()
Gets the content id. |
Object |
getDataHandler()
Gets the datahandler. |
OMNamespace |
getNamespace()
Deprecated. This API is going away. Please use getTextAsQName() instead. |
String |
getText()
Returns the text value of this node. |
QName |
getTextAsQName()
|
char[] |
getTextCharacters()
|
boolean |
isBinary()
|
boolean |
isCharacters()
|
boolean |
isOptimized()
|
void |
setBinary(boolean value)
Sets the isBinary flag. |
void |
setContentID(String cid)
Set a specific content id |
void |
setOptimize(boolean value)
Sets the optimize flag. |
Methods inherited from interface org.apache.axiom.om.OMNode |
---|
buildWithAttachments, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume |
Methods inherited from interface org.apache.axiom.om.OMSerializable |
---|
build, close, getOMFactory, isComplete, serialize, serialize, serializeAndConsume |
Method Detail |
---|
String getText()
char[] getTextCharacters()
boolean isCharacters()
QName getTextAsQName()
OMNamespace getNamespace()
Object getDataHandler()
boolean isOptimized()
void setOptimize(boolean value)
value
- true to optimize binary content (usually w/MTOM)boolean isBinary()
void setBinary(boolean value)
value
- true if the content is binaryString getContentID()
void setContentID(String cid)
cid
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |