org.ujorm.tools.xml.model

Class XmlModel

java.lang.Object

org.ujorm.tools.xml.model.XmlModel

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, ApiElement<XmlModel>

Direct Known Subclasses:

XmlElement

public class XmlModel
extends Object
implements ApiElement<XmlModel>, 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();
 

Since:

2.03

See Also:

HtmlElement, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	XmlModel.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
protected String	name Element name

Fields inherited from interface org.ujorm.tools.xml.ApiElement

HIDDEN_NAME

Constructor Summary

Constructors

Constructor and Description
XmlModel(String name)
XmlModel(String name, XmlModel parent) New element with a parent

Method Summary

Modifier and Type	Method and Description
XmlModel	addCDATA(CharSequence charData) Add a character data in CDATA format to XML only.
XmlModel	addComment(CharSequence comment) Add a comment text.
XmlModel	addElement(String name) Create a new XmlModel for a required name and add it to children.
XmlModel	addElement(XmlModel element) Add a child element
protected void	addChild(Object child) Add a child entity
XmlModel	addRawText(Object value) Add an native text with no escaped characters, for example: XML code, JavaScript, CSS styles
XmlModel	addText(Object value) Add a text and escape special character
XmlModel	addTextTemplated(CharSequence template, Object... values) Message template with hight performance.
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
String	getName() Get an element name
XmlModel	setAttribute(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 java.lang.Object

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

Methods inherited from interface org.ujorm.tools.xml.ApiElement

setAttrib

Field Detail

name

@Nullable
protected final String name

Element name

attributes

@Nullable
protected Map<String,Object> attributes

Attributes

children

@Nullable
protected List<Object> children

Child elements with a null items

Constructor Detail

XmlModel

public XmlModel(@Nonnull
                String name)

Parameters:

name - The element name must not be special HTML characters. The null value is intended to build a root of AJAX queries.

XmlModel

public XmlModel(@Nonnull
                String name,
                @Nonnull
                XmlModel parent)

New element with a parent

Method Detail

getName

@Nullable
public String getName()

Description copied from interface: ApiElement

Get an element name

Specified by:

getName in interface ApiElement<XmlModel>

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 XmlModel addElement(@Nonnull
                                          XmlModel 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 XmlModel addElement(@Nonnull
                                    String name)

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

Specified by:

addElement in interface ApiElement<XmlModel>

Parameters:

name - A name of the new XmlElement is required.

Returns:

The new XmlElement!

setAttribute

@Nonnull
public final XmlModel setAttribute(@Nonnull
                                            String name,
                                            @Nullable
                                            Object value)

Set one attribute

Specified by:

setAttribute in interface ApiElement<XmlModel>

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 XmlModel addText(@Nullable
                                       Object value)

Add a text and escape special character

Specified by:

addText in interface ApiElement<XmlModel>

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

addTextTemplated

@Nonnull
public final XmlModel addTextTemplated(@Nullable
                                                CharSequence template,
                                                @Nonnull
                                                Object... values)

Message template with hight performance.

Specified by:

addTextTemplated in interface ApiElement<XmlModel>

Parameters:

template - Message template where parameters are marked by the {} symbol

values - argument values

Returns:

The original builder

addRawText

@Nonnull
public final XmlModel addRawText(@Nullable
                                          Object value)

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

Specified by:

addRawText in interface ApiElement<XmlModel>

Parameters:

value - The null value is ignored.

Returns:

This instance

addComment

@Nonnull
public final XmlModel addComment(@Nullable
                                          CharSequence comment)

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

Specified by:

addComment in interface ApiElement<XmlModel>

Parameters:

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

Returns:

This instance

addCDATA

@Nonnull
public final XmlModel 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 ApiElement<XmlModel>

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()

An empty method

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ApiElement<XmlModel>

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