Module org.tquadrat.foundation.xml

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

Class Comment

java.lang.Object

org.tquadrat.foundation.xml.builder.internal.Comment

All Implemented Interfaces:

Element

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

This class defines a SGML comment.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.5

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	HYPHEN_REPLACEMENT	The hyphen replacement (escaped).
private Element	m_Parent	The parent element for this comment.
private final String	m_Text	The text.

Constructor Summary

Constructors

Constructor	Description
Comment(CharSequence text)	Creates a new Comment 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_Parent

private Element m_Parent

The parent element for this comment.

m_Text

private final String m_Text

The text.

HYPHEN_REPLACEMENT

private static final String HYPHEN_REPLACEMENT

The hyphen replacement (escaped).

Constructor Details

Comment

public Comment(CharSequence text)

Creates a new Comment object.

Parameters:

text - The text.

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