org.ujorm.tools.xml.builder

Class XmlPrinter

java.lang.Object

org.ujorm.tools.xml.CommonXmlWriter

org.ujorm.tools.xml.builder.XmlPrinter

public class XmlPrinter
extends CommonXmlWriter

If you need special formatting, overwrite responsible methods.

Since:

1.88

See Also:

XmlBuilder

Field Summary

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

CDATA_BEG, CDATA_END, COMMENT_BEG, COMMENT_END, FORWARD_SLASH, CHAR_NEW_LINE, CHAR_SPACE, indentationEnabled, indentationSpace, out, XML_2QUOT, XML_AMPERSAND, XML_APOSTROPHE, XML_GT, 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, String indentationSpace, T... prefix) A writer constructor

Method Summary

Modifier and Type	Method and Description
XmlBuilder	createElement(String elementName) Create any element
XmlBuilder	createHtmlElement() Create new html element
static XmlPrinter	forHtml() Crete a new instance including a DOCTYPE.
static XmlPrinter	forHtml(Appendable out) Crete a new instance including a DOCTYPE
static XmlPrinter	forHtml(Object httpServletResponse) 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	forXml() Crete a new instance including a XML_HEADER.
static XmlPrinter	forXml(boolean indentation) Crete a new instance with no header.
String	toString()
protected void	writeRawValue(Object rawValue, XmlBuilder element) Write the content of an envelope

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

createWriter, 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
                  String indentationSpace,
                  @Nonnull
                  T... prefix)

A writer constructor

Parameters:

out - A writer

indentationSpace - String for a one level offset.

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 CommonXmlWriter

createHtmlElement

public XmlBuilder createHtmlElement()
                             throws IOException

Create new html element

Throws:

IOException

createElement

public XmlBuilder createElement(@Nonnull
                                String elementName)
                         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()

forXml

public static XmlPrinter forXml(boolean indentation)

Crete a new instance with no header. The result provides a method toString()

Parameters:

indentation - An intendation by four spaces.

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 XmlPrinter forHtml(@Nonnull
                                 Object httpServletResponse,
                                 @Nonnull
                                 Charset charset,
                                 String indentationSpace,
                                 boolean noCache)
                          throws IOException

Create XmlPrinter for UTF-8

Throws:

IOException