org.apache.axiom.om
Interface OMEntityReference

All Superinterfaces:
OMInformationItem, OMNode, OMSerializable

public interface OMEntityReference
extends OMNode

Represents an unexpanded entity reference in an XML document.

Different XML APIs and object models handle entity references fairly differently:

Axiom models entity references in the same way as StAX: the node corresponding to an (unexpanded) entity reference only stores the name of the entity as well as the replacement value.


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 getName()
          Get the name of the referenced entity.
 String getReplacementText()
          Get the replacement value for this entity reference.
 
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, isComplete, serialize, serialize, serializeAndConsume
 
Methods inherited from interface org.apache.axiom.om.OMInformationItem
clone, getOMFactory
 

Method Detail

getName

String getName()
Get the name of the referenced entity.

Returns:
the name of the entity

getReplacementText

String getReplacementText()
Get the replacement value for this entity reference. Note that the replacement value is a simple string and may therefore contain unparsed markup.

Returns:
the replacement value, or null if the replacement value is not available


Copyright © 2004-2012 The Apache Software Foundation. All Rights Reserved.