| javax.xml.stream.events.StartDocument |
Class Overview
An interface for the start document event
Summary
| Public Methods |
|---|
|
abstract
boolean
|
encodingSet()
Returns true if CharacterEncodingScheme was set in
the encoding declaration of the document
|
|
abstract
String
|
getCharacterEncodingScheme()
Returns the encoding style of the XML data
|
|
abstract
String
|
getSystemId()
Returns the system ID of the XML data
|
|
abstract
String
|
getVersion()
Returns the version of XML of this XML stream
|
|
abstract
boolean
|
isStandalone()
Returns if this XML is standalone
|
|
abstract
boolean
|
standaloneSet()
Returns true if the standalone attribute was set in
the encoding declaration of the document.
|
|
[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.
|
|
Public Methods
public
abstract
boolean
encodingSet
()
Returns true if CharacterEncodingScheme was set in
the encoding declaration of the document
public
abstract
String
getCharacterEncodingScheme
()
Returns the encoding style of the XML data
Returns
- the character encoding, defaults to "UTF-8"
public
abstract
String
getSystemId
()
Returns the system ID of the XML data
Returns
- the system ID, defaults to ""
public
abstract
String
getVersion
()
Returns the version of XML of this XML stream
Returns
- the version of XML, defaults to "1.0"
public
abstract
boolean
isStandalone
()
Returns if this XML is standalone
Returns
- the standalone state of XML, defaults to "no"
public
abstract
boolean
standaloneSet
()
Returns true if the standalone attribute was set in
the encoding declaration of the document.