org.ujorm.tools.dom

Interface Element

All Known Implementing Classes:

HtmlElement, XmlElement

public interface 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

¨

Since:

1.86

See Also:

XmlElement

Field Summary

Fields

Modifier and Type	Field and Description
static String	CDATA_BEG A CDATA beg markup sequence
static String	CDATA_END A CDATA end markup sequence
static String	COMMENT_BEG A comment beg sequence
static String	COMMENT_END A comment end sequence
static char	CHAR_NEW_LINE A new line character
static char	CHAR_SPACE A special XML character
static char	XML_2QUOT A special XML character
static char	XML_AMP A special XML character
static char	XML_GT A special XML character
static char	XML_LT A special XML character
static char	XML_QUOT A special XML character

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)
Writer	toWriter(Writer out) Render the XML code without header

Field Detail

XML_GT

static final char XML_GT

A special XML character

See Also:

Constant Field Values

XML_LT

static final char XML_LT

A special XML character

See Also:

Constant Field Values

XML_AMP

static final char XML_AMP

A special XML character

See Also:

Constant Field Values

XML_QUOT

static final char XML_QUOT

A special XML character

See Also:

Constant Field Values

XML_2QUOT

static final char XML_2QUOT

A special XML character

See Also:

Constant Field Values

CHAR_SPACE

static final char CHAR_SPACE

A special XML character

See Also:

Constant Field Values

CHAR_NEW_LINE

static final char CHAR_NEW_LINE

A new line character

See Also:

Constant Field Values

CDATA_BEG

static final String CDATA_BEG

A CDATA beg markup sequence

See Also:

Constant Field Values

CDATA_END

static final String CDATA_END

A CDATA end markup sequence

See Also:

Constant Field Values

COMMENT_BEG

static final String COMMENT_BEG

A comment beg sequence

See Also:

Constant Field Values

COMMENT_END

static final String COMMENT_END

A comment end sequence

See Also:

Constant Field Values

Method Detail

addElement

@Nonnull
<T extends Element> 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
<T extends Element> 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
<T extends Element> 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
<T extends Element> 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
<T extends Element> 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
<T extends Element> 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
<T extends Element> 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
<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.

Parameters:

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

Returns:

This instance

toWriter

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

Render the XML code without header

Throws:

IOException