javax.xml.stream.events
Interface StartDocument

All Superinterfaces:

XMLEvent, XMLStreamConstants

public interface StartDocument

extends XMLEvent

An interface for the start document event

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

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

boolean	encodingSet() Returns true if CharacterEncodingScheme was set in the encoding declaration of the document
String	getCharacterEncodingScheme() Returns the encoding style of the XML data
String	getSystemId() Returns the system ID of the XML data
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 in the encoding declaration of the document.

Methods inherited from interface javax.xml.stream.events.XMLEvent

asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, writeAsEncodedUnicode

Method Detail

getSystemId

public String getSystemId()

Returns the system ID of the XML data

Returns:

the system ID, defaults to ""

getCharacterEncodingScheme

public 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 in the encoding declaration of the document

isStandalone

public boolean isStandalone()

Returns if this XML is standalone

Returns:

the standalone state of XML, defaults to "no"

standaloneSet

public boolean standaloneSet()

Returns true if the standalone attribute was set in the encoding declaration of the document.

getVersion

public String getVersion()

Returns the version of XML of this XML stream

Returns:

the version of XML, defaults to "1.0"