org.ujorm.tools.xml

Interface ApiElement<E extends ApiElement<?>>

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractElement, Element, HtmlElement, XmlBuilder, XmlElement, XmlModel

public interface ApiElement<E extends ApiElement<?>>
extends Closeable

An element model API. The XmlElement class implements the Closeable implementation for an optional highlighting the tree structure in the source code.

Since:

1.86

See Also:

HtmlElement

Field Summary

Fields

Modifier and Type	Field and Description
static String	HIDDEN_NAME A name of a hidden element

Method Summary

Modifier and Type	Method and Description
E	addCDATA(CharSequence charData) Add a character data in CDATA format to XML only.
E	addComment(CharSequence comment) Add a comment text.
E	addElement(String name) Create a new XmlElement for a required name and add it to children.
E	addRawText(Object value) Add an native text with no escaped characters, for example: XML code, JavaScript, CSS styles
E	addText(Object value) Add a text and escape special character
E	addTextTemplated(CharSequence template, Object... values) Message template
void	close() Close the element
String	getName() Get an element name
default E	setAttrib(String name, Object value) Deprecated. Call a method setAttribute(java.lang.String, java.lang.Object) rather.
E	setAttribute(String name, Object value) Set an attribute

Field Detail

HIDDEN_NAME

@Nullable
static final String HIDDEN_NAME

A name of a hidden element

Method Detail

getName

@Nonnull
String getName()

Get an element name

addElement

@Nonnull
E addElement(@Nonnull
                      String name)

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

Parameters:

name - A name of the new XmlElement is required.

Returns:

The new XmlElement!

setAttribute

@Nonnull
E setAttribute(@Nonnull
                        String name,
                        @Nullable
                        Object value)

Set an attribute

Parameters:

name - Required element name

value - The null value is silently 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

setAttrib

@Deprecated
 @Nonnull
default E setAttrib(@Nonnull
                                          String name,
                                          @Nullable
                                          Object value)

Deprecated. Call a method setAttribute(java.lang.String, java.lang.Object) rather.

addText

@Nonnull
E addText(@Nullable
                   Object value)

Add a text and escape special character

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
E addTextTemplated(@Nullable
                            CharSequence template,
                            @Nonnull
                            Object... values)

Message template

Parameters:

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

values - argument values

Returns:

The original builder

addRawText

@Nonnull
E addRawText(@Nullable
                      Object value)

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

Parameters:

value - The null value is ignored.

Returns:

This instance

addComment

@Nonnull
E 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
E 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

close

void close()

Close the element

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable