Package org.jboss.staxmapper
Class FormattingXMLStreamWriter
- java.lang.Object
-
- org.jboss.staxmapper.FormattingXMLStreamWriter
-
- All Implemented Interfaces:
XMLStreamConstants,XMLStreamWriter,XMLExtendedStreamWriter
public final class FormattingXMLStreamWriter extends Object implements XMLExtendedStreamWriter, XMLStreamConstants
An XML stream writer which nicely formats the XML for configuration files.- Author:
- David M. Lloyd
-
-
Field Summary
-
Fields inherited from interface javax.xml.stream.XMLStreamConstants
ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT
-
-
Constructor Summary
Constructors Constructor Description FormattingXMLStreamWriter(XMLStreamWriter delegate)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()voidflush()NamespaceContextgetNamespaceContext()StringgetPrefix(String uri)ObjectgetProperty(String name)voidsetDefaultNamespace(String uri)voidsetNamespaceContext(NamespaceContext context)voidsetPrefix(String prefix, String uri)voidsetUnspecifiedElementNamespace(String namespace)Sets the namespace to use for child element writes when a namespace is not specified.voidwriteAttribute(String localName, Iterable<String> values)voidwriteAttribute(String localName, String value)voidwriteAttribute(String localName, String[] values)voidwriteAttribute(String namespaceURI, String localName, Iterable<String> values)voidwriteAttribute(String namespaceURI, String localName, String value)voidwriteAttribute(String namespaceURI, String localName, String[] values)voidwriteAttribute(String prefix, String namespaceURI, String localName, Iterable<String> values)voidwriteAttribute(String prefix, String namespaceURI, String localName, String value)voidwriteAttribute(String prefix, String namespaceURI, String localName, String[] values)voidwriteCData(String data)voidwriteCharacters(char[] text, int start, int len)voidwriteCharacters(String text)voidwriteComment(String data)voidwriteDefaultNamespace(String namespaceURI)voidwriteDTD(String dtd)voidwriteEmptyElement(String localName)voidwriteEmptyElement(String namespaceURI, String localName)voidwriteEmptyElement(String prefix, String localName, String namespaceURI)voidwriteEndDocument()voidwriteEndElement()voidwriteEntityRef(String name)voidwriteNamespace(String prefix, String namespaceURI)voidwriteProcessingInstruction(String target)voidwriteProcessingInstruction(String target, String data)voidwriteStartDocument()voidwriteStartDocument(String version)voidwriteStartDocument(String encoding, String version)voidwriteStartElement(String localName)voidwriteStartElement(String namespaceURI, String localName)voidwriteStartElement(String prefix, String localName, String namespaceURI)
-
-
-
Constructor Detail
-
FormattingXMLStreamWriter
public FormattingXMLStreamWriter(XMLStreamWriter delegate)
-
-
Method Detail
-
setUnspecifiedElementNamespace
public void setUnspecifiedElementNamespace(String namespace)
Description copied from interface:XMLExtendedStreamWriterSets the namespace to use for child element writes when a namespace is not specified. In other words, whenXMLStreamWriter.writeStartElement(String)is called this namespace will be used. Setting this to null will result in the standard behavior, which is usage of the xml default ns (not specifying a prefix) This setting is scoped within the document or element that it was called in. Once called all further child elements will use this namespace. In addition, it is inherited for all levels of nesting. In other words, setting an unspecified namespace on a grandchild will not affect the namespace setting of a child sibling. To clear the effect of this setting, call the method with a value of null.- Specified by:
setUnspecifiedElementNamespacein interfaceXMLExtendedStreamWriter- Parameters:
namespace- The namespace to use when not specified on elements, or null if the xml default ns should be used
-
writeStartElement
public void writeStartElement(String localName) throws XMLStreamException
- Specified by:
writeStartElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartElement
public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException
- Specified by:
writeStartElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartElement
public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException
- Specified by:
writeStartElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(String namespaceURI, String localName) throws XMLStreamException
- Specified by:
writeEmptyElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(String prefix, String localName, String namespaceURI) throws XMLStreamException
- Specified by:
writeEmptyElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(String localName) throws XMLStreamException
- Specified by:
writeEmptyElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEndElement
public void writeEndElement() throws XMLStreamException- Specified by:
writeEndElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEndDocument
public void writeEndDocument() throws XMLStreamException- Specified by:
writeEndDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
close
public void close() throws XMLStreamException- Specified by:
closein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
flush
public void flush() throws XMLStreamException- Specified by:
flushin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(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
-
writeAttribute
public void writeAttribute(String namespaceURI, String localName, String value) throws XMLStreamException
- Specified by:
writeAttributein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String localName, String[] values) throws XMLStreamException
- Specified by:
writeAttributein interfaceXMLExtendedStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String prefix, String namespaceURI, String localName, String[] values) throws XMLStreamException
- Specified by:
writeAttributein interfaceXMLExtendedStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String namespaceURI, String localName, String[] values) throws XMLStreamException
- Specified by:
writeAttributein interfaceXMLExtendedStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String localName, Iterable<String> values) throws XMLStreamException
- Specified by:
writeAttributein interfaceXMLExtendedStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String prefix, String namespaceURI, String localName, Iterable<String> values) throws XMLStreamException
- Specified by:
writeAttributein interfaceXMLExtendedStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String namespaceURI, String localName, Iterable<String> values) throws XMLStreamException
- Specified by:
writeAttributein interfaceXMLExtendedStreamWriter- Throws:
XMLStreamException
-
writeNamespace
public void writeNamespace(String prefix, String namespaceURI) throws XMLStreamException
- Specified by:
writeNamespacein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeDefaultNamespace
public void writeDefaultNamespace(String namespaceURI) throws XMLStreamException
- Specified by:
writeDefaultNamespacein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeComment
public void writeComment(String data) throws XMLStreamException
- Specified by:
writeCommentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeProcessingInstruction
public void writeProcessingInstruction(String target) throws XMLStreamException
- Specified by:
writeProcessingInstructionin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeProcessingInstruction
public void writeProcessingInstruction(String target, String data) throws XMLStreamException
- Specified by:
writeProcessingInstructionin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeCData
public void writeCData(String data) throws XMLStreamException
- Specified by:
writeCDatain interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeDTD
public void writeDTD(String dtd) throws XMLStreamException
- Specified by:
writeDTDin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEntityRef
public void writeEntityRef(String name) throws XMLStreamException
- Specified by:
writeEntityRefin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartDocument
public void writeStartDocument() throws XMLStreamException- Specified by:
writeStartDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartDocument
public void writeStartDocument(String version) throws XMLStreamException
- Specified by:
writeStartDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartDocument
public void writeStartDocument(String encoding, String version) throws XMLStreamException
- Specified by:
writeStartDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeCharacters
public void writeCharacters(String text) throws XMLStreamException
- Specified by:
writeCharactersin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeCharacters
public void writeCharacters(char[] text, int start, int len) throws XMLStreamException- Specified by:
writeCharactersin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
getPrefix
public String getPrefix(String uri) throws XMLStreamException
- Specified by:
getPrefixin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
setPrefix
public void setPrefix(String prefix, String uri) throws XMLStreamException
- Specified by:
setPrefixin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
setDefaultNamespace
public void setDefaultNamespace(String uri) throws XMLStreamException
- Specified by:
setDefaultNamespacein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
setNamespaceContext
public void setNamespaceContext(NamespaceContext context) throws XMLStreamException
- Specified by:
setNamespaceContextin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
getNamespaceContext
public NamespaceContext getNamespaceContext()
- Specified by:
getNamespaceContextin interfaceXMLStreamWriter
-
getProperty
public Object getProperty(String name) throws IllegalArgumentException
- Specified by:
getPropertyin interfaceXMLStreamWriter- Throws:
IllegalArgumentException
-
-