javax.xml.stream.events
Interface StartEntity

All Superinterfaces:
XMLEvent, XMLStreamConstants

public interface StartEntity
extends XMLEvent

An interface for the StartEntity event. 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 an 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. The StartEntity and EndEntity events are used to bracket a set of events that are the result of processing a complex entity that results in many events.

See Also:
EntityReference, 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 getName()
          Returns the name of the entity
 
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

getName

public java.lang.String getName()
Returns the name of the entity