org.ujorm.tools.xml

Class AbstractElement<E extends AbstractElement>

java.lang.Object

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

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

XmlBuilder, XmlElement

public abstract class AbstractElement<E extends AbstractElement>
extends Object
implements Closeable

Abstrac element model. The main benefits are:

Since:

1.86

See Also:

HtmlElement

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_INTENDATION Default intendation have got 4 spaces per level
static String	HTML_DOCTYPE HTML doctype
protected String	name Element name
protected static String	REQUIRED_MSG Assertion message template
static String	XML_HEADER XML header

Constructor Summary

Constructors

Constructor and Description
AbstractElement(CharSequence name) Constructor

Method Summary

Modifier and Type	Method and Description
abstract <T extends E> T	addCDATA(CharSequence charData) Add a character data in CDATA format to XML only.
abstract <T extends E> T	addComment(CharSequence comment) Add a comment text.
abstract <T extends E> T	addElement(String name) Create a new XmlElement for a required name and add it to children.
abstract <T extends E> T	addRawText(Object value) Add an native text with no escaped characters, for example: XML code, JavaScript, CSS styles
abstract <T extends E> T	addText(Object value) Add a text and escape special character
String	getName() Get an element name
abstract <T extends E> T	setAttrib(String name, Object value) Set an attribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Field Detail

XML_HEADER

public static final String XML_HEADER

XML header

See Also:

Constant Field Values

HTML_DOCTYPE

public static final String HTML_DOCTYPE

HTML doctype

See Also:

Constant Field Values

DEFAULT_INTENDATION

public static final String DEFAULT_INTENDATION

Default intendation have got 4 spaces per level

See Also:

Constant Field Values

REQUIRED_MSG

protected static final String REQUIRED_MSG

Assertion message template

See Also:

Constant Field Values

name

@Nonnull
protected final String name

Element name

Constructor Detail

AbstractElement

public AbstractElement(@Nonnull
                       CharSequence name)

Constructor

Method Detail

getName

@Nonnull
public final String getName()

Get an element name

addElement

@Nonnull
public abstract <T extends E> T addElement(@Nonnull
                                                    String name)
                                             throws IOException

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!

Throws:

IOException

setAttrib

@Nonnull
public abstract <T extends E> T setAttrib(@Nonnull
                                                   String name,
                                                   @Nullable
                                                   Object value)
                                            throws IOException

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

Throws:

IOException

addText

@Nonnull
public abstract <T extends E> T addText(@Nullable
                                                 Object value)
                                          throws IOException

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

Throws:

IOException

addRawText

@Nonnull
public abstract <T extends E> T addRawText(@Nullable
                                                    Object value)
                                             throws IOException

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

Throws:

IOException

addComment

@Nonnull
public abstract <T extends E> T addComment(@Nullable
                                                    CharSequence comment)
                                             throws IOException

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

Throws:

IOException

addCDATA

@Nonnull
public abstract <T extends E> T addCDATA(@Nullable
                                                  CharSequence charData)
                                           throws IOException

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

Throws:

IOException