Top Fields Constructors Methods
com.sun.xml.fastinfoset.stax.events

public Class StartDocumentEvent

extends EventBase
implements StartDocument
Class Inheritance
All Implemented Interfaces
javax.xml.stream.events.StartDocument, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants
Imports
javax.xml.stream.XMLStreamConstants, javax.xml.stream.events.StartDocument

Field Summary

Modifier and TypeField and Description
protected String
private boolean
protected boolean
private boolean
protected String
protected String
Inherited from com.sun.xml.fastinfoset.stax.events.EventBase:
_eventType_location

Constructor Summary

AccessConstructor and Description
public
public
public
StartDocumentEvent(String encoding, String version)

Method Summary

Modifier and TypeMethod and Description
pack-priv void
public boolean
encodingSet()

Implements javax.xml.stream.events.StartDocument.encodingSet.

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

public String

Returns:

the character encoding, defaults to "UTF-8"
getCharacterEncodingScheme
()

Implements javax.xml.stream.events.StartDocument.getCharacterEncodingScheme.

Returns the encoding style of the XML data

public String

Returns:

the system ID, defaults to ""
getSystemId
()

Overrides com.sun.xml.fastinfoset.stax.events.EventBase.getSystemId.

Implements javax.xml.stream.events.StartDocument.getSystemId.

Returns the system ID of the XML data

public String

Returns:

the version of XML, defaults to "1.0"
getVersion
()

Implements javax.xml.stream.events.StartDocument.getVersion.

Returns the version of XML of this XML stream

public boolean

Returns:

the standalone state of XML, defaults to "no"
isStandalone
()

Implements javax.xml.stream.events.StartDocument.isStandalone.

Returns if this XML is standalone

public boolean
isStartDocument()

Overrides com.sun.xml.fastinfoset.stax.events.EventBase.isStartDocument.

Implements javax.xml.stream.events.XMLEvent.isStartDocument.

A utility function to check if this event is a StartDocument.

public void
pack-priv void
setDeclaredEncoding(boolean value)

public void
setEncoding(String encoding)

public void
setStandalone(boolean standalone)

public void
public void
public boolean
standaloneSet()

Implements javax.xml.stream.events.StartDocument.standaloneSet.

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

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from com.sun.xml.fastinfoset.stax.events.EventBase:
asCharactersasEndElementasStartElementgetEventTypegetLocationgetSchemaTypeisAttributeisCharactersisEndDocumentisEndElementisEntityReferenceisNamespaceisProcessingInstructionisStartElementsetEventTypesetLocationwriteAsEncodedUnicode

Field Detail

_encodingback to summary
protected String _encoding
_encodingSetback to summary
private boolean _encodingSet
_standaloneback to summary
protected boolean _standalone
_standaloneSetback to summary
private boolean _standaloneSet
_systemIdback to summary
protected String _systemId
_versionback to summary
protected String _version

Constructor Detail

StartDocumentEventback to summary
public StartDocumentEvent()
StartDocumentEventback to summary
public StartDocumentEvent(String encoding)
StartDocumentEventback to summary
public StartDocumentEvent(String encoding, String version)
Annotations
@SuppressWarnings:this-escape

Method Detail

clearback to summary
pack-priv void clear()
encodingSetback to summary
public boolean encodingSet()

Implements javax.xml.stream.events.StartDocument.encodingSet.

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

Annotations
@Override
getCharacterEncodingSchemeback to summary
public String getCharacterEncodingScheme()

Implements javax.xml.stream.events.StartDocument.getCharacterEncodingScheme.

Returns the encoding style of the XML data

Returns:String

the character encoding, defaults to "UTF-8"

Annotations
@Override
getSystemIdback to summary
public String getSystemId()

Overrides com.sun.xml.fastinfoset.stax.events.EventBase.getSystemId.

Implements javax.xml.stream.events.StartDocument.getSystemId.

Returns the system ID of the XML data

Returns:String

the system ID, defaults to ""

Annotations
@Override
getVersionback to summary
public String getVersion()

Implements javax.xml.stream.events.StartDocument.getVersion.

Returns the version of XML of this XML stream

Returns:String

the version of XML, defaults to "1.0"

Annotations
@Override
isStandaloneback to summary
public boolean isStandalone()

Implements javax.xml.stream.events.StartDocument.isStandalone.

Returns if this XML is standalone

Returns:boolean

the standalone state of XML, defaults to "no"

Annotations
@Override
isStartDocumentback to summary
public boolean isStartDocument()

Overrides com.sun.xml.fastinfoset.stax.events.EventBase.isStartDocument.

Implements javax.xml.stream.events.XMLEvent.isStartDocument.

Doc from javax.xml.stream.events.XMLEvent.isStartDocument.

A utility function to check if this event is a StartDocument.

Annotations
@Override
resetback to summary
public void reset()
setDeclaredEncodingback to summary
pack-priv void setDeclaredEncoding(boolean value)
setEncodingback to summary
public void setEncoding(String encoding)
setStandaloneback to summary
public void setStandalone(boolean standalone)
setStandaloneback to summary
public void setStandalone(String s)
setVersionback to summary
public void setVersion(String s)
standaloneSetback to summary
public boolean standaloneSet()

Implements javax.xml.stream.events.StartDocument.standaloneSet.

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

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.