com.norconex.commons.lang.xml

Class EnhancedXMLStreamWriter

java.lang.Object

com.norconex.commons.lang.xml.EnhancedXMLStreamWriter

All Implemented Interfaces:

XMLStreamWriter

public class EnhancedXMLStreamWriter
extends Object
implements XMLStreamWriter

A version of XMLStreamWriter that adds convenience methods for adding simple elements and typed attributes, as well as offering pretty-printing. Can be used on its own with a Writer, or as a wrapper to an existing XMLStreamWriter instance.

Since:

1.5.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
EnhancedXMLStreamWriter(Writer out)
EnhancedXMLStreamWriter(Writer out, boolean writeBlanks) Creates a new xml stream writer.
EnhancedXMLStreamWriter(Writer out, boolean writeBlanks, int indent) Creates a new xml stream writer.
EnhancedXMLStreamWriter(XMLStreamWriter xmlStreamWriter)
EnhancedXMLStreamWriter(XMLStreamWriter xmlStreamWriter, boolean writeBlanks)
EnhancedXMLStreamWriter(XMLStreamWriter xmlStreamWriter, boolean writeBlanks, int indent) Creates a new xml stream writer.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
NamespaceContext	getNamespaceContext()
String	getPrefix(String uri)
Object	getProperty(String name)
void	setDefaultNamespace(String uri)
void	setNamespaceContext(NamespaceContext context)
void	setPrefix(String prefix, String uri)
void	writeAttribute(String localName, String value)
void	writeAttribute(String namespaceURI, String localName, String value)
void	writeAttribute(String prefix, String namespaceURI, String localName, String value)
void	writeAttributeBoolean(String localName, Boolean value)
void	writeAttributeBoolean(String localName, Boolean value, boolean writeBlanks) Writes a Boolean attribute.
void	writeAttributeClass(String localName, Class<?> value)
void	writeAttributeClass(String localName, Class<?> value, boolean writeBlanks) Writes an attribute containing a class name, getting it by invoking Class.getCanonicalName().
void	writeAttributeDouble(String localName, Double value)
void	writeAttributeDouble(String localName, Double value, boolean writeBlanks) Writes a Double attribute.
void	writeAttributeFloat(String localName, Float value)
void	writeAttributeFloat(String localName, Float value, boolean writeBlanks) Writes a Float attribute.
void	writeAttributeInteger(String localName, Integer value)
void	writeAttributeInteger(String localName, Integer value, boolean writeBlanks) Writes a Integer attribute.
void	writeAttributeLong(String localName, Long value)
void	writeAttributeLong(String localName, Long value, boolean writeBlanks) Writes a Long attribute.
void	writeAttributeObject(String localName, Object value) Writes an attribute object by first converting it to string using its "toString()" method.
void	writeAttributeObject(String localName, Object value, boolean writeBlanks) Writes an attribute object by first converting it to string using its "toString()" method.
void	writeAttributeString(String localName, String value)
void	writeAttributeString(String localName, String value, boolean writeBlanks) Writes a String attribute.
void	writeCData(String data)
void	writeCharacters(char[] text, int start, int len)
void	writeCharacters(String text)
void	writeComment(String data)
void	writeDefaultNamespace(String namespaceURI)
void	writeDTD(String dtd)
void	writeElementBoolean(String localName, Boolean value)
void	writeElementBoolean(String localName, Boolean value, boolean writeBlanks) Writes a simple Boolean element.
void	writeElementClass(String localName, Class<?> value)
void	writeElementClass(String localName, Class<?> value, boolean writeBlanks) Writes a simple element containing a class name, getting it by invoking Class.getCanonicalName().
void	writeElementDimension(String localName, Dimension value) Writes a simple element containing a Dimension.
void	writeElementDimension(String localName, Dimension value, boolean writeBlanks) Writes a simple element containing a Dimension.
void	writeElementDouble(String localName, Double value)
void	writeElementDouble(String localName, Double value, boolean writeBlanks) Writes a simple Double element.
void	writeElementFloat(String localName, Float value)
void	writeElementFloat(String localName, Float value, boolean writeBlanks) Writes a simple Float element.
void	writeElementInteger(String localName, Integer value)
void	writeElementInteger(String localName, Integer value, boolean writeBlanks) Writes a simple Integer element.
void	writeElementLong(String localName, Long value)
void	writeElementLong(String localName, Long value, boolean writeBlanks) Writes a simple Long element.
void	writeElementObject(String localName, Object value) Writes a simple element object by first converting it to string using its "toString()" method.
void	writeElementObject(String localName, Object value, boolean writeBlanks) Writes a simple element object by first converting it to string using its "toString()" method.
void	writeElementString(String localName, String value)
void	writeElementString(String localName, String value, boolean writeBlanks) Writes a simple string element.
void	writeEmptyElement(String localName)
void	writeEmptyElement(String namespaceURI, String localName)
void	writeEmptyElement(String prefix, String localName, String namespaceURI)
void	writeEndDocument()
void	writeEndElement()
void	writeEntityRef(String name)
void	writeNamespace(String prefix, String namespaceURI)
void	writeProcessingInstruction(String target)
void	writeProcessingInstruction(String target, String data)
void	writeStartDocument()
void	writeStartDocument(String version)
void	writeStartDocument(String encoding, String version)
void	writeStartElement(String localName)
void	writeStartElement(String namespaceURI, String localName)
void	writeStartElement(String prefix, String localName, String namespaceURI)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnhancedXMLStreamWriter

public EnhancedXMLStreamWriter(Writer out)
                        throws XMLStreamException

Throws:

XMLStreamException

EnhancedXMLStreamWriter

public EnhancedXMLStreamWriter(Writer out,
                               boolean writeBlanks)
                        throws XMLStreamException

Creates a new xml stream writer.

Parameters:

out - writer used to write XML

writeBlanks - true to write attributes/elements with no values when invoking methods without the "writeBlanks" argument. This sets the default behavior which can be overwritten using methods with "writeBlanks" argument.

Throws:

XMLStreamException - problem creating XML stream writer

EnhancedXMLStreamWriter

public EnhancedXMLStreamWriter(Writer out,
                               boolean writeBlanks,
                               int indent)
                        throws XMLStreamException

Creates a new xml stream writer.

Parameters:

out - writer used to write XML

writeBlanks - true to write attributes/elements with no values when invoking methods without the "writeBlanks" argument. This sets the default behavior which can be overwritten using methods with "writeBlanks" argument.

indent - how many spaces to use for indentation (-1=no indent; 0=newline only; 1+=number of spaces after newline)

Throws:

XMLStreamException - problem creating XML stream writer

Since:

1.13.0

EnhancedXMLStreamWriter

public EnhancedXMLStreamWriter(XMLStreamWriter xmlStreamWriter)

EnhancedXMLStreamWriter

public EnhancedXMLStreamWriter(XMLStreamWriter xmlStreamWriter,
                               boolean writeBlanks)

EnhancedXMLStreamWriter

public EnhancedXMLStreamWriter(XMLStreamWriter xmlStreamWriter,
                               boolean writeBlanks,
                               int indent)

Creates a new xml stream writer.

Parameters:

xmlStreamWriter - wrapped stream writer

writeBlanks - true to write attributes/elements with no values

indent - how many spaces to use for indentation (-1=no indent; 0=newline only; 1+=number of spaces after newline)

Since:

1.13.0

Method Detail

writeAttributeInteger

public void writeAttributeInteger(String localName,
                                  Integer value)
                           throws XMLStreamException

Throws:

XMLStreamException

writeAttributeInteger

public void writeAttributeInteger(String localName,
                                  Integer value,
                                  boolean writeBlanks)
                           throws XMLStreamException

Writes a Integer attribute.

Parameters:

localName - attribute name

value - Integer attribute value

writeBlanks - whether a blank value should be written as an empty attribute.

Throws:

XMLStreamException - problem writing attribute

Since:

1.14.0

writeAttributeLong

public void writeAttributeLong(String localName,
                               Long value)
                        throws XMLStreamException

Throws:

XMLStreamException

writeAttributeLong

public void writeAttributeLong(String localName,
                               Long value,
                               boolean writeBlanks)
                        throws XMLStreamException

Writes a Long attribute.

Parameters:

localName - attribute name

value - Long attribute value

writeBlanks - whether a blank value should be written as an empty attribute.

Throws:

XMLStreamException - problem writing attribute

Since:

1.14.0

writeAttributeFloat

public void writeAttributeFloat(String localName,
                                Float value)
                         throws XMLStreamException

Throws:

XMLStreamException

writeAttributeFloat

public void writeAttributeFloat(String localName,
                                Float value,
                                boolean writeBlanks)
                         throws XMLStreamException

Writes a Float attribute.

Parameters:

localName - attribute name

value - Float attribute value

writeBlanks - whether a blank value should be written as an empty attribute.

Throws:

XMLStreamException - problem writing attribute

Since:

1.14.0

writeAttributeDouble

public void writeAttributeDouble(String localName,
                                 Double value)
                          throws XMLStreamException

Throws:

XMLStreamException

writeAttributeDouble

public void writeAttributeDouble(String localName,
                                 Double value,
                                 boolean writeBlanks)
                          throws XMLStreamException

Writes a Double attribute.

Parameters:

localName - attribute name

value - Double attribute value

writeBlanks - whether a blank value should be written as an empty attribute.

Throws:

XMLStreamException - problem writing attribute

Since:

1.14.0

writeAttributeBoolean

public void writeAttributeBoolean(String localName,
                                  Boolean value)
                           throws XMLStreamException

Throws:

XMLStreamException

writeAttributeBoolean

public void writeAttributeBoolean(String localName,
                                  Boolean value,
                                  boolean writeBlanks)
                           throws XMLStreamException

Writes a Boolean attribute.

Parameters:

localName - attribute name

value - Boolean attribute value

writeBlanks - whether a blank value should be written as an empty attribute.

Throws:

XMLStreamException - problem writing attribute

Since:

1.14.0

writeAttributeString

public void writeAttributeString(String localName,
                                 String value)
                          throws XMLStreamException

Throws:

XMLStreamException

writeAttributeString

public void writeAttributeString(String localName,
                                 String value,
                                 boolean writeBlanks)
                          throws XMLStreamException

Writes a String attribute.

Parameters:

localName - attribute name

value - String attribute value

writeBlanks - whether a blank value should be written as an empty attribute.

Throws:

XMLStreamException - problem writing attribute

Since:

1.14.0

writeAttributeClass

public void writeAttributeClass(String localName,
                                Class<?> value)
                         throws XMLStreamException

Throws:

XMLStreamException

writeAttributeClass

public void writeAttributeClass(String localName,
                                Class<?> value,
                                boolean writeBlanks)
                         throws XMLStreamException

Writes an attribute containing a class name, getting it by invoking Class.getCanonicalName().

Parameters:

localName - attribute name

value - Class attribute value

writeBlanks - whether a blank value should be written as an empty attribute.

Throws:

XMLStreamException - problem writing attribute

Since:

1.14.0

writeAttributeObject

public void writeAttributeObject(String localName,
                                 Object value)
                          throws XMLStreamException

Writes an attribute object by first converting it to string using its "toString()" method.

Parameters:

localName - attribute name

value - attribute value

Throws:

XMLStreamException - problem writing attribute

Since:

1.14.0

writeAttributeObject

public void writeAttributeObject(String localName,
                                 Object value,
                                 boolean writeBlanks)
                          throws XMLStreamException

Writes an attribute object by first converting it to string using its "toString()" method.

Parameters:

localName - attribute name

value - attribute value

writeBlanks - whether a blank value should be written as an empty attribute.

Throws:

XMLStreamException - problem writing attribute

Since:

1.14.0

writeElementInteger

public void writeElementInteger(String localName,
                                Integer value)
                         throws XMLStreamException

Throws:

XMLStreamException

writeElementInteger

public void writeElementInteger(String localName,
                                Integer value,
                                boolean writeBlanks)
                         throws XMLStreamException

Writes a simple Integer element.

Parameters:

localName - element (tag) name

value - the Integer value

writeBlanks - whether a blank value should be written as an empty element.

Throws:

XMLStreamException - problem writing element

Since:

1.14.0

writeElementLong

public void writeElementLong(String localName,
                             Long value)
                      throws XMLStreamException

Throws:

XMLStreamException

writeElementLong

public void writeElementLong(String localName,
                             Long value,
                             boolean writeBlanks)
                      throws XMLStreamException

Writes a simple Long element.

Parameters:

localName - element (tag) name

value - the Long value

writeBlanks - whether a blank value should be written as an empty element.

Throws:

XMLStreamException - problem writing element

Since:

1.14.0

writeElementFloat

public void writeElementFloat(String localName,
                              Float value)
                       throws XMLStreamException

Throws:

XMLStreamException

writeElementFloat

public void writeElementFloat(String localName,
                              Float value,
                              boolean writeBlanks)
                       throws XMLStreamException

Writes a simple Float element.

Parameters:

localName - element (tag) name

value - the Float value

writeBlanks - whether a blank value should be written as an empty element.

Throws:

XMLStreamException - problem writing element

Since:

1.14.0

writeElementDouble

public void writeElementDouble(String localName,
                               Double value)
                        throws XMLStreamException

Throws:

XMLStreamException

writeElementDouble

public void writeElementDouble(String localName,
                               Double value,
                               boolean writeBlanks)
                        throws XMLStreamException

Writes a simple Double element.

Parameters:

localName - element (tag) name

value - the Double value

writeBlanks - whether a blank value should be written as an empty element.

Throws:

XMLStreamException - problem writing element

Since:

1.14.0

writeElementBoolean

public void writeElementBoolean(String localName,
                                Boolean value)
                         throws XMLStreamException

Throws:

XMLStreamException

writeElementBoolean

public void writeElementBoolean(String localName,
                                Boolean value,
                                boolean writeBlanks)
                         throws XMLStreamException

Writes a simple Boolean element.

Parameters:

localName - element (tag) name

value - the Boolean value

writeBlanks - whether a blank value should be written as an empty element.

Throws:

XMLStreamException - problem writing element

Since:

1.14.0

writeElementString

public void writeElementString(String localName,
                               String value)
                        throws XMLStreamException

Throws:

XMLStreamException

writeElementString

public void writeElementString(String localName,
                               String value,
                               boolean writeBlanks)
                        throws XMLStreamException

Writes a simple string element.

Parameters:

localName - element (tag) name

value - the string value

writeBlanks - whether a blank value should be written as an empty element.

Throws:

XMLStreamException - problem writing element

Since:

1.14.0

writeElementClass

public void writeElementClass(String localName,
                              Class<?> value)
                       throws XMLStreamException

Throws:

XMLStreamException

writeElementClass

public void writeElementClass(String localName,
                              Class<?> value,
                              boolean writeBlanks)
                       throws XMLStreamException

Writes a simple element containing a class name, getting it by invoking Class.getCanonicalName().

Parameters:

localName - element (tag) name

value - the class

writeBlanks - whether a blank value should be written as an empty element.

Throws:

XMLStreamException - problem writing element

Since:

1.14.0

writeElementDimension

public void writeElementDimension(String localName,
                                  Dimension value)
                           throws XMLStreamException

Writes a simple element containing a Dimension. The dimension will be written as [width]x[height] (e.g., 400x300) or just one numeric value if width and height are the same.

Parameters:

localName - element (tag) name

value - the dimension

Throws:

XMLStreamException - problem writing element

Since:

1.14.0

writeElementDimension

public void writeElementDimension(String localName,
                                  Dimension value,
                                  boolean writeBlanks)
                           throws XMLStreamException

Writes a simple element containing a Dimension. The dimension will be written as [width]x[height] (e.g., 400x300) or just one numeric value if width and height are the same.

Parameters:

localName - element (tag) name

value - the dimension

writeBlanks - whether a blank value should be written as an empty element.

Throws:

XMLStreamException - problem writing element

Since:

1.14.0

writeElementObject

public void writeElementObject(String localName,
                               Object value)
                        throws XMLStreamException

Writes a simple element object by first converting it to string using its "toString()" method.

Parameters:

localName - element (tag) name

value - element (tag) value

Throws:

XMLStreamException - problem writing element

Since:

1.14.0

writeElementObject

public void writeElementObject(String localName,
                               Object value,
                               boolean writeBlanks)
                        throws XMLStreamException

Writes a simple element object by first converting it to string using its "toString()" method.

Parameters:

localName - element (tag) name

value - element (tag) value

writeBlanks - whether a blank value should be written as an empty element.

Throws:

XMLStreamException - problem writing element

Since:

1.14.0

writeStartElement

public void writeStartElement(String localName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String namespaceURI,
                              String localName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String prefix,
                              String localName,
                              String namespaceURI)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String namespaceURI,
                              String localName)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String prefix,
                              String localName,
                              String namespaceURI)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String localName)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEndElement

public void writeEndElement()
                     throws XMLStreamException

Specified by:

writeEndElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEndDocument

public void writeEndDocument()
                      throws XMLStreamException

Specified by:

writeEndDocument in interface XMLStreamWriter

Throws:

XMLStreamException

close

public void close()
           throws XMLStreamException

Specified by:

close in interface XMLStreamWriter

Throws:

XMLStreamException

flush

public void flush()
           throws XMLStreamException

Specified by:

flush in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String localName,
                           String value)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String prefix,
                           String namespaceURI,
                           String localName,
                           String value)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String namespaceURI,
                           String localName,
                           String value)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeNamespace

public void writeNamespace(String prefix,
                           String namespaceURI)
                    throws XMLStreamException

Specified by:

writeNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

writeDefaultNamespace

public void writeDefaultNamespace(String namespaceURI)
                           throws XMLStreamException

Specified by:

writeDefaultNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

writeComment

public void writeComment(String data)
                  throws XMLStreamException

Specified by:

writeComment in interface XMLStreamWriter

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(String target)
                                throws XMLStreamException

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(String target,
                                       String data)
                                throws XMLStreamException

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Throws:

XMLStreamException

writeCData

public void writeCData(String data)
                throws XMLStreamException

Specified by:

writeCData in interface XMLStreamWriter

Throws:

XMLStreamException

writeDTD

public void writeDTD(String dtd)
              throws XMLStreamException

Specified by:

writeDTD in interface XMLStreamWriter

Throws:

XMLStreamException

writeEntityRef

public void writeEntityRef(String name)
                    throws XMLStreamException

Specified by:

writeEntityRef in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument()
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(String version)
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(String encoding,
                               String version)
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeCharacters

public void writeCharacters(String text)
                     throws XMLStreamException

Specified by:

writeCharacters in interface XMLStreamWriter

Throws:

XMLStreamException

writeCharacters

public void writeCharacters(char[] text,
                            int start,
                            int len)
                     throws XMLStreamException

Specified by:

writeCharacters in interface XMLStreamWriter

Throws:

XMLStreamException

getPrefix

public String getPrefix(String uri)
                 throws XMLStreamException

Specified by:

getPrefix in interface XMLStreamWriter

Throws:

XMLStreamException

setPrefix

public void setPrefix(String prefix,
                      String uri)
               throws XMLStreamException

Specified by:

setPrefix in interface XMLStreamWriter

Throws:

XMLStreamException

setDefaultNamespace

public void setDefaultNamespace(String uri)
                         throws XMLStreamException

Specified by:

setDefaultNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

setNamespaceContext

public void setNamespaceContext(NamespaceContext context)
                         throws XMLStreamException

Specified by:

setNamespaceContext in interface XMLStreamWriter

Throws:

XMLStreamException

getNamespaceContext

public NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface XMLStreamWriter

getProperty

public Object getProperty(String name)

Specified by:

getProperty in interface XMLStreamWriter