gnu.xml.stream

Class StartDocumentImpl

Implemented Interfaces:
StartDocument, XMLEvent, XMLStreamConstants

public class StartDocumentImpl
extends XMLEventImpl
implements StartDocument

A start-document event.

Field Summary

protected String
encoding
protected boolean
encodingDeclared
protected boolean
standaloneDeclared
protected String
systemId
protected boolean
xmlStandalone
protected String
xmlVersion

Fields inherited from class gnu.xml.stream.XMLEventImpl

location

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

Constructor Summary

StartDocumentImpl(Location location, String systemId, String encoding, String xmlVersion, boolean xmlStandalone, boolean standaloneDeclared, boolean encodingDeclared)

Method Summary

boolean
encodingSet()
Indicates whether the character encoding was set in the XML declaration.
String
getCharacterEncodingScheme()
Returns the character encoding of the document.
int
getEventType()
Returns the type of this event.
String
getSystemId()
Returns the system identifier of the document entity.
String
getVersion()
Returns the XML version of the document.
boolean
isStandalone()
Indicates whether the document is standalone.
boolean
standaloneSet()
Indicates whether the standalone parameter was set in the XML declaration.
void
writeAsEncodedUnicode(Writer writer)
Writes this event to the specified writer.

Methods inherited from class gnu.xml.stream.XMLEventImpl

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

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

encoding

protected final String encoding

encodingDeclared

protected final boolean encodingDeclared

standaloneDeclared

protected final boolean standaloneDeclared

systemId

protected final String systemId

xmlStandalone

protected final boolean xmlStandalone

xmlVersion

protected final String xmlVersion

Constructor Details

StartDocumentImpl

protected StartDocumentImpl(Location location,
                            String systemId,
                            String encoding,
                            String xmlVersion,
                            boolean xmlStandalone,
                            boolean standaloneDeclared,
                            boolean encodingDeclared)

Method Details

encodingSet

public boolean encodingSet()
Indicates whether the character encoding was set in the XML declaration.
Specified by:
encodingSet in interface StartDocument

getCharacterEncodingScheme

public String getCharacterEncodingScheme()
Returns the character encoding of the document.
Specified by:
getCharacterEncodingScheme in interface StartDocument

getEventType

public int getEventType()
Returns the type of this event.
Specified by:
getEventType in interface XMLEvent
Overrides:
getEventType in interface XMLEventImpl

getSystemId

public String getSystemId()
Returns the system identifier of the document entity.
Specified by:
getSystemId in interface StartDocument

getVersion

public String getVersion()
Returns the XML version of the document.
Specified by:
getVersion in interface StartDocument

isStandalone

public boolean isStandalone()
Indicates whether the document is standalone.
Specified by:
isStandalone in interface StartDocument

standaloneSet

public boolean standaloneSet()
Indicates whether the standalone parameter was set in the XML declaration.
Specified by:
standaloneSet in interface StartDocument

writeAsEncodedUnicode

public void writeAsEncodedUnicode(Writer writer)
            throws XMLStreamException
Writes this event to the specified writer.
Specified by:
writeAsEncodedUnicode in interface XMLEvent
Overrides:
writeAsEncodedUnicode in interface XMLEventImpl

StartDocumentImpl.java -- Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.