Class StartDocumentEvent

java.lang.Object

com.bea.xml.stream.events.BaseEvent

com.bea.xml.stream.events.StartDocumentEvent

All Implemented Interfaces:

StartDocument, XMLEvent, Location, XMLStreamConstants

public class StartDocumentEvent
extends BaseEvent
implements StartDocument

Field Summary

Fields

Modifier and Type	Field	Description
protected String	encodingScheme
protected String	publicId
protected boolean	standalone
protected String	systemId
protected String	version

Fields inherited from 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

Constructor Summary

Constructors

Constructor	Description
StartDocumentEvent()

Method Summary

Modifier and Type	Method	Description
void	clear()
protected void	doWriteAsEncodedUnicode(Writer writer)	Template method to be implemented by sub-classes.
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
String	getVersion()	Returns the version of XML of this XML stream
protected void	init()
boolean	isStandalone()	Returns if this XML is standalone
void	setEncoding(String encoding)
void	setStandalone(boolean standalone)
void	setStandalone(String standalone)
void	setVersion(String version)
boolean	standaloneSet()	Returns true if the standalone attribute was set in the encoding declaration of the document.

Methods inherited from class BaseEvent

asCharacters, asEndElement, asStartElement, getCharacterOffset, getColumnNumber, getEventType, getLineNumber, getLocation, getLocationURI, getPublicId, getSchemaType, getSourceName, getTypeAsString, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, recycle, setCharacterOffset, setColumnNumber, setEventType, setLineNumber, setLocationURI, toString, writeAsEncodedUnicode

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface XMLEvent

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

Field Details

systemId

protected String systemId

publicId

protected String publicId

encodingScheme

protected String encodingScheme

standalone

protected boolean standalone

version

protected String version

Constructor Details

StartDocumentEvent

public StartDocumentEvent()

Method Details

init

protected void init()

getSystemId

public String getSystemId()

Description copied from interface: javax.xml.stream.Location

Returns the system ID of the XML

Specified by:

getSystemId in interface Location

Specified by:

getSystemId in interface StartDocument

Overrides:

getSystemId in class BaseEvent

Returns:

the system ID, or null if not available

getCharacterEncodingScheme

public String getCharacterEncodingScheme()

Description copied from interface: javax.xml.stream.events.StartDocument

Returns the encoding style of the XML data

Specified by:

getCharacterEncodingScheme in interface StartDocument

Returns:

the character encoding, defaults to "UTF-8"

isStandalone

public boolean isStandalone()

Description copied from interface: javax.xml.stream.events.StartDocument

Returns if this XML is standalone

Specified by:

isStandalone in interface StartDocument

Returns:

the standalone state of XML, defaults to "no"

getVersion

public String getVersion()

Description copied from interface: javax.xml.stream.events.StartDocument

Returns the version of XML of this XML stream

Specified by:

getVersion in interface StartDocument

Returns:

the version of XML, defaults to "1.0"

setStandalone

public void setStandalone(boolean standalone)

setStandalone

public void setStandalone(String standalone)

encodingSet

public boolean encodingSet()

Description copied from interface: javax.xml.stream.events.StartDocument

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

Specified by:

encodingSet in interface StartDocument

standaloneSet

public boolean standaloneSet()

Description copied from interface: javax.xml.stream.events.StartDocument

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

Specified by:

standaloneSet in interface StartDocument

setEncoding

public void setEncoding(String encoding)

setVersion

public void setVersion(String version)

clear

public void clear()

doWriteAsEncodedUnicode

protected void doWriteAsEncodedUnicode(Writer writer)
                                throws IOException

Description copied from class: BaseEvent

Template method to be implemented by sub-classes.

Specified by:

doWriteAsEncodedUnicode in class BaseEvent

Throws:

IOException