Package weblogic.xml.security.utils

Interface XMLWriter

public interface XMLWriter

Method Summary

Modifier and Type	Method	Description
void	close()	Close this writer and free any resources associated with the writer.
void	flush()	flush any cached data to the underlying output mechanism.
java.util.Map	getNamespaceMap()	returns the set of declared prefix -> namespace mappings.
void	setDefaultNamespace(java.lang.String namespaceURI)	Defines the default namespace.
void	setDefaultPrefixes(java.util.Map prefixMap)
void	setNamespaceMap(java.util.Map namespaces)	Defines the set of predeclared prefix -> namespace mappings
void	setPrefix(java.lang.String prefix, java.lang.String namespaceURI)	Defines the prefix to be used for elements in the identified namespace.
void	writeAttribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String value)	writes an attribute to the preceeding start tag, binding the namespaces if necessary.
void	writeAttribute(java.lang.String namespaceURI, java.lang.String localName, javax.xml.namespace.QName value)	writes an attribute that has a QName value to the preceeding start tag, binding the namespaces if necessary.
void	writeCharacters(java.lang.String value)	writes a CharacterData node to the document.
void	writeCharacters(javax.xml.namespace.QName value)	writes the QName as CharacterData node to the document.
void	writeEndElement()	Writes the end tag for the current Element.
void	writeStartElement(java.lang.String namespaceURI, java.lang.String localName)	writes a Start tag for an element with the provided QName, binding the namespaces if necessary.

Method Detail

writeStartElement

void writeStartElement(java.lang.String namespaceURI,
                       java.lang.String localName)
                throws XMLWriterRuntimeException

writes a Start tag for an element with the provided QName, binding the namespaces if necessary.

Parameters:

namespaceURI -

localName -

Throws:

XMLWriterRuntimeException

writeAttribute

void writeAttribute(java.lang.String namespaceURI,
                    java.lang.String localName,
                    java.lang.String value)
             throws XMLWriterRuntimeException,
                    java.lang.IllegalStateException

writes an attribute to the preceeding start tag, binding the namespaces if necessary.

Parameters:

namespaceURI -

localName -

value -

Throws:

XMLWriterRuntimeException

java.lang.IllegalStateException

writeAttribute

void writeAttribute(java.lang.String namespaceURI,
                    java.lang.String localName,
                    javax.xml.namespace.QName value)
             throws XMLWriterRuntimeException,
                    java.lang.IllegalStateException

writes an attribute that has a QName value to the preceeding start tag, binding the namespaces if necessary.

Parameters:

namespaceURI -

localName -

value -

Throws:

XMLWriterRuntimeException

java.lang.IllegalStateException

writeCharacters

void writeCharacters(java.lang.String value)
              throws XMLWriterRuntimeException

writes a CharacterData node to the document.

Parameters:

value -

Throws:

XMLWriterRuntimeException

writeCharacters

void writeCharacters(javax.xml.namespace.QName value)
              throws XMLWriterRuntimeException,
                     java.lang.IllegalStateException

writes the QName as CharacterData node to the document.

Parameters:

value -

Throws:

XMLWriterRuntimeException

java.lang.IllegalStateException - if the namespace has not been bound.

writeEndElement

void writeEndElement()
              throws XMLWriterRuntimeException

Writes the end tag for the current Element.

Throws:

XMLWriterRuntimeException

setPrefix

void setPrefix(java.lang.String prefix,
               java.lang.String namespaceURI)
        throws XMLWriterRuntimeException

Defines the prefix to be used for elements in the identified namespace.

Parameters:

namespaceURI -

prefix -

Throws:

XMLWriterRuntimeException

setDefaultNamespace

void setDefaultNamespace(java.lang.String namespaceURI)
                  throws XMLWriterRuntimeException

Defines the default namespace.

Parameters:

namespaceURI -

Throws:

XMLWriterRuntimeException

setDefaultPrefixes

void setDefaultPrefixes(java.util.Map prefixMap)

getNamespaceMap

java.util.Map getNamespaceMap()

returns the set of declared prefix -> namespace mappings.

setNamespaceMap

void setNamespaceMap(java.util.Map namespaces)

Defines the set of predeclared prefix -> namespace mappings

Parameters:

namespaces -

flush

void flush()
    throws XMLWriterRuntimeException

flush any cached data to the underlying output mechanism.

Throws:

XMLWriterRuntimeException

close

void close()
    throws XMLWriterRuntimeException

Close this writer and free any resources associated with the writer. This must not close the underlying output stream.

Throws:

XMLWriterRuntimeException