javax.xml.stream.events
Interface EntityReference

All Superinterfaces:

XMLEvent, XMLStreamConstants

public interface EntityReference

extends XMLEvent

An interface for handling Entity events Entities are handled in three possible ways: 1) Optionally All entity references are resolved and reported as markup transparently. 2) Entity references may be reported as single EntityReference Event 3) External and internal entity references may be wrapped with StartEntity(name)/EndEntity(name) pairs and resolved. The process of resolution may result in many events being generated that are bracketed by nested StartEntity/EndEntity pairs This event reports entities that have not been resolved and reports their replacement text unprocessed (if available)

See Also:

StartEntity, EndEntity

Field Summary

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, END_ENTITY, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT, START_ENTITY

Method Summary

java.lang.String	getBaseUri() Get the base URI for this reference or null if this information is not available
java.lang.String	getName() The name of the entity
java.lang.String	getPublicId() The public identifier associated with the entity, if specified, null otherwise.
java.lang.String	getReplacementText() The replacement text of the entity
java.lang.String	getSystemId() The system identifier associated with the entity, if specified, null otherwise.

Methods inherited from interface javax.xml.stream.events.XMLEvent

asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEndEntity, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, isStartEntity, writeAsEncodedUnicode

Method Detail

getBaseUri

public java.lang.String getBaseUri()

Get the base URI for this reference or null if this information is not available

getPublicId

public java.lang.String getPublicId()

The public identifier associated with the entity, if specified, null otherwise.

getSystemId

public java.lang.String getSystemId()

The system identifier associated with the entity, if specified, null otherwise.

getName

public java.lang.String getName()

The name of the entity

getReplacementText

public java.lang.String getReplacementText()

The replacement text of the entity