-
- All Superinterfaces:
- XMLStreamConstants
- All Known Subinterfaces:
- Attribute, Characters, Comment, DTD, EndDocument, EndElement, EntityDeclaration, EntityReference, Namespace, NotationDeclaration, ProcessingInstruction, StartDocument, StartElement
public interface XMLEvent extends XMLStreamConstants
This is the base event interface for handling markup events. Events are value objects that are used to communicate the XML 1.0 InfoSet to the Application. Events may be cached and referenced after the parse has completed.- Since:
- 1.6
- See Also:
XMLEventReader
,Characters
,ProcessingInstruction
,StartElement
,EndElement
,StartDocument
,EndDocument
,EntityReference
,EntityDeclaration
,NotationDeclaration
-
-
Field Summary
-
Fields inherited from interface javax.xml.stream.XMLStreamConstants
ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT
-
-
Method Summary
Methods Modifier and Type Method and Description Characters
asCharacters()
Returns this event as Characters, may result in a class cast exception if this event is not Characters.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.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.int
getEventType()
Returns an integer code for this event.Location
getLocation()
Return the location of this event.QName
getSchemaType()
This method is provided for implementations to provide optional type information about the associated event.boolean
isAttribute()
A utility function to check if this event is an Attribute.boolean
isCharacters()
A utility function to check if this event is Characters.boolean
isEndDocument()
A utility function to check if this event is an EndDocument.boolean
isEndElement()
A utility function to check if this event is a EndElement.boolean
isEntityReference()
A utility function to check if this event is an EntityReference.boolean
isNamespace()
A utility function to check if this event is a Namespace.boolean
isProcessingInstruction()
A utility function to check if this event is a ProcessingInstruction.boolean
isStartDocument()
A utility function to check if this event is a StartDocument.boolean
isStartElement()
A utility function to check if this event is a StartElement.void
writeAsEncodedUnicode(Writer writer)
This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.
-
-
-
Method Detail
-
getEventType
int getEventType()
Returns an integer code for this event.- See Also:
XMLStreamConstants.START_ELEMENT
,XMLStreamConstants.END_ELEMENT
,XMLStreamConstants.CHARACTERS
,XMLStreamConstants.ATTRIBUTE
,XMLStreamConstants.NAMESPACE
,XMLStreamConstants.PROCESSING_INSTRUCTION
,XMLStreamConstants.COMMENT
,XMLStreamConstants.START_DOCUMENT
,XMLStreamConstants.END_DOCUMENT
,XMLStreamConstants.DTD
-
getLocation
Location getLocation()
Return the location of this event. The Location returned from this method is non-volatile and will retain its information.- See Also:
Location
-
isStartElement
boolean isStartElement()
A utility function to check if this event is a StartElement.- See Also:
StartElement
-
isAttribute
boolean isAttribute()
A utility function to check if this event is an Attribute.- See Also:
Attribute
-
isNamespace
boolean isNamespace()
A utility function to check if this event is a Namespace.- See Also:
Namespace
-
isEndElement
boolean isEndElement()
A utility function to check if this event is a EndElement.- See Also:
EndElement
-
isEntityReference
boolean isEntityReference()
A utility function to check if this event is an EntityReference.- See Also:
EntityReference
-
isProcessingInstruction
boolean isProcessingInstruction()
A utility function to check if this event is a ProcessingInstruction.- See Also:
ProcessingInstruction
-
isCharacters
boolean isCharacters()
A utility function to check if this event is Characters.- See Also:
Characters
-
isStartDocument
boolean isStartDocument()
A utility function to check if this event is a StartDocument.- See Also:
StartDocument
-
isEndDocument
boolean isEndDocument()
A utility function to check if this event is an EndDocument.- See Also:
EndDocument
-
asStartElement
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.
-
asEndElement
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.
-
asCharacters
Characters asCharacters()
Returns this event as Characters, may result in a class cast exception if this event is not Characters.
-
getSchemaType
QName getSchemaType()
This method is provided for implementations to provide optional type information about the associated event. It is optional and will return null if no information is available.
-
writeAsEncodedUnicode
void writeAsEncodedUnicode(Writer writer) throws XMLStreamException
This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters. No indentation or whitespace should be outputted. Any user defined event type SHALL have this method called when being written to on an output stream. Built in Event types MUST implement this method, but implementations MAY choose not call these methods for optimizations reasons when writing out built in Events to an output stream. The output generated MUST be equivalent in terms of the infoset expressed.- Parameters:
writer
- The writer that will output the data- Throws:
XMLStreamException
- if there is a fatal error writing the event
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/xml/stream/events/xmlevent.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.