org.ujorm.tools.xml.dom

Class XmlElement

java.lang.Object

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

org.ujorm.tools.xml.dom.XmlElement

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

Direct Known Subclasses:

HtmlElement

public class XmlElement
extends AbstractElement<XmlElement>
implements Serializable

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")
          .setAttrib("x", 1)
          .setAttrib("y", 2);
  root.addElement("childB")
          .setAttrib("x", 3)
          .setAttrib("y", 4)
          .addText("A text message <&\">");
  root.addRawText("\n<rawXml/>\n");
  root.addCDATA("A character data <&\">");
  String result = root.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, Serialized Form

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
protected List<Object>	children Child elements with a null items

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

DEFAULT_INTENDATION, HTML_DOCTYPE, name, REQUIRED_MSG, XML_HEADER

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(String name, Object value) Deprecated. Uset the method setAttrib(java.lang.String, java.lang.Object) instead of
<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(String 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(Object value) Add an native text with no escaped characters, for example: XML code, JavaScript, CSS styles
<T extends XmlElement> T	addText(Object value) Add a text and escape special character
void	close() An empty method
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
<T extends XmlElement> T	setAttrib(String name, Object value) Set one attribute
String	toString() Render the XML code including header
XmlWriter	toWriter(int level, XmlWriter out) Render the XML code without 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

attributes

@Nullable
protected Map<String,Object> attributes

Attributes

children

@Nullable
protected List<Object> children

Child elements with a null items

Constructor Detail

XmlElement

public XmlElement(@Nonnull
                  CharSequence name)

The new element constructor

Parameters:

name - The element name must not be empty nor 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(@Nullable
                                 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 <T extends XmlElement> T addElement(@Nonnull
                                                    String name)

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

Specified by:

addElement in class AbstractElement<XmlElement>

Parameters:

name - A name of the new XmlElement is required.

Returns:

The new XmlElement!

addAttrib

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

Deprecated. Uset the method setAttrib(java.lang.String, java.lang.Object) instead of

Set one attribute

Returns:

The original element

setAttrib

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

Set one attribute

Specified by:

setAttrib in class AbstractElement<XmlElement>

Parameters:

name - Required element name

value - The null value is ignored. Formatting is performed by the XmlWriter#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

addText

@Nonnull
public final <T extends XmlElement> T addText(@Nullable
                                                       Object value)

Add a text and escape special character

Specified by:

addText in class AbstractElement<XmlElement>

Parameters:

value - The null value is allowed. Formatting is performed by the XmlWriter#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

addRawText

@Nonnull
public final <T extends XmlElement> T addRawText(@Nullable
                                                          Object value)

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

Specified by:

addRawText in class AbstractElement<XmlElement>

Parameters:

value - The null value 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.

Specified by:

addComment in class AbstractElement<XmlElement>

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.

Specified by:

addCDATA in class AbstractElement<XmlElement>

Parameters:

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

Returns:

This instance

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

close

public final void close()
                 throws IOException

An empty method

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

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