org.ujorm.tools.dom

Class XmlElement

java.lang.Object

org.ujorm.tools.dom.XmlElement

All Implemented Interfaces:

Element

Direct Known Subclasses:

HtmlElement

public class XmlElement
extends Object
implements Element

XML element model to rendering a XML file. 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:

  XmlElement root = new XmlElement("root");
  root.addElement("childA")
          .addAttrib("x", 1)
          .addAttrib("y", 2);
  root.addElement("childB")
          .addAttrib("x", 3)
          .addAttrib("y", 4)
          .addText("A text message <&\">");
  root.addRawText("\n<rawXml/>\n");
  root.addCDATA("A character data <&\">");
  String result = root.toString();
 

Since:

1.86

See Also:

HtmlElement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	XmlElement.RawEnvelope Raw XML code envelope

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEADER XML header
protected CharSequence	name Element name

Fields inherited from interface org.ujorm.tools.dom.Element

CDATA_BEG, CDATA_END, COMMENT_BEG, COMMENT_END, CHAR_NEW_LINE, CHAR_SPACE, XML_2QUOT, XML_AMP, XML_GT, XML_LT, XML_QUOT

Constructor Summary

Constructors

Constructor and Description
XmlElement(CharSequence name) The new element constructor
XmlElement(CharSequence name, XmlElement parent) New element with a parent

Method Summary

Modifier and Type	Method and Description
<T extends Element> T	addAttrib(CharSequence name, Object value) Add an attribute
<T extends Element> T	addCDATA(CharSequence charData) Add a character data in CDATA format to XML only.
<T extends Element> T	addComment(CharSequence comment) Add a comment text.
<T extends Element> T	addElement(CharSequence name) Create a new XmlElement for a required name and add it to children.
<T extends Element> T	addElement(T element) Add a child element
<T extends Element> T	addRawText(CharSequence rawText) Add an native text with no escaped characters, for example: XML code, JavaScript, CSS styles
<T extends Element> T	addText(CharSequence text) Add a text and escape special character
<T extends Element> T	addTextWithSpace(CharSequence text) Add a text including a space (before and after the text)
protected Map<String,Object>	getAttribs() Return attributes
protected List<Object>	getChildren() Return child entities
String	toString() Render the XML code including header
Writer	toWriter(Writer out) Render the XML code without header
protected void	writeValue(Object value, boolean attribute, Writer out) Write escaped value to the output

Methods inherited from class java.lang.Object

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

Field Detail

HEADER

public static final String HEADER

XML header

See Also:

Constant Field Values

name

@Nonnull
protected final CharSequence name

Element name

Constructor Detail

XmlElement

public XmlElement(@Nonnull
                  CharSequence name)

The new element constructor

Parameters:

name - The parameter must not be empty or contain any special HTML characters.

XmlElement

public XmlElement(@Nonnull
                  CharSequence name,
                  @Nonnull
                  XmlElement parent)

New element with a parent

Method Detail

getAttribs

@Nonnull
protected Map<String,Object> getAttribs()

Return attributes

getChildren

@Nonnull
protected List<Object> getChildren()

Return child entities

addElement

@Nonnull
public final <T extends Element> T addElement(@Nonnull
                                                       T element)

Add a child element

Specified by:

addElement in interface Element

Parameters:

element - Add a child element is required. An undefined argument is ignored.

Returns:

The argument type of XmlElement!

addElement

@Nonnull
public final <T extends Element> T addElement(@Nonnull
                                                       CharSequence name)

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

Specified by:

addElement in interface Element

Parameters:

name - A name of the new XmlElement is requred.

Returns:

The new XmlElement!

addAttrib

@Nonnull
public final <T extends Element> T addAttrib(@Nonnull
                                                      CharSequence name,
                                                      @Nullable
                                                      Object value)

Add an attribute

Specified by:

addAttrib in interface Element

Parameters:

name - Required element name

value - The null value is ignored.

Returns:

The original element

addText

@Nonnull
public final <T extends Element> T addText(@Nullable
                                                    CharSequence text)

Add a text and escape special character

Specified by:

addText in interface Element

Parameters:

text - text An empty argument is ignored.

Returns:

This instance

addTextWithSpace

@Nonnull
public final <T extends Element> T addTextWithSpace(@Nullable
                                                             CharSequence text)

Add a text including a space (before and after the text)

Specified by:

addTextWithSpace in interface Element

Parameters:

text - text An empty argument is ignored.

Returns:

This instance

addRawText

@Nonnull
public final <T extends Element> T addRawText(@Nullable
                                                       CharSequence rawText)

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

Specified by:

addRawText in interface Element

Parameters:

rawText - text An empty argument is ignored.

Returns:

This instance

addComment

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

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

Specified by:

addComment in interface Element

Parameters:

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

Returns:

This instance

addCDATA

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

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

Specified by:

addCDATA in interface Element

Parameters:

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

Returns:

This instance

writeValue

protected void writeValue(@Nonnull
                          Object value,
                          boolean attribute,
                          @Nonnull
                          Writer out)
                   throws IOException

Write escaped value to the output

Parameters:

value - A value

attribute - Render the value to an element attribute, or a text

out - An output writer

Throws:

IOException

toString

@Nonnull
public String toString()

Render the XML code including header

Overrides:

toString in class Object

toWriter

@Nonnull
public Writer toWriter(@Nonnull
                                Writer out)
                         throws IOException

Render the XML code without header

Specified by:

toWriter in interface Element

Throws:

IOException