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 javax.xml.stream.XMLStreamException
Writes a simple element with full namespace

Parameters:
aName - - element QName
aList - - attribute list
aValue - - character value
Throws:
javax.xml.stream.XMLStreamException - - if a write exception occurs

writeSimpleXMLElement

void writeSimpleXMLElement(javax.xml.namespace.QName aName,
                           String aValue,
                           GOMAttribute aAttribute)
                           throws javax.xml.stream.XMLStreamException
Writes a simple element with full namespace

Parameters:
aName - - element QName
aAttribute - - attribute
aValue - - character value
Throws:
javax.xml.stream.XMLStreamException - - if a write exception occurs

writeSimpleXMLElement

void writeSimpleXMLElement(String aName,
                           String aValue,
                           GOMAttribute aAttribute)
                           throws javax.xml.stream.XMLStreamException
Writes a simple element with full namespace

Parameters:
aName - - the local name of the element
aAttribute - - attribute
aValue - - character value
Throws:
javax.xml.stream.XMLStreamException - - if a write exception occurs

writeSimpleXMLElement

void writeSimpleXMLElement(String aName,
                           List<GOMAttribute> aList,
                           String aValue)
                           throws javax.xml.stream.XMLStreamException
Writes a simple element with default namespace

Parameters:
aName - - elements name
aList - - attribute list
aValue - - character value
Throws:
javax.xml.stream.XMLStreamException - - if a write exception occurs

writeAttribute

void writeAttribute(GOMAttribute attribute)
                    throws javax.xml.stream.XMLStreamException
writes a attribute with the attribute namespace Uri

Parameters:
attribute - - the attribute
Throws:
javax.xml.stream.XMLStreamException - - if a write exception occurs

writeStartElement

void writeStartElement(String aName,
                       List<GOMAttribute> aList)
                       throws javax.xml.stream.XMLStreamException
Parameters:
aName -
aList -
Throws:
javax.xml.stream.XMLStreamException

writeStartElement

void writeStartElement(String aName,
                       GOMAttribute aAttribute)
                       throws javax.xml.stream.XMLStreamException
Parameters:
aName -
aAttribute -
Throws:
javax.xml.stream.XMLStreamException

writeStartElement

void writeStartElement(String aName)
                       throws javax.xml.stream.XMLStreamException
Parameters:
aName -
Throws:
javax.xml.stream.XMLStreamException

writeStartElement

void writeStartElement(javax.xml.namespace.QName aName,
                       List<GOMAttribute> aList)
                       throws javax.xml.stream.XMLStreamException
Parameters:
aName -
aList -
Throws:
javax.xml.stream.XMLStreamException

writeEndElement

void writeEndElement()
                     throws javax.xml.stream.XMLStreamException
Throws:
javax.xml.stream.XMLStreamException

writeContent

void writeContent(String aContent)
                  throws javax.xml.stream.XMLStreamException
Parameters:
aContent -
Throws:
javax.xml.stream.XMLStreamException

writeContentUnescaped

void writeContentUnescaped(String aContent)
                           throws javax.xml.stream.XMLStreamException
Parameters:
aContent -
Throws:
javax.xml.stream.XMLStreamException

writeDefaultNamespace

void writeDefaultNamespace(GOMNamespace aNameSpace)
                           throws javax.xml.stream.XMLStreamException
Parameters:
aNameSpace -
Throws:
javax.xml.stream.XMLStreamException

writeNamespace

void writeNamespace(GOMNamespace aNameSpace)
                    throws javax.xml.stream.XMLStreamException
Parameters:
aNameSpace -
Throws:
javax.xml.stream.XMLStreamException

writeStartDocument

void writeStartDocument(String aString,
                        String aString2)
                        throws javax.xml.stream.XMLStreamException
Parameters:
aString -
aString2 -
Throws:
javax.xml.stream.XMLStreamException

writeEndDocument

void writeEndDocument()
                      throws javax.xml.stream.XMLStreamException
Writes a end element tag according to the start element tag

Throws:
javax.xml.stream.XMLStreamException - - if no start tag has been written or the element stack points to a different element

flush

void flush()
           throws javax.xml.stream.XMLStreamException
Flush the GOMWriter

Throws:
javax.xml.stream.XMLStreamException

close

void close()
           throws javax.xml.stream.XMLStreamException
Closes the GOM Writer

Throws:
javax.xml.stream.XMLStreamException


Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.