Module org.tquadrat.foundation.xml

Package org.tquadrat.foundation.xml.builder.internal

Class Text

java.lang.Object

org.tquadrat.foundation.xml.builder.internal.Text

All Implemented Interfaces:

Element

@ClassVersion(sourceVersion="$Id: Text.java 1071 2023-09-30 01:49:32Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.5")
public class Text
extends Object
implements Element

This class defines the plain text that is the content of an SGML element as such an element.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: Text.java 1071 2023-09-30 01:49:32Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.xml.builder.internal.Text"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Function<? super CharSequence,String>	m_EscapeFunction	The escape function.
private final boolean	m_IsBlock	The flag that indicates if this text element is to be treated as a block element.
private Element	m_Parent	The parent element for this comment.
private final CharSequence	m_Text	The text.

Constructor Summary

Constructors

Constructor	Description
Text(CharSequence text, Function<? super CharSequence,String> escapeFunction)	Creates a new Text object.
Text(CharSequence text, Function<? super CharSequence,String> escapeFunction, boolean isBlock)	Creates a new Text object.

Method Summary

Modifier and Type	Method	Description
final String	getElementName()	Returns the name of the element.
final Optional<Element>	getParent()	Returns the parent of this element.
final boolean	isBlock()	Returns the block flag. This flag is used in the conversion of the element into a String; it indicates whether the element is 'inline' (like an HTML <span>) or 'block' (as an HTML <div>).
final <E extends Element> void	setParent(E parent)	Sets the parent for this element.
final String	toString()
final String	toString(int indentationLevel, boolean prettyPrint)	Returns a String representation for this element instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tquadrat.foundation.xml.builder.spi.Element

getAttribute, getAttributes, getChildren, getNamespaces, hasChildren

Field Details

m_EscapeFunction

private final Function<? super CharSequence,String> m_EscapeFunction

The escape function.

m_IsBlock

private final boolean m_IsBlock

The flag that indicates if this text element is to be treated as a block element. This is usually false, but for predefined markup, it can be true.

See Also:

• ChildSupport.addPredefinedMarkup(CharSequence)

m_Parent

private Element m_Parent

The parent element for this comment.

m_Text

private final CharSequence m_Text

The text.

Constructor Details

Text

public Text(CharSequence text,
 Function<? super CharSequence,String> escapeFunction,
 boolean isBlock)

Creates a new Text object.

Parameters:

text - The text.

escapeFunction - The function that is used to escape special characters in the given text according to the target format.

isBlock - The flag that indicates if this text element is to be treated as a block element. This is usually false, but for predefined markup, it can be true.

See Also:

• ChildSupport.addPredefinedMarkup(CharSequence)

Text

public Text(CharSequence text,
 Function<? super CharSequence,String> escapeFunction)

Creates a new Text object.

Parameters:

text - The text.

escapeFunction - The function that is used to escape special characters in the given text according to the target format.

Method Details

getElementName

public final String getElementName()

Returns the name of the element.

Specified by:

getElementName in interface Element

Returns:

The name of the element.

getParent

public final Optional<Element> getParent()

Returns the parent of this element.

Specified by:

getParent in interface Element

Returns:

An instance of Optional that holds the parent.

isBlock

public final boolean isBlock()

Returns the block flag.

This flag is used in the conversion of the element into a String; it indicates whether the element is 'inline' (like an HTML <span>) or 'block' (as an HTML <div>). This is important only for elements where whitespace is relevant, like for HTML elements, as pretty printing will add additional whitespace around inline elements that can become visible on parsing (for HTML: on the rendered page).

XML elements for example will be always block as there whitespace is not that important.

Obviously, true indicates a block element, while false stands for an inline element.

The default is true.

Specified by:

isBlock in interface Element

Returns:

The flag.

setParent

public final <E extends Element> void setParent(E parent)

Sets the parent for this element.

Specified by:

setParent in interface Element

Type Parameters:

E - The implementation of Element.

Parameters:

parent - The parent.

toString

public final String toString(int indentationLevel,
 boolean prettyPrint)

Returns a String representation for this element instance.

Specified by:

toString in interface Element

Parameters:

indentationLevel - The indentation level.

prettyPrint - The pretty print flag.

Returns:

The String representation.

toString

public final String toString()

Overrides:

toString in class Object