org.ujorm.tools.dom

Class XmlElement

java.lang.Object

org.ujorm.tools.dom.XmlElement

Direct Known Subclasses:

HtmlElement

public class XmlElement
extends Object

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
protected Map<String,Object>	attributes Attributes
static String	HEADER XML header
protected List<Object>	children Child elements
protected CharSequence	name Element name

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 XmlElement> T	addAttrib(CharSequence name, Object value) Add an attribute
<T extends XmlElement> T	addCDATA(CharSequence charData) Add a character data in CDATA format to XML only.
<T extends XmlElement> T	addComment(CharSequence comment) Add a comment text.
<T extends XmlElement> T	addElement(CharSequence name) Create a new XmlElement for a required name and add it to children.
<T extends XmlElement> T	addElement(T element) Add a child element
protected void	addChild(Object child) Add a child entity
<T extends XmlElement> T	addRawText(CharSequence rawText) Add an native text with no escaped characters, for example: XML code, JavaScript, CSS styles
<T extends XmlElement> T	addText(CharSequence text) Add a text and escape special character
<T extends XmlElement> T	addTextWithSpace(CharSequence text) Add a text including a space (before and after the text)
protected Map<String,Object>	getAttribs() Return attributes
Map<String,Object>	getAttributes() Get an unmodifiable map of attributes
List<Object>	getChildren() Get an unmodifiable list of children
String	getName() Get an element name
String	toString() Render the XML code including header
XmlWriter	toWriter(int level, XmlWriter out) Render the XML code without header

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

attributes

@Nullable
protected Map<String,Object> attributes

Attributes

children

@Nullable
protected List<Object> children

Child elements

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

addChild

@Nonnull
protected void addChild(@Nonnull
                                 Object child)

Add a child entity

addElement

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

Add a child 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 XmlElement> T addElement(@Nonnull
                                                          CharSequence name)

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

Parameters:

name - A name of the new XmlElement is requred.

Returns:

The new XmlElement!

addAttrib

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

Add an attribute

Parameters:

name - Required element name

value - The null value is ignored.

Returns:

The original element

addText

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

Add a text and escape special character

Parameters:

text - text An empty argument is ignored.

Returns:

This instance

addTextWithSpace

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

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

Parameters:

text - text An empty argument is ignored.

Returns:

This instance

addRawText

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

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

Parameters:

rawText - text An empty argument is ignored.

Returns:

This instance

addComment

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

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

Parameters:

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

Returns:

This instance

addCDATA

@Nonnull
public final <T extends XmlElement> 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.

Parameters:

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

Returns:

This instance

getName

@Nonnull
public String getName()

Get an element name

getAttributes

@Nonnull
public Map<String,Object> getAttributes()

Get an unmodifiable map of attributes

getChildren

@Nonnull
public List<Object> getChildren()

Get an unmodifiable list of children

toString

@Nonnull
public String toString()

Render the XML code including header

Overrides:

toString in class Object

toWriter

@Nonnull
public XmlWriter toWriter(int level,
                                   @Nonnull
                                   XmlWriter out)
                            throws IOException

Render the XML code without header

Throws:

IOException