org.ujorm.tools.xml.builder

Class XmlPrinter

java.lang.Object

org.ujorm.tools.xml.AbstractWriter

org.ujorm.tools.xml.builder.XmlPrinter

public class XmlPrinter
extends AbstractWriter

If you need special formatting, overwrite responsible methods.

Since:

1.88

See Also:

XmlBuilder

Field Summary

Fields inherited from class org.ujorm.tools.xml.AbstractWriter

CDATA_BEG, CDATA_END, COMMENT_BEG, COMMENT_END, config, FORMATTER, FORWARD_SLASH, HTML_DOCTYPE, indentationEnabled, NBSP, out, SPACE, XML_2QUOT, XML_AMPERSAND, XML_APOSTROPHE, XML_GT, XML_HEADER, XML_LT

Constructor Summary

Constructors

Constructor and Description
XmlPrinter() Default constructor a zero offset
XmlPrinter(Appendable out) Writer constructor with a zero offset
XmlPrinter(Appendable out, XmlConfig config) A writer constructor

Method Summary

Modifier and Type	Method and Description
XmlBuilder	createElement(String name) Create any element
static XmlPrinter	forHtml() Crete a new instance including a DOCTYPE.
static XmlPrinter	forHtml(Appendable out) Crete a new instance including a DOCTYPE
static <T> XmlPrinter	forHtml(Appendable out, HtmlConfig config) Create XmlPrinter for UTF-8
static XmlPrinter	forHtml(Object httpServletResponse) Create XmlPrinter for UTF-8
static XmlPrinter	forHtml(Object httpServletResponse, HtmlConfig config) Create XmlPrinter for UTF-8.
static XmlPrinter	forHtml(Object httpServletResponse, Charset charset, String indentationSpace, boolean noCache) Create XmlPrinter for UTF-8
static XmlPrinter	forNiceHtml(Appendable out) Crete a new instance including a DOCTYPE
static XmlPrinter	forNiceHtml(Object httpServletResponse) Create XmlPrinter for UTF-8
static XmlPrinter	forNiceXml() Crete a new instance with a formatted output.
static XmlPrinter	forXml() Crete a new instance including a XML_HEADER.
static XmlPrinter	forXml(Appendable out, XmlConfig config) A basic XmlPrinter factory method.
String	toString()
protected void	writeRawValue(Object rawValue, XmlBuilder element) Write the content of an envelope

Methods inherited from class org.ujorm.tools.xml.AbstractWriter

createWriter, getWriter, getWriterEscaped, write, writeNewLine, writeRawValue, writeValue

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlPrinter

public XmlPrinter()

Default constructor a zero offset

XmlPrinter

public XmlPrinter(@Nonnull
                  Appendable out)

Writer constructor with a zero offset

XmlPrinter

public XmlPrinter(@Nonnull
                  Appendable out,
                  @Nullable
                  XmlConfig config)

A writer constructor

Parameters:

out - A writer

config - A configuration object

Method Detail

writeRawValue

protected void writeRawValue(@Nonnull
                             Object rawValue,
                             @Nonnull
                             XmlBuilder element)
                      throws IOException

Write the content of an envelope

Parameters:

rawValue - A raw value to print

element - An original element

Throws:

IOException

toString

@Nonnull
public String toString()

Overrides:

toString in class AbstractWriter

createElement

public XmlBuilder createElement(@Nonnull
                                String name)
                         throws IOException

Create any element

Throws:

IOException

forXml

public static XmlPrinter forXml()

Crete a new instance including a XML_HEADER. The result provides a method toString()

forNiceXml

public static XmlPrinter forNiceXml()

Crete a new instance with a formatted output. The result provides a method toString()

Returns:

New instance of the XmlPrinter

forXml

public static XmlPrinter forXml(@Nullable
                                Appendable out,
                                @Nonnull
                                XmlConfig config)

A basic XmlPrinter factory method. The result provides a method toString()

Returns:

New instance of the XmlPrinter

forHtml

public static XmlPrinter forHtml()

Crete a new instance including a DOCTYPE. The result provides a method toString()

forHtml

public static XmlPrinter forHtml(Appendable out)

Crete a new instance including a DOCTYPE

forNiceHtml

public static XmlPrinter forNiceHtml(Appendable out)

Crete a new instance including a DOCTYPE

forHtml

public static XmlPrinter forHtml(@Nonnull
                                 Object httpServletResponse)
                          throws IOException

Create XmlPrinter for UTF-8

Throws:

IOException

forNiceHtml

public static XmlPrinter forNiceHtml(@Nonnull
                                     Object httpServletResponse)
                              throws IOException

Create XmlPrinter for UTF-8

Throws:

IOException

forHtml

public static <T> XmlPrinter forHtml(@Nullable
                                     Appendable out,
                                     @Nonnull
                                     HtmlConfig config)

Create XmlPrinter for UTF-8

forHtml

public static XmlPrinter forHtml(@Nonnull
                                 Object httpServletResponse,
                                 @Nonnull
                                 Charset charset,
                                 @Nonnull
                                 String indentationSpace,
                                 boolean noCache)
                          throws IOException

Create XmlPrinter for UTF-8

Throws:

IOException

forHtml

public static XmlPrinter forHtml(@Nonnull
                                 Object httpServletResponse,
                                 @Nonnull
                                 HtmlConfig config)
                          throws IOException

Create XmlPrinter for UTF-8. The basic HTML factory.

Throws:

IOException