gnu.xml.stream

Class XMLStreamWriterImpl

Implemented Interfaces:
XMLStreamWriter

public class XMLStreamWriterImpl
extends Object
implements XMLStreamWriter

Simple XML stream writer.

Field Summary

protected String
encoding
The encoding being used.
protected NamespaceContext
namespaceContext
The namespace context used to determine the namespace-prefix mappings in scope.
protected boolean
prefixDefaulting
Whether prefix defaulting is being used.
protected Writer
writer
The underlying character stream to write to.

Constructor Summary

XMLStreamWriterImpl(Writer writer, String encoding, boolean prefixDefaulting)
Constructor.

Method Summary

void
close()
protected String
createPrefix(String namespaceURI)
Creates a new unique prefix in the document.
void
flush()
NamespaceContext
getNamespaceContext()
String
getPrefix(String uri)
Object
getProperty(String name)
void
setDefaultNamespace(String uri)
void
setNamespaceContext(NamespaceContext context)
void
setPrefix(String prefix, String uri)
void
writeAttribute(String localName, String value)
void
writeAttribute(String namespaceURI, String localName, String value)
void
writeAttribute(String prefix, String namespaceURI, String localName, String value)
void
writeCData(String data)
void
writeCharacters(char[] text, int start, int len)
void
writeCharacters(String text)
void
writeComment(String data)
void
writeDTD(String dtd)
void
writeDefaultNamespace(String namespaceURI)
void
writeEmptyElement(String localName)
void
writeEmptyElement(String namespaceURI, String localName)
void
writeEmptyElement(String prefix, String localName, String namespaceURI)
void
writeEndDocument()
void
writeEndElement()
void
writeEntityRef(String name)
void
writeNamespace(String prefix, String namespaceURI)
void
writeProcessingInstruction(String target)
void
writeProcessingInstruction(String target, String data)
void
writeStartDocument()
void
writeStartDocument(String version)
void
writeStartDocument(String encoding, String version)
void
writeStartElement(String localName)
void
writeStartElement(String namespaceURI, String localName)
void
writeStartElement(String prefix, String localName, String namespaceURI)

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
The encoding being used. Note that this must match the encoding of the character stream.

namespaceContext

protected NamespaceContext namespaceContext
The namespace context used to determine the namespace-prefix mappings in scope.

prefixDefaulting

protected final boolean prefixDefaulting
Whether prefix defaulting is being used. If true and a prefix has not been defined for a namespace specified on an element or an attribute, a new prefix and namespace declaration will be created.

writer

protected final Writer writer
The underlying character stream to write to.

Constructor Details

XMLStreamWriterImpl

protected XMLStreamWriterImpl(Writer writer,
                              String encoding,
                              boolean prefixDefaulting)
Constructor.

Method Details

close

public void close()
            throws XMLStreamException
Specified by:
close in interface XMLStreamWriter

createPrefix

protected String createPrefix(String namespaceURI)
Creates a new unique prefix in the document. Subclasses may override this method to provide a suitably unique prefix for the given namespace.
Parameters:
namespaceURI - the namespace URI

flush

public void flush()
            throws XMLStreamException
Specified by:
flush in interface XMLStreamWriter

getNamespaceContext

public NamespaceContext getNamespaceContext()
Specified by:
getNamespaceContext in interface XMLStreamWriter

getPrefix

public String getPrefix(String uri)
            throws XMLStreamException
Specified by:
getPrefix in interface XMLStreamWriter

getProperty

public Object getProperty(String name)
            throws IllegalArgumentException
Specified by:
getProperty in interface XMLStreamWriter

setDefaultNamespace

public void setDefaultNamespace(String uri)
            throws XMLStreamException
Specified by:
setDefaultNamespace in interface XMLStreamWriter

setNamespaceContext

public void setNamespaceContext(NamespaceContext context)
            throws XMLStreamException
Specified by:
setNamespaceContext in interface XMLStreamWriter

setPrefix

public void setPrefix(String prefix,
                      String uri)
            throws XMLStreamException
Specified by:
setPrefix in interface XMLStreamWriter

writeAttribute

public void writeAttribute(String localName,
                           String value)
            throws XMLStreamException
Specified by:
writeAttribute in interface XMLStreamWriter

writeAttribute

public void writeAttribute(String namespaceURI,
                           String localName,
                           String value)
            throws XMLStreamException
Specified by:
writeAttribute in interface XMLStreamWriter

writeAttribute

public void writeAttribute(String prefix,
                           String namespaceURI,
                           String localName,
                           String value)
            throws XMLStreamException
Specified by:
writeAttribute in interface XMLStreamWriter

writeCData

public void writeCData(String data)
            throws XMLStreamException
Specified by:
writeCData in interface XMLStreamWriter

writeCharacters

public void writeCharacters(char[] text,
                            int start,
                            int len)
            throws XMLStreamException
Specified by:
writeCharacters in interface XMLStreamWriter

writeCharacters

public void writeCharacters(String text)
            throws XMLStreamException
Specified by:
writeCharacters in interface XMLStreamWriter

writeComment

public void writeComment(String data)
            throws XMLStreamException
Specified by:
writeComment in interface XMLStreamWriter

writeDTD

public void writeDTD(String dtd)
            throws XMLStreamException
Specified by:
writeDTD in interface XMLStreamWriter

writeDefaultNamespace

public void writeDefaultNamespace(String namespaceURI)
            throws XMLStreamException
Specified by:
writeDefaultNamespace in interface XMLStreamWriter

writeEmptyElement

public void writeEmptyElement(String localName)
            throws XMLStreamException
Specified by:
writeEmptyElement in interface XMLStreamWriter

writeEmptyElement

public void writeEmptyElement(String namespaceURI,
                              String localName)
            throws XMLStreamException
Specified by:
writeEmptyElement in interface XMLStreamWriter

writeEmptyElement

public void writeEmptyElement(String prefix,
                              String localName,
                              String namespaceURI)
            throws XMLStreamException
Specified by:
writeEmptyElement in interface XMLStreamWriter

writeEndDocument

public void writeEndDocument()
            throws XMLStreamException
Specified by:
writeEndDocument in interface XMLStreamWriter

writeEndElement

public void writeEndElement()
            throws XMLStreamException
Specified by:
writeEndElement in interface XMLStreamWriter

writeEntityRef

public void writeEntityRef(String name)
            throws XMLStreamException
Specified by:
writeEntityRef in interface XMLStreamWriter

writeNamespace

public void writeNamespace(String prefix,
                           String namespaceURI)
            throws XMLStreamException
Specified by:
writeNamespace in interface XMLStreamWriter

writeProcessingInstruction

public void writeProcessingInstruction(String target)
            throws XMLStreamException
Specified by:
writeProcessingInstruction in interface XMLStreamWriter

writeProcessingInstruction

public void writeProcessingInstruction(String target,
                                       String data)
            throws XMLStreamException
Specified by:
writeProcessingInstruction in interface XMLStreamWriter

writeStartDocument

public void writeStartDocument()
            throws XMLStreamException
Specified by:
writeStartDocument in interface XMLStreamWriter

writeStartDocument

public void writeStartDocument(String version)
            throws XMLStreamException
Specified by:
writeStartDocument in interface XMLStreamWriter

writeStartDocument

public void writeStartDocument(String encoding,
                               String version)
            throws XMLStreamException
Specified by:
writeStartDocument in interface XMLStreamWriter

writeStartElement

public void writeStartElement(String localName)
            throws XMLStreamException
Specified by:
writeStartElement in interface XMLStreamWriter

writeStartElement

public void writeStartElement(String namespaceURI,
                              String localName)
            throws XMLStreamException
Specified by:
writeStartElement in interface XMLStreamWriter

writeStartElement

public void writeStartElement(String prefix,
                              String localName,
                              String namespaceURI)
            throws XMLStreamException
Specified by:
writeStartElement in interface XMLStreamWriter

XMLStreamWriterImpl.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.