org.apache.lucene.gdata.gom.writer
Interface GOMOutputWriter

All Known Implementing Classes:

GOMStaxWriter

public interface GOMOutputWriter

Author:

Simon Willnauer

Method Summary

void	close() Closes the GOM Writer
void	flush() Flush the GOMWriter
void	writeAttribute(GOMAttribute attribute) writes a attribute with the attribute namespace Uri
void	writeContent(String aContent)
void	writeContentUnescaped(String aContent)
void	writeDefaultNamespace(GOMNamespace aNameSpace)
void	writeEndDocument() Writes a end element tag according to the start element tag
void	writeEndElement()
void	writeNamespace(GOMNamespace aNameSpace)
void	writeSimpleXMLElement(javax.xml.namespace.QName aName, List<GOMAttribute> aList, String aValue) Writes a simple element with full namespace
void	writeSimpleXMLElement(javax.xml.namespace.QName aName, String aValue, GOMAttribute aAttribute) Writes a simple element with full namespace
void	writeSimpleXMLElement(String aName, List<GOMAttribute> aList, String aValue) Writes a simple element with default namespace
void	writeSimpleXMLElement(String aName, String aValue, GOMAttribute aAttribute) Writes a simple element with full namespace
void	writeStartDocument(String aString, String aString2)
void	writeStartElement(javax.xml.namespace.QName aName, List<GOMAttribute> aList)
void	writeStartElement(String aName)
void	writeStartElement(String aName, GOMAttribute aAttribute)
void	writeStartElement(String aName, List<GOMAttribute> aList)

Method Detail

writeSimpleXMLElement

void writeSimpleXMLElement(javax.xml.namespace.QName aName,
                           List<GOMAttribute> aList,
                           String aValue)
                           throws XMLStreamException

Writes a simple element with full namespace

Parameters:

aName - - element QName

aList - - attribute list

aValue - - character value

Throws:

XMLStreamException - - if a write exception occurs

writeSimpleXMLElement

void writeSimpleXMLElement(javax.xml.namespace.QName aName,
                           String aValue,
                           GOMAttribute aAttribute)
                           throws XMLStreamException

Writes a simple element with full namespace

Parameters:

aName - - element QName

aAttribute - - attribute

aValue - - character value

Throws:

XMLStreamException - - if a write exception occurs

writeSimpleXMLElement

void writeSimpleXMLElement(String aName,
                           String aValue,
                           GOMAttribute aAttribute)
                           throws XMLStreamException

Writes a simple element with full namespace

Parameters:

aName - - the local name of the element

aAttribute - - attribute

aValue - - character value

Throws:

XMLStreamException - - if a write exception occurs

writeSimpleXMLElement

void writeSimpleXMLElement(String aName,
                           List<GOMAttribute> aList,
                           String aValue)
                           throws XMLStreamException

Writes a simple element with default namespace

Parameters:

aName - - elements name

aList - - attribute list

aValue - - character value

Throws:

XMLStreamException - - if a write exception occurs

writeAttribute

void writeAttribute(GOMAttribute attribute)
                    throws XMLStreamException

writes a attribute with the attribute namespace Uri

Parameters:

attribute - - the attribute

Throws:

XMLStreamException - - if a write exception occurs

writeStartElement

void writeStartElement(String aName,
                       List<GOMAttribute> aList)
                       throws XMLStreamException

Parameters:

aName -

aList -

Throws:

XMLStreamException

writeStartElement

void writeStartElement(String aName,
                       GOMAttribute aAttribute)
                       throws XMLStreamException

Parameters:

aName -

aAttribute -

Throws:

XMLStreamException

writeStartElement

void writeStartElement(String aName)
                       throws XMLStreamException

Parameters:

aName -

Throws:

XMLStreamException

writeStartElement

void writeStartElement(javax.xml.namespace.QName aName,
                       List<GOMAttribute> aList)
                       throws XMLStreamException

Parameters:

aName -

aList -

Throws:

XMLStreamException

writeEndElement

void writeEndElement()
                     throws XMLStreamException

Throws:

XMLStreamException

writeContent

void writeContent(String aContent)
                  throws XMLStreamException

Parameters:

aContent -

Throws:

XMLStreamException

writeContentUnescaped

void writeContentUnescaped(String aContent)
                           throws XMLStreamException

Parameters:

aContent -

Throws:

XMLStreamException

writeDefaultNamespace

void writeDefaultNamespace(GOMNamespace aNameSpace)
                           throws XMLStreamException

Parameters:

aNameSpace -

Throws:

XMLStreamException

writeNamespace

void writeNamespace(GOMNamespace aNameSpace)
                    throws XMLStreamException

Parameters:

aNameSpace -

Throws:

XMLStreamException

writeStartDocument

void writeStartDocument(String aString,
                        String aString2)
                        throws XMLStreamException

Parameters:

aString -

aString2 -

Throws:

XMLStreamException

writeEndDocument

void writeEndDocument()
                      throws XMLStreamException

Writes a end element tag according to the start element tag

Throws:

XMLStreamException - - if no start tag has been written or the element stack points to a different element

flush

void flush()
           throws XMLStreamException

Flush the GOMWriter

Throws:

XMLStreamException

close

void close()
           throws XMLStreamException

Closes the GOM Writer

Throws:

XMLStreamException