org.apache.juneau.xml

Class XmlWriter

java.lang.Object

java.io.Writer

org.apache.juneau.serializer.SerializerWriter

org.apache.juneau.xml.XmlWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

HtmlWriter

public class XmlWriter
extends SerializerWriter

Specialized writer for serializing XML.

Notes:

• This class is not intended for external use.

Field Summary

Fields inherited from class org.apache.juneau.serializer.SerializerWriter

maxIndent, out, quoteChar, trimStrings, uriResolver, useWhitespace

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
XmlWriter(Writer out, boolean useWhitespace, int maxIndent, boolean trimStrings, char quoteChar, UriResolver uriResolver, boolean enableNs, Namespace defaultNamespace) Constructor.

Method Summary

Modifier and Type	Method and Description
XmlWriter	append(char c)
XmlWriter	append(int indent, char c) Writes an indent (if the useWhitespace setting is enabled), followed by text.
XmlWriter	append(int indent, String text) Writes an indent (if the useWhitespace setting is enabled), followed by text.
XmlWriter	append(Object text) Writes the specified text to the writer.
XmlWriter	append(String text) Writes the specified text to the writer.
XmlWriter	appendln(int indent, String text) Writes an indent (if the useWhitespace setting is enabled), followed by text, followed by a newline (if the useWhitespace setting is enabled).
XmlWriter	appendln(String text) Writes the specified text followed by a newline (if the useWhitespace setting is enabled).
XmlWriter	attr(Namespace ns, String name, Object value) Same as attr(String, String, Object), except pass in a Namespace object for the namespace.
XmlWriter	attr(String name, Object value) Shortcut for attr(null, name, value, false);
XmlWriter	attr(String name, Object value, boolean valNeedsEncoding) Shortcut for attr(null, name, value, false);
XmlWriter	attr(String ns, String name, Object value) Shortcut for attr(ns, name, value, false);
XmlWriter	attr(String ns, String name, Object value, boolean valNeedsEncoding) Writes an attribute to the output: ns:name='value'
XmlWriter	attrUri(Namespace ns, String name, Object value) Writes an attribute with a URI value to the output: ns:name='uri-value'
XmlWriter	attrUri(String ns, String name, Object value) Writes an attribute with a URI value to the output: ns:name='uri-value'
XmlWriter	ceTag() Closes an empty tag.
XmlWriter	cr(int depth) Performs a carriage return.
XmlWriter	cre(int depth) Performs a carriage return at the end of a line.
XmlWriter	cTag() Closes a tag.
XmlWriter	eTag(int indent, String name) Shortcut for i(indent).eTag(null, name, false);
XmlWriter	eTag(int indent, String ns, String name) Shortcut for i(indent).eTag(ns, name, false);
XmlWriter	eTag(int indent, String ns, String name, boolean needsEncoding) Shortcut for i(indent).eTag(ns, name, needsEncoding);
XmlWriter	eTag(String name) Shortcut for eTag(null, name, false);
XmlWriter	eTag(String ns, String name) Shortcut for eTag(ns, name, false);
XmlWriter	eTag(String ns, String name, boolean needsEncoding) Writes an end tag to the output: </ns:name>
XmlWriter	i(int indent) Writes an indent to the writer if the useWhitespace setting is enabled.
XmlWriter	ie(int indent) Writes an end-of-line indent to the writer if the useWhitespace setting is enabled.
XmlWriter	nl(int indent) Writes a newline to the writer if the useWhitespace setting is enabled.
XmlWriter	oAttr(Namespace ns, String name) Writes an open-ended attribute to the output: ns:name=
XmlWriter	oAttr(String ns, String name) Writes an open-ended attribute to the output: ns:name=
XmlWriter	oTag(int indent, String name) Shortcut for i(indent).oTag(null, name, false);
XmlWriter	oTag(int indent, String ns, String name) Shortcut for i(indent).oTag(ns, name, false);
XmlWriter	oTag(int indent, String ns, String name, boolean needsEncoding) Shortcut for i(indent).oTag(ns, name, needsEncoding);
XmlWriter	oTag(String name) Shortcut for oTag(null, name, false);
XmlWriter	oTag(String ns, String name) Shortcut for oTag(ns, name, false);
XmlWriter	oTag(String ns, String name, boolean needsEncoding) Writes an opening tag to the output: <ns:name
XmlWriter	q() Adds the quote character specified by the quoteChar setting to the output.
XmlWriter	s() Adds a whitespace character to the output if the useWhitespace setting is enabled.
XmlWriter	sTag(int indent, String name) Shortcut for i(indent).sTag(null, name, false);
XmlWriter	sTag(int indent, String ns, String name) Shortcut for i(indent).sTag(ns, name, false);
XmlWriter	sTag(int indent, String ns, String name, boolean needsEncoding) Shortcut for i(indent).sTag(ns, name, needsEncoding);
XmlWriter	sTag(String name) Shortcut for sTag(null, name, false);
XmlWriter	sTag(String ns, String name) Shortcut for sTag(ns, name, false);
XmlWriter	sTag(String ns, String name, boolean needsEncoding) Writes a start tag to the output: <ns:name>
XmlWriter	tag(int indent, String name) Shortcut for i(indent).tag(null, name, false);
XmlWriter	tag(int indent, String ns, String name) Shortcut for i(indent).tag(ns, name, false);
XmlWriter	tag(int indent, String ns, String name, boolean needsEncoding) Shortcut for i(indent).tag(ns, name, needsEncoding);
XmlWriter	tag(String name) Shortcut for tag(null, name, false);
XmlWriter	tag(String ns, String name) Shortcut for tag(ns, name, false);
XmlWriter	tag(String ns, String name, boolean needsEncoding) Writes a closed tag to the output: <ns:name/>
XmlWriter	text(Object o) Shortcut for calling text(o, false);
XmlWriter	text(Object o, boolean preserveWhitespace) Serializes and encodes the specified object as valid XML text.
XmlWriter	textUri(Object o) Same as text(Object) but treats the value as a URL to resolved then serialized.
String	toString()

Methods inherited from class org.apache.juneau.serializer.SerializerWriter

append, appendIf, appendIf, appendUri, close, flush, nlIf, sIf, write

Methods inherited from class java.io.Writer

append, append, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlWriter

public XmlWriter(Writer out,
                 boolean useWhitespace,
                 int maxIndent,
                 boolean trimStrings,
                 char quoteChar,
                 UriResolver uriResolver,
                 boolean enableNs,
                 Namespace defaultNamespace)

Constructor.

Parameters:

out - The wrapped writer.

useWhitespace - If true XML elements will be indented.

maxIndent - The maximum indentation level.

trimStrings - If true, strings should be trimmed before they're serialized.

quoteChar - The quote character to use for attributes. Should be '\'' or '"'.

uriResolver - The URI resolver for resolving URIs to absolute or root-relative form.

enableNs - Flag to indicate if XML namespaces are enabled.

defaultNamespace - The default namespace if XML namespaces are enabled.

Method Detail

oTag

public XmlWriter oTag(String ns,
                      String name,
                      boolean needsEncoding)
               throws IOException

Writes an opening tag to the output: <ns:name

Parameters:

ns - The namespace. Can be null.

name - The element name.

needsEncoding - If true, element name will be encoded.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

oTag

public XmlWriter oTag(String ns,
                      String name)
               throws IOException

Shortcut for oTag(ns, name, false);

Parameters:

ns - The namespace. Can be null.

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

oTag

public XmlWriter oTag(String name)
               throws IOException

Shortcut for oTag(null, name, false);

Parameters:

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

oTag

public XmlWriter oTag(int indent,
                      String ns,
                      String name,
                      boolean needsEncoding)
               throws IOException

Shortcut for i(indent).oTag(ns, name, needsEncoding);

Parameters:

indent - The number of prefix tabs to add.

ns - The namespace. Can be null.

name - The element name.

needsEncoding - If true, element name will be encoded.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

oTag

public XmlWriter oTag(int indent,
                      String ns,
                      String name)
               throws IOException

Shortcut for i(indent).oTag(ns, name, false);

Parameters:

indent - The number of prefix tabs to add.

ns - The namespace. Can be null.

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

oTag

public XmlWriter oTag(int indent,
                      String name)
               throws IOException

Shortcut for i(indent).oTag(null, name, false);

Parameters:

indent - The number of prefix tabs to add.

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

cTag

public XmlWriter cTag()
               throws IOException

Closes a tag.

Shortcut for append('>');

Returns:

This object (for method chaining).

Throws:

IOException

ceTag

public XmlWriter ceTag()
                throws IOException

Closes an empty tag.

Shortcut for append('/').append('>');

Returns:

This object (for method chaining).

Throws:

IOException

tag

public XmlWriter tag(String ns,
                     String name,
                     boolean needsEncoding)
              throws IOException

Writes a closed tag to the output: <ns:name/>

Parameters:

ns - The namespace. Can be null.

name - The element name.

needsEncoding - If true, element name will be encoded.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

tag

public XmlWriter tag(String ns,
                     String name)
              throws IOException

Shortcut for tag(ns, name, false);

Parameters:

ns - The namespace. Can be null.

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

tag

public XmlWriter tag(String name)
              throws IOException

Shortcut for tag(null, name, false);

Parameters:

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

tag

public XmlWriter tag(int indent,
                     String name)
              throws IOException

Shortcut for i(indent).tag(null, name, false);

Parameters:

indent - The number of prefix tabs to add.

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

tag

public XmlWriter tag(int indent,
                     String ns,
                     String name,
                     boolean needsEncoding)
              throws IOException

Shortcut for i(indent).tag(ns, name, needsEncoding);

Parameters:

indent - The number of prefix tabs to add.

ns - The namespace. Can be null.

name - The element name.

needsEncoding - If true, element name will be encoded.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

tag

public XmlWriter tag(int indent,
                     String ns,
                     String name)
              throws IOException

Shortcut for i(indent).tag(ns, name, false);

Parameters:

indent - The number of prefix tabs to add.

ns - The namespace. Can be null.

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

sTag

public XmlWriter sTag(String ns,
                      String name,
                      boolean needsEncoding)
               throws IOException

Writes a start tag to the output: <ns:name>

Parameters:

ns - The namespace. Can be null.

name - The element name.

needsEncoding - If true, element name will be encoded.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

sTag

public XmlWriter sTag(String ns,
                      String name)
               throws IOException

Shortcut for sTag(ns, name, false);

Parameters:

ns - The namespace. Can be null.

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

sTag

public XmlWriter sTag(String name)
               throws IOException

Shortcut for sTag(null, name, false);

Parameters:

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

sTag

public XmlWriter sTag(int indent,
                      String ns,
                      String name,
                      boolean needsEncoding)
               throws IOException

Shortcut for i(indent).sTag(ns, name, needsEncoding);

Parameters:

indent - The number of prefix tabs to add.

ns - The namespace. Can be null.

name - The element name.

needsEncoding - If true, element name will be encoded.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

sTag

public XmlWriter sTag(int indent,
                      String ns,
                      String name)
               throws IOException

Shortcut for i(indent).sTag(ns, name, false);

Parameters:

indent - The number of prefix tabs to add.

ns - The namespace. Can be null.

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

sTag

public XmlWriter sTag(int indent,
                      String name)
               throws IOException

Shortcut for i(indent).sTag(null, name, false);

Parameters:

indent - The number of prefix tabs to add.

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

eTag

public XmlWriter eTag(String ns,
                      String name,
                      boolean needsEncoding)
               throws IOException

Writes an end tag to the output: </ns:name>

Parameters:

ns - The namespace. Can be null.

name - The element name.

needsEncoding - If true, element name will be encoded.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

eTag

public XmlWriter eTag(String ns,
                      String name)
               throws IOException

Shortcut for eTag(ns, name, false);

Parameters:

ns - The namespace. Can be null.

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

eTag

public XmlWriter eTag(String name)
               throws IOException

Shortcut for eTag(null, name, false);

Parameters:

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

eTag

public XmlWriter eTag(int indent,
                      String ns,
                      String name,
                      boolean needsEncoding)
               throws IOException

Shortcut for i(indent).eTag(ns, name, needsEncoding);

Parameters:

indent - The number of prefix tabs to add.

ns - The namespace. Can be null.

name - The element name.

needsEncoding - If true, element name will be encoded.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

eTag

public XmlWriter eTag(int indent,
                      String ns,
                      String name)
               throws IOException

Shortcut for i(indent).eTag(ns, name, false);

Parameters:

indent - The number of prefix tabs to add.

ns - The namespace. Can be null.

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

eTag

public XmlWriter eTag(int indent,
                      String name)
               throws IOException

Shortcut for i(indent).eTag(null, name, false);

Parameters:

indent - The number of prefix tabs to add.

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

attr

public XmlWriter attr(String ns,
                      String name,
                      Object value,
                      boolean valNeedsEncoding)
               throws IOException

Writes an attribute to the output: ns:name='value'

Parameters:

ns - The namespace. Can be null.

name - The attribute name.

value - The attribute value.

valNeedsEncoding - If true, attribute name will be encoded.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

attr

public XmlWriter attr(String name,
                      Object value,
                      boolean valNeedsEncoding)
               throws IOException

Shortcut for attr(null, name, value, false);

Parameters:

name - The attribute name.

value - The attribute value.

valNeedsEncoding - If true, attribute name will be encoded.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

attr

public XmlWriter attr(String ns,
                      String name,
                      Object value)
               throws IOException

Shortcut for attr(ns, name, value, false);

Parameters:

ns - The namespace. Can be null.

name - The attribute name.

value - The attribute value.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

attr

public XmlWriter attr(Namespace ns,
                      String name,
                      Object value)
               throws IOException

Same as attr(String, String, Object), except pass in a Namespace object for the namespace.

Parameters:

ns - The namespace. Can be null.

name - The attribute name.

value - The attribute value.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

attr

public XmlWriter attr(String name,
                      Object value)
               throws IOException

Shortcut for attr(null, name, value, false);

Parameters:

name - The attribute name.

value - The attribute value.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

oAttr

public XmlWriter oAttr(String ns,
                       String name)
                throws IOException

Writes an open-ended attribute to the output: ns:name=

Parameters:

ns - The namespace. Can be null.

name - The attribute name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

oAttr

public XmlWriter oAttr(Namespace ns,
                       String name)
                throws IOException

Writes an open-ended attribute to the output: ns:name=

Parameters:

ns - The namespace. Can be null.

name - The attribute name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

attrUri

public XmlWriter attrUri(Namespace ns,
                         String name,
                         Object value)
                  throws IOException

Writes an attribute with a URI value to the output: ns:name='uri-value'

Parameters:

ns - The namespace. Can be null.

name - The attribute name.

value - The attribute value, convertible to a URI via toString()

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

attrUri

public XmlWriter attrUri(String ns,
                         String name,
                         Object value)
                  throws IOException

Writes an attribute with a URI value to the output: ns:name='uri-value'

Parameters:

ns - The namespace. Can be null.

name - The attribute name.

value - The attribute value, convertible to a URI via toString()

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

text

public XmlWriter text(Object o)
               throws IOException

Shortcut for calling text(o, false);

Parameters:

o - The object being serialized.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

text

public XmlWriter text(Object o,
                      boolean preserveWhitespace)
               throws IOException

Serializes and encodes the specified object as valid XML text.

Parameters:

o - The object being serialized.

preserveWhitespace - If true, then we're serializing XmlFormat.MIXED_PWS or XmlFormat.TEXT_PWS content.

Returns:

This object (for method chaining).

Throws:

IOException

textUri

public XmlWriter textUri(Object o)
                  throws IOException

Same as text(Object) but treats the value as a URL to resolved then serialized.

Parameters:

o - The object being serialized.

Returns:

This object (for method chaining).

Throws:

IOException

cr

public XmlWriter cr(int depth)
             throws IOException

Description copied from class: SerializerWriter

Performs a carriage return.

Adds a newline and the specified number of tabs (if the useWhitespace setting is enabled) to the output.

Overrides:

cr in class SerializerWriter

Parameters:

depth - The indentation.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

cre

public XmlWriter cre(int depth)
              throws IOException

Description copied from class: SerializerWriter

Performs a carriage return at the end of a line.

Adds a newline and the specified number of tabs (if the useWhitespace setting is enabled) to the output.

Overrides:

cre in class SerializerWriter

Parameters:

depth - The indentation.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

appendln

public XmlWriter appendln(int indent,
                          String text)
                   throws IOException

Description copied from class: SerializerWriter

Writes an indent (if the useWhitespace setting is enabled), followed by text, followed by a newline (if the useWhitespace setting is enabled).

Overrides:

appendln in class SerializerWriter

Parameters:

indent - The number of tabs to indent.

text - The text to write.

Returns:

This object.

Throws:

IOException - If a problem occurred trying to write to the writer.

appendln

public XmlWriter appendln(String text)
                   throws IOException

Description copied from class: SerializerWriter

Writes the specified text followed by a newline (if the useWhitespace setting is enabled).

Overrides:

appendln in class SerializerWriter

Parameters:

text - The text to write.

Returns:

This object.

Throws:

IOException - If a problem occurred trying to write to the writer.

append

public XmlWriter append(int indent,
                        String text)
                 throws IOException

Description copied from class: SerializerWriter

Writes an indent (if the useWhitespace setting is enabled), followed by text.

Overrides:

append in class SerializerWriter

Parameters:

indent - The number of tabs to indent.

text - The text to write.

Returns:

This object.

Throws:

IOException - If a problem occurred trying to write to the writer.

append

public XmlWriter append(int indent,
                        char c)
                 throws IOException

Description copied from class: SerializerWriter

Writes an indent (if the useWhitespace setting is enabled), followed by text.

Overrides:

append in class SerializerWriter

Parameters:

indent - The number of tabs to indent.

c - The character to write.

Returns:

This object.

Throws:

IOException - If a problem occurred trying to write to the writer.

s

public XmlWriter s()
            throws IOException

Description copied from class: SerializerWriter

Adds a whitespace character to the output if the useWhitespace setting is enabled.

Overrides:

s in class SerializerWriter

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

q

public XmlWriter q()
            throws IOException

Description copied from class: SerializerWriter

Adds the quote character specified by the quoteChar setting to the output.

Overrides:

q in class SerializerWriter

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

i

public XmlWriter i(int indent)
            throws IOException

Description copied from class: SerializerWriter

Writes an indent to the writer if the useWhitespace setting is enabled.

Overrides:

i in class SerializerWriter

Parameters:

indent - The number of tabs to indent.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

ie

public XmlWriter ie(int indent)
             throws IOException

Description copied from class: SerializerWriter

Writes an end-of-line indent to the writer if the useWhitespace setting is enabled.

Overrides:

ie in class SerializerWriter

Parameters:

indent - The number of tabs to indent.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

nl

public XmlWriter nl(int indent)
             throws IOException

Description copied from class: SerializerWriter

Writes a newline to the writer if the useWhitespace setting is enabled.

Overrides:

nl in class SerializerWriter

Parameters:

indent - The current indentation level.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

append

public XmlWriter append(Object text)
                 throws IOException

Description copied from class: SerializerWriter

Writes the specified text to the writer.

Overrides:

append in class SerializerWriter

Parameters:

text - The text to write.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

append

public XmlWriter append(String text)
                 throws IOException

Description copied from class: SerializerWriter

Writes the specified text to the writer.

Overrides:

append in class SerializerWriter

Parameters:

text - The text to write.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred trying to write to the writer.

append

public XmlWriter append(char c)
                 throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class SerializerWriter

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object