public interface OMEntityReference extends OMNode
Different XML APIs and object models handle entity references fairly differently:
expandEntityReferences. If this property is set to
true(default), then the parser will expand entity references and the resulting DOM tree simply contains the nodes resulting from this expansion. If this property is set to
false, then the parser will still expand entity references, but the resulting DOM tree will contain
EntityReferencenodes, the children of which represent the nodes resulting from this expansion. Note that since an entity declaration may contain markup, the children of an
EntityReferencenode may have a type other than
Node.TEXT_NODE. Application code not interested in entity references will generally set
truein order to avoid the additional programming logic required to process
ContentHandler. In addition to that, if a
LexicalHandleris registered, then the parser will report the start and end of the expansion using
LexicalHandler.endEntity(String). This means that the processing of entity references in SAX is similar to DOM with
false. Note that in SAX there is no corresponding configuration property. This makes sense because an application not interested in entity references can simply ignore the
LexicalHandler.endEntity(String)events or not register a
XMLInputFactory.IS_REPLACING_ENTITY_REFERENCESproperty. If this property is set to true (default), then the parser will expand entity references and report only the events resulting from that expansion. If the property is set to false, then the parser no longer expands entity references. Instead, it will report each entity reference using a single
XMLStreamReader.getText()can then be used to get the replacement value for the entity. Note that this replacement value may contain unparsed markup. One can see that the way StAX reports entity references is significantly different than DOM or SAX.
|Modifier and Type||Method and Description|
Get the name of the referenced entity.
Get the replacement value for this entity reference.
buildWithAttachments, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume
build, close, isComplete, serialize, serialize, serializeAndConsume
nullif the replacement value is not available
Copyright © The Apache Software Foundation. All Rights Reserved.