javax.xml.stream.events
Interface StartDocument

All Superinterfaces:

XMLEvent, XMLStreamConstants

public interface StartDocument

extends XMLEvent

An interface for the start document event

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

boolean	encodingSet() Returns true if CharacterEncodingScheme was set
java.lang.String	getCharacterEncodingScheme() Returns the encoding style of the XML data
java.lang.String	getSystemId() Returns the system id of the XML data
java.lang.String	getVersion() Returns the version of XML of this XML stream
boolean	isStandalone() Returns if this XML is standalone
boolean	standaloneSet() Returns true if the standalone attribute was set

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

getSystemId

public java.lang.String getSystemId()

Returns the system id of the XML data

Returns:

the system id, defaults to ""

getCharacterEncodingScheme

public java.lang.String getCharacterEncodingScheme()

Returns the encoding style of the XML data

Returns:

the character encoding, defaults to "UTF-8"

encodingSet

public boolean encodingSet()

Returns true if CharacterEncodingScheme was set

isStandalone

public boolean isStandalone()

Returns if this XML is standalone

Returns:

the version of XML, defaults to "yes"

standaloneSet

public boolean standaloneSet()

Returns true if the standalone attribute was set

getVersion

public java.lang.String getVersion()

Returns the version of XML of this XML stream

Returns:

the version of XML, defaults to "1.0"