org.apache.juneau.html

Class HtmlWriter

java.lang.Object

java.io.Writer

org.apache.juneau.serializer.SerializerWriter

org.apache.juneau.xml.XmlWriter

org.apache.juneau.html.HtmlWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

SimpleHtmlWriter

public class HtmlWriter
extends XmlWriter

Specialized writer for serializing HTML.

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
HtmlWriter(Writer out, boolean useWhitespace, int maxIndent, boolean trimStrings, char quoteChar, UriResolver uriResolver) Constructor.

Method Summary

Modifier and Type	Method and Description
HtmlWriter	append(char c)
HtmlWriter	append(int indent, char c) Writes an indent (if the useWhitespace setting is enabled), followed by text.
HtmlWriter	append(int indent, String text) Writes an indent (if the useWhitespace setting is enabled), followed by text.
HtmlWriter	append(Object text) Writes the specified text to the writer.
HtmlWriter	append(String text) Writes the specified text to the writer.
HtmlWriter	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).
HtmlWriter	appendln(String text) Writes the specified text followed by a newline (if the useWhitespace setting is enabled).
HtmlWriter	attr(String name, Object value) Shortcut for attr(null, name, value, false);
HtmlWriter	attr(String name, Object value, boolean valNeedsEncoding) Shortcut for attr(null, name, value, false);
HtmlWriter	attr(String ns, String name, Object value) Shortcut for attr(ns, name, value, false);
HtmlWriter	attr(String ns, String name, Object value, boolean valNeedsEncoding) Writes an attribute to the output: ns:name='value'
HtmlWriter	attrUri(String name, Object value) Append an attribute with a URI value.
HtmlWriter	cr(int depth) Performs a carriage return.
HtmlWriter	cre(int depth) Performs a carriage return at the end of a line.
HtmlWriter	eTag(int indent, String name) Shortcut for i(indent).eTag(null, name, false);
HtmlWriter	eTag(int indent, String ns, String name) Shortcut for i(indent).eTag(ns, name, false);
HtmlWriter	eTag(int indent, String ns, String name, boolean needsEncoding) Shortcut for i(indent).eTag(ns, name, needsEncoding);
HtmlWriter	eTag(String name) Shortcut for eTag(null, name, false);
HtmlWriter	eTag(String ns, String name) Shortcut for eTag(ns, name, false);
HtmlWriter	eTag(String ns, String name, boolean needsEncoding) Writes an end tag to the output: </ns:name>
HtmlWriter	i(int indent) Writes an indent to the writer if the useWhitespace setting is enabled.
HtmlWriter	nl(int indent) Writes a newline to the writer if the useWhitespace setting is enabled.
HtmlWriter	oAttr(String ns, String name) Writes an open-ended attribute to the output: ns:name=
HtmlWriter	oTag(int indent, String name) Shortcut for i(indent).oTag(null, name, false);
HtmlWriter	oTag(int indent, String ns, String name) Shortcut for i(indent).oTag(ns, name, false);
HtmlWriter	oTag(int indent, String ns, String name, boolean needsEncoding) Shortcut for i(indent).oTag(ns, name, needsEncoding);
HtmlWriter	oTag(String name) Shortcut for oTag(null, name, false);
HtmlWriter	oTag(String ns, String name) Shortcut for oTag(ns, name, false);
HtmlWriter	oTag(String ns, String name, boolean needsEncoding) Writes an opening tag to the output: <ns:name
HtmlWriter	q() Adds the quote character specified by the quoteChar setting to the output.
HtmlWriter	s() Adds a whitespace character to the output if the useWhitespace setting is enabled.
HtmlWriter	sTag(int indent, String name) Shortcut for i(indent).sTag(null, name, false);
HtmlWriter	sTag(int indent, String ns, String name) Shortcut for i(indent).sTag(ns, name, false);
HtmlWriter	sTag(int indent, String ns, String name, boolean needsEncoding) Shortcut for i(indent).sTag(ns, name, needsEncoding);
HtmlWriter	sTag(String name) Shortcut for sTag(null, name, false);
HtmlWriter	sTag(String ns, String name) Shortcut for sTag(ns, name, false);
HtmlWriter	sTag(String ns, String name, boolean needsEncoding) Writes a start tag to the output: <ns:name>
HtmlWriter	tag(int indent, String name) Shortcut for i(indent).tag(null, name, false);
HtmlWriter	tag(int indent, String ns, String name) Shortcut for i(indent).tag(ns, name, false);
HtmlWriter	tag(int indent, String ns, String name, boolean needsEncoding) Shortcut for i(indent).tag(ns, name, needsEncoding);
HtmlWriter	tag(String name) Shortcut for tag(null, name, false);
HtmlWriter	tag(String ns, String name) Shortcut for tag(ns, name, false);
HtmlWriter	tag(String ns, String name, boolean needsEncoding) Writes a closed tag to the output: <ns:name/>
HtmlWriter	text(Object o, boolean preserveWhitespace) Serializes and encodes the specified object as valid XML text.

Methods inherited from class org.apache.juneau.xml.XmlWriter

attr, attrUri, attrUri, ceTag, cTag, ie, oAttr, text, textUri, 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

HtmlWriter

public HtmlWriter(Writer out,
                  boolean useWhitespace,
                  int maxIndent,
                  boolean trimStrings,
                  char quoteChar,
                  UriResolver uriResolver)

Constructor.

Parameters:

out - The writer being wrapped.

useWhitespace - If true, tabs will be used in output.

maxIndent - The maximum indentation level.

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

quoteChar - The quote character to use (i.e. '\'' or '"')

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

Method Detail

attrUri

public HtmlWriter attrUri(String name,
                          Object value)
                   throws IOException

Append an attribute with a URI value.

Parameters:

name - The attribute name.

value - The attribute value. Can be any object whose toString() method returns a URI.

Returns:

This object (for method chaining);

Throws:

IOException - If a problem occurred.

text

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

Description copied from class: XmlWriter

Serializes and encodes the specified object as valid XML text.

Overrides:

text in class XmlWriter

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

oTag

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

Description copied from class: XmlWriter

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

Overrides:

oTag in class XmlWriter

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 HtmlWriter oTag(String ns,
                       String name)
                throws IOException

Description copied from class: XmlWriter

Shortcut for oTag(ns, name, false);

Overrides:

oTag in class XmlWriter

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 HtmlWriter oTag(String name)
                throws IOException

Description copied from class: XmlWriter

Shortcut for oTag(null, name, false);

Overrides:

oTag in class XmlWriter

Parameters:

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

oTag

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

Description copied from class: XmlWriter

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

Overrides:

oTag in class XmlWriter

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 HtmlWriter oTag(int indent,
                       String ns,
                       String name)
                throws IOException

Description copied from class: XmlWriter

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

Overrides:

oTag in class XmlWriter

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 HtmlWriter oTag(int indent,
                       String name)
                throws IOException

Description copied from class: XmlWriter

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

Overrides:

oTag in class XmlWriter

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 HtmlWriter tag(String ns,
                      String name,
                      boolean needsEncoding)
               throws IOException

Description copied from class: XmlWriter

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

Overrides:

tag in class XmlWriter

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 HtmlWriter tag(String ns,
                      String name)
               throws IOException

Description copied from class: XmlWriter

Shortcut for tag(ns, name, false);

Overrides:

tag in class XmlWriter

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 HtmlWriter tag(String name)
               throws IOException

Description copied from class: XmlWriter

Shortcut for tag(null, name, false);

Overrides:

tag in class XmlWriter

Parameters:

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

tag

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

Description copied from class: XmlWriter

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

Overrides:

tag in class XmlWriter

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 HtmlWriter tag(int indent,
                      String ns,
                      String name,
                      boolean needsEncoding)
               throws IOException

Description copied from class: XmlWriter

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

Overrides:

tag in class XmlWriter

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 HtmlWriter tag(int indent,
                      String ns,
                      String name)
               throws IOException

Description copied from class: XmlWriter

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

Overrides:

tag in class XmlWriter

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 HtmlWriter sTag(String ns,
                       String name)
                throws IOException

Description copied from class: XmlWriter

Shortcut for sTag(ns, name, false);

Overrides:

sTag in class XmlWriter

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 HtmlWriter sTag(String ns,
                       String name,
                       boolean needsEncoding)
                throws IOException

Description copied from class: XmlWriter

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

Overrides:

sTag in class XmlWriter

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 HtmlWriter sTag(int indent,
                       String ns,
                       String name)
                throws IOException

Description copied from class: XmlWriter

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

Overrides:

sTag in class XmlWriter

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 HtmlWriter sTag(int indent,
                       String name)
                throws IOException

Description copied from class: XmlWriter

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

Overrides:

sTag in class XmlWriter

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.

sTag

public HtmlWriter sTag(String name)
                throws IOException

Description copied from class: XmlWriter

Shortcut for sTag(null, name, false);

Overrides:

sTag in class XmlWriter

Parameters:

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

sTag

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

Description copied from class: XmlWriter

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

Overrides:

sTag in class XmlWriter

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 HtmlWriter eTag(String ns,
                       String name)
                throws IOException

Description copied from class: XmlWriter

Shortcut for eTag(ns, name, false);

Overrides:

eTag in class XmlWriter

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 HtmlWriter eTag(String ns,
                       String name,
                       boolean needsEncoding)
                throws IOException

Description copied from class: XmlWriter

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

Overrides:

eTag in class XmlWriter

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 HtmlWriter eTag(int indent,
                       String ns,
                       String name)
                throws IOException

Description copied from class: XmlWriter

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

Overrides:

eTag in class XmlWriter

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 HtmlWriter eTag(int indent,
                       String name)
                throws IOException

Description copied from class: XmlWriter

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

Overrides:

eTag in class XmlWriter

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 HtmlWriter eTag(String name)
                throws IOException

Description copied from class: XmlWriter

Shortcut for eTag(null, name, false);

Overrides:

eTag in class XmlWriter

Parameters:

name - The element name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

eTag

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

Description copied from class: XmlWriter

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

Overrides:

eTag in class XmlWriter

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.

attr

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

Description copied from class: XmlWriter

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

Overrides:

attr in class XmlWriter

Parameters:

name - The attribute name.

value - The attribute value.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

attr

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

Description copied from class: XmlWriter

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

Overrides:

attr in class XmlWriter

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 HtmlWriter attr(String ns,
                       String name,
                       Object value,
                       boolean valNeedsEncoding)
                throws IOException

Description copied from class: XmlWriter

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

Overrides:

attr in class XmlWriter

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 HtmlWriter attr(String name,
                       Object value,
                       boolean valNeedsEncoding)
                throws IOException

Description copied from class: XmlWriter

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

Overrides:

attr in class XmlWriter

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.

oAttr

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

Description copied from class: XmlWriter

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

Overrides:

oAttr in class XmlWriter

Parameters:

ns - The namespace. Can be null.

name - The attribute name.

Returns:

This object (for method chaining).

Throws:

IOException - If a problem occurred.

cr

public HtmlWriter 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 XmlWriter

Parameters:

depth - The indentation.

Returns:

This object (for method chaining).

Throws:

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

cre

public HtmlWriter 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 XmlWriter

Parameters:

depth - The indentation.

Returns:

This object (for method chaining).

Throws:

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

appendln

public HtmlWriter 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 XmlWriter

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 HtmlWriter 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 XmlWriter

Parameters:

text - The text to write.

Returns:

This object.

Throws:

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

append

public HtmlWriter 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 XmlWriter

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 HtmlWriter 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 XmlWriter

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 HtmlWriter 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 XmlWriter

Returns:

This object (for method chaining).

Throws:

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

q

public HtmlWriter q()
             throws IOException

Description copied from class: SerializerWriter

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

Overrides:

q in class XmlWriter

Returns:

This object (for method chaining).

Throws:

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

i

public HtmlWriter 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 XmlWriter

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 HtmlWriter 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 XmlWriter

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 HtmlWriter append(Object text)
                  throws IOException

Description copied from class: SerializerWriter

Writes the specified text to the writer.

Overrides:

append in class XmlWriter

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 HtmlWriter append(String text)
                  throws IOException

Description copied from class: SerializerWriter

Writes the specified text to the writer.

Overrides:

append in class XmlWriter

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 HtmlWriter append(char c)
                  throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class XmlWriter

Throws:

IOException