org.ujorm.tools.xml.builder

Class XmlBuilder

java.lang.Object

org.ujorm.tools.xml.AbstractElement<XmlBuilder>

org.ujorm.tools.xml.builder.XmlBuilder

All Implemented Interfaces:

Closeable, AutoCloseable

public class XmlBuilder
extends AbstractElement<XmlBuilder>

A XML builder. The main benefits are:

• secure building well-formed XML documents by the Java code
• a simple API built on a single XmlElement class
• creating XML components by a subclass is possible
• great performance and small memory footprint

¨

How to use the class:

  XmlPriter writer = XmlPriter.forXml();
  try (XmlBuilder html = new XmlBuilder(Html.HTML, writer)) {
      try (XmlBuilder head = html.addElement(Html.HEAD)) {
          head.addElement(Html.META, Html.A_CHARSET, UTF_8);
          head.addElement(Html.TITLE).addText("Test");
      }
      ry (XmlBuilder body = html.addElement(Html.BODY)) {
          body.addElement(Html.H1).addText("Hello word!");
          body.addElement(Html.DIV).addText(null);
      }
  };
  String result = writer.toString();
 

The XmlElement class implements the Closeable implementation for an optional highlighting the tree structure in the source code.

Since:

1.86

See Also:

HtmlElement

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	REQUIRED_MSG Assertion message template

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

DEFAULT_INTENDATION, HTML_DOCTYPE, name, XML_HEADER

Constructor Summary

Constructors

Modifier	Constructor and Description
	XmlBuilder(CharSequence name, XmlPrinter writer) New element with a parent
	XmlBuilder(CharSequence name, XmlPrinter writer, int level) The new element constructor
protected	XmlBuilder(CharSequence name, XmlPrinter writer, int level, boolean printName) The new element constructor

Method Summary

Modifier and Type	Method and Description
<T extends XmlBuilder> T	addCDATA(CharSequence charData) Deprecated.
<T extends XmlBuilder> T	addComment(CharSequence comment) Deprecated.
<T extends XmlBuilder> T	addElement(String name) Create a new XmlBuilder for a required name and add it to children.
<T extends XmlBuilder> T	addRawText(Object value) Add an native text with no escaped characters, for example: XML code, JavaScript, CSS styles
<T extends XmlBuilder> T	addText(Object value) Add a text and escape special character
void	close() Close the Node
int	getLevel()
XmlPrinter	getWriter() Writer
boolean	isClosed() Is the node closed?
boolean	isFilled()
boolean	isLastText() The last child was a text
protected XmlBuilder	nextChild(XmlBuilder element) Settup states
<T extends XmlBuilder> T	setAttrib(String name, Object value) Add an attribute
String	toString() Render the XML code including header

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

getName

Methods inherited from class java.lang.Object

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

Field Detail

REQUIRED_MSG

protected static final String REQUIRED_MSG

Assertion message template

See Also:

Constant Field Values

Constructor Detail

XmlBuilder

public XmlBuilder(@Nonnull
                  CharSequence name,
                  @Nonnull
                  XmlPrinter writer,
                  int level)
           throws IOException

The new element constructor

Parameters:

name - The element name must not be empty nor special HTML characters.

Throws:

IOException

XmlBuilder

protected XmlBuilder(@Nonnull
                     CharSequence name,
                     @Nonnull
                     XmlPrinter writer,
                     int level,
                     boolean printName)
              throws IOException

The new element constructor

Parameters:

name - The element name must not be empty nor special HTML characters.

writer - A XmlPrinter

level - Level of the Element

printName - Print the element name immediately.

Throws:

IOException

XmlBuilder

public XmlBuilder(@Nonnull
                  CharSequence name,
                  @Nonnull
                  XmlPrinter writer)
           throws IOException

New element with a parent

Throws:

IOException

Method Detail

nextChild

@Nonnull
protected XmlBuilder nextChild(@Nullable
                                        XmlBuilder element)
                                 throws IOException

Settup states

Parameters:

element - A child Node or null value for a text data

Throws:

IOException

addElement

@Nonnull
public final <T extends XmlBuilder> T addElement(@Nonnull
                                                          String name)
                                                   throws IOException

Create a new XmlBuilder for a required name and add it to children.

Specified by:

addElement in class AbstractElement<XmlBuilder>

Parameters:

name - A name of the new XmlElement is required.

Returns:

The new XmlElement!

Throws:

IOException

setAttrib

@Nonnull
public final <T extends XmlBuilder> T setAttrib(@Nonnull
                                                         String name,
                                                         @Nullable
                                                         Object value)
                                                  throws IOException

Add an attribute

Specified by:

setAttrib in class AbstractElement<XmlBuilder>

Parameters:

name - Required element name

value - The null value is ignored. Formatting is performed by the XmlPrinter#writeValue(java.lang.Object, org.ujorm.tools.dom.XmlElement, java.lang.String, java.io.Writer) method, where the default implementation calls a toString() only.

Returns:

The original element

Throws:

IOException

addText

@Nonnull
public final <T extends XmlBuilder> T addText(@Nullable
                                                       Object value)
                                                throws IOException

Add a text and escape special character

Specified by:

addText in class AbstractElement<XmlBuilder>

Parameters:

value - The null value is allowed. Formatting is performed by the XmlPrinter#writeValue(java.lang.Object, org.ujorm.tools.dom.XmlElement, java.lang.String, java.io.Writer) method, where the default implementation calls a toString() only.

Returns:

This instance

Throws:

IOException

addRawText

@Nonnull
public final <T extends XmlBuilder> T addRawText(@Nullable
                                                          Object value)
                                                   throws IOException

Add an native text with no escaped characters, for example: XML code, JavaScript, CSS styles

Specified by:

addRawText in class AbstractElement<XmlBuilder>

Parameters:

value - The null value is ignored.

Returns:

This instance

Throws:

IOException

addComment

@Nonnull
 @Deprecated
public final <T extends XmlBuilder> T addComment(@Nullable
                                                                       CharSequence comment)

Deprecated.

Add a comment text. The CDATA structure isn't really for HTML at all.

Specified by:

addComment in class AbstractElement<XmlBuilder>

Parameters:

comment - A comment text must not contain a string --> .

Returns:

This instance

addCDATA

@Nonnull
 @Deprecated
public final <T extends XmlBuilder> T addCDATA(@Nullable
                                                                     CharSequence charData)

Deprecated.

Add a character data in CDATA format to XML only. The CDATA structure isn't really for HTML at all.

Specified by:

addCDATA in class AbstractElement<XmlBuilder>

Parameters:

charData - A text including the final DATA sequence. An empty argument is ignored.

Returns:

This instance

close

public final void close()
                 throws IOException

Close the Node

Throws:

IOException

isClosed

public boolean isClosed()

Is the node closed?

getLevel

public int getLevel()

isFilled

public boolean isFilled()

isLastText

public boolean isLastText()

The last child was a text

getWriter

public XmlPrinter getWriter()

Writer

toString

@Nonnull
public String toString()

Render the XML code including header

Overrides:

toString in class Object