Interface StartDocument

All Superinterfaces:: XMLEvent, XMLStreamConstants

public interface StartDocument extends XMLEvent

An interface for the start document event

Since:: 1.6

Field Summary

Fields declared in interface 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

Modifier and Type	Method	Description
`boolean`	`encodingSet()`	Returns true if CharacterEncodingScheme is 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 is set in the encoding declaration of the document.

Methods declared in interface XMLEvent

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

Method Details

getSystemId

String getSystemId()

Returns the system ID of the XML data

Returns:: the system ID, defaults to ""

getCharacterEncodingScheme

String getCharacterEncodingScheme()

Returns the encoding style of the XML data

Returns:: the character encoding, defaults to "UTF-8"

encodingSet

boolean encodingSet()

Returns true if CharacterEncodingScheme is set in the encoding declaration of the document

Returns:: true if CharacterEncodingScheme is set, false otherwise

isStandalone

boolean isStandalone()

Returns if this XML is standalone

Returns:: the standalone state of XML, defaults to "no"

standaloneSet

boolean standaloneSet()

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

Returns:: true if the standalone attribute is set, false otherwise

getVersion

String getVersion()

Returns the version of XML of this XML stream

Returns:: the version of XML, defaults to "1.0"

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.xml/javax/xml/stream/events/StartDocument.html