Class AbstractXMLStreamWriter<T>
java.lang.Object
org.apache.synapse.commons.staxon.core.base.AbstractXMLStreamWriter<T>
- All Implemented Interfaces:
XMLStreamWriter
- Direct Known Subclasses:
JsonXMLStreamWriter
Abstract XML stream writer.
-
Constructor Summary
ConstructorsConstructorDescriptionAbstractXMLStreamWriter(T rootInfo, boolean repaireNamespaces) Create writer instance. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()getProperty(String name) protected XMLStreamWriterScope<T> getScope()protected booleanvoidsetDefaultNamespace(String namespaceURI) voidsetNamespaceContext(NamespaceContext context) voidprotected abstract voidWrite attribute.voidwriteAttribute(String localName, String value) voidwriteAttribute(String namespaceURI, String localName, String value) voidwriteAttribute(String prefix, String namespaceURI, String localName, String value) voidwriteCData(String data) voidwriteCharacters(char[] text, int start, int length) protected final voidwriteCharacters(Object data, int type) voidwriteCharacters(String text) voidwriteComment(String data) protected abstract voidWrite characters/comment/dtd/entity data.voidwriteDefaultNamespace(String namespaceURI) voidvoidwriteEmptyElement(String localName) voidwriteEmptyElement(String namespaceURI, String localName) voidwriteEmptyElement(String prefix, String localName, String namespaceURI) voidvoidprotected abstract voidWrite end element tag.voidwriteEntityRef(String name) voidwriteNamespace(String prefix, String namespaceURI) protected abstract voidwriteNsDecl(String prefix, String namespaceURI) Write namespace declaration.protected abstract voidRead processing instruction.voidwriteProcessingInstruction(String target) voidwriteProcessingInstruction(String target, String data) voidvoidwriteStartDocument(String version) voidwriteStartDocument(String encoding, String version) voidwriteStartElement(String localName) voidwriteStartElement(String namespaceURI, String localName) voidwriteStartElement(String prefix, String localName, String namespaceURI) protected abstract TwriteStartElementTag(String prefix, String localPart, String namespaceURI) Write open start element tag.protected abstract voidWrite close start element tag.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javax.xml.stream.XMLStreamWriter
flush
-
Constructor Details
-
AbstractXMLStreamWriter
Create writer instance.- Parameters:
rootInfo- root scope information
-
-
Method Details
-
getScope
- Returns:
- current scope
-
isStartDocumentWritten
protected boolean isStartDocumentWritten()- Returns:
trueifSTART_DOCUMENTevent has been written
-
writeStartElementTag
protected abstract T writeStartElementTag(String prefix, String localPart, String namespaceURI) throws XMLStreamException Write open start element tag. The returned scope info is stored in the new scope and will be available viagetScope().getInfo().- Parameters:
prefix- element prefix (may beXMLConstants.DEFAULT_NS_PREFIX)localPart- local namenamespaceURI- namespace URI- Returns:
- new scope info
- Throws:
XMLStreamException
-
writeStartElementTagEnd
Write close start element tag.- Throws:
XMLStreamException
-
writeEndElementTag
Write end element tag.- Throws:
XMLStreamException
-
writeAttr
protected abstract void writeAttr(String prefix, String localName, String namespaceURI, String value) throws XMLStreamException Write attribute.- Parameters:
prefix- attribute prefix (may beXMLConstants.DEFAULT_NS_PREFIX)localName- local namenamespaceURI- namespace URIvalue- attribute value- Throws:
XMLStreamException
-
writeNsDecl
Write namespace declaration.- Parameters:
prefix- namespace prefixnamespaceURI- namespace URI- Throws:
XMLStreamException
-
writeData
Write characters/comment/dtd/entity data.- Parameters:
data- text/datatype- one ofCHARACTERS, COMMENT, CDATA, DTD, ENTITY_REFERENCE, SPACE- Throws:
XMLStreamException
-
writePI
Read processing instruction.- Parameters:
target- PI targetdata- PI data (may benull)- Throws:
XMLStreamException
-
writeStartElement
- Specified by:
writeStartElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartElement
- Specified by:
writeStartElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartElement
public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException - Specified by:
writeStartElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEndElement
- Specified by:
writeEndElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEmptyElement
- Specified by:
writeEmptyElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEmptyElement
- Specified by:
writeEmptyElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(String prefix, String localName, String namespaceURI) throws XMLStreamException - Specified by:
writeEmptyElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeAttribute
- Specified by:
writeAttributein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String namespaceURI, String localName, String value) throws XMLStreamException - Specified by:
writeAttributein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String prefix, String namespaceURI, String localName, String value) throws XMLStreamException - Specified by:
writeAttributein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeCharacters
- Throws:
XMLStreamException
-
writeCharacters
- Specified by:
writeCharactersin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeCharacters
- Specified by:
writeCharactersin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeCData
- Specified by:
writeCDatain interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartDocument
- Specified by:
writeStartDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartDocument
- Specified by:
writeStartDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartDocument
- Specified by:
writeStartDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEndDocument
- Specified by:
writeEndDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
close
- Specified by:
closein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeNamespace
- Specified by:
writeNamespacein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeDefaultNamespace
- Specified by:
writeDefaultNamespacein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
getPrefix
- Specified by:
getPrefixin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
setPrefix
- Specified by:
setPrefixin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
setDefaultNamespace
- Specified by:
setDefaultNamespacein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
setNamespaceContext
- Specified by:
setNamespaceContextin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
getNamespaceContext
- Specified by:
getNamespaceContextin interfaceXMLStreamWriter
-
writeComment
- Specified by:
writeCommentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeProcessingInstruction
- Specified by:
writeProcessingInstructionin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeProcessingInstruction
- Specified by:
writeProcessingInstructionin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeDTD
- Specified by:
writeDTDin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEntityRef
- Specified by:
writeEntityRefin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
getProperty
- Specified by:
getPropertyin interfaceXMLStreamWriter- Throws:
IllegalArgumentException
-