EntityReference

Class Overview

An interface for handling Entity events. This event reports entities that have not been resolved and reports their replacement text unprocessed (if available). This event will be reported if javax.xml.stream.isReplacingEntityReferences is set to false. If javax.xml.stream.isReplacingEntityReferences is set to true entity references will be resolved transparently. Entities are handled in two possible ways: (1) If javax.xml.stream.isReplacingEntityReferences is set to true all entity references are resolved and reported as markup transparently. (2) If javax.xml.stream.isReplacingEntityReferences is set to false Entity references are reported as an EntityReference Event.

Summary

[Expand] Inherited Constants

From interface javax.xml.stream.XMLStreamConstants int ATTRIBUTE Indicates an event is an attribute int CDATA Indicates an event is a CDATA section int CHARACTERS Indicates an event is characters int COMMENT Indicates an event is a comment int DTD Indicates an event is a DTD int END_DOCUMENT Indicates an event is an end document int END_ELEMENT Indicates an event is an end element int ENTITY_DECLARATION Indicates a Entity Declaration int ENTITY_REFERENCE Indicates an event is an entity reference int NAMESPACE Indicates the event is a namespace declaration int NOTATION_DECLARATION Indicates a Notation int PROCESSING_INSTRUCTION Indicates an event is a processing instruction int SPACE The characters are white space (see [XML], 2.10 "White Space Handling"). int START_DOCUMENT Indicates an event is a start document int START_ELEMENT Indicates an event is a start element

[Expand] Inherited Methods

From interface javax.xml.stream.events.XMLEvent abstract Characters asCharacters() Returns this event as Characters, may result in a class cast exception if this event is not Characters. abstract EndElement asEndElement() Returns this event as an end element event, may result in a class cast exception if this event is not a end element. abstract StartElement asStartElement() Returns this event as a start element event, may result in a class cast exception if this event is not a start element. abstract int getEventType() Returns an integer code for this event. abstract Location getLocation() Return the location of this event. abstract QName getSchemaType() This method is provided for implementations to provide optional type information about the associated event. abstract boolean isAttribute() A utility function to check if this event is an Attribute. abstract boolean isCharacters() A utility function to check if this event is Characters. abstract boolean isEndDocument() A utility function to check if this event is an EndDocument. abstract boolean isEndElement() A utility function to check if this event is a EndElement. abstract boolean isEntityReference() A utility function to check if this event is an EntityReference. abstract boolean isNamespace() A utility function to check if this event is a Namespace. abstract boolean isProcessingInstruction() A utility function to check if this event is a ProcessingInstruction. abstract boolean isStartDocument() A utility function to check if this event is a StartDocument. abstract boolean isStartElement() A utility function to check if this event is a StartElement. abstract void writeAsEncodedUnicode(Writer writer) This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.