Module org.tquadrat.foundation.xml

Package org.tquadrat.foundation.xml.parse

Class AdvancedContentHandler.Element

java.lang.Object

org.tquadrat.foundation.xml.parse.AdvancedContentHandler.Element

Enclosing class:

AdvancedContentHandler

@ClassVersion(sourceVersion="$Id: AdvancedContentHandler.java 1101 2024-02-18 00:18:48Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
protected static final class AdvancedContentHandler.Element
extends Object

This class serves a container for the name, the data and the attributes of an XML element.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: AdvancedContentHandler.java 1101 2024-02-18 00:18:48Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.xml.parse.AdvancedContentHandler.Element"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,Attribute>	m_Attributes	The attributes.
private final StringBuilder	m_Data	The data.
private final String	m_LocalName	The element's local name.
private final Optional<AdvancedContentHandler.Element>	m_Parent	The parent for this element.
private final String	m_Path	The path to the element.
private final String	m_QName	The element's qualified name.
private final URI	m_URI	The namespace for this element; if null, the qualified name and the local name are the same.

Constructor Summary

Constructors

Constructor	Description
Element(String qName, String localName, URI uri, Map<String,Attribute> attributes, String path, AdvancedContentHandler.Element parent)	Create a new object of this class from an element's name and its attributes.

Method Summary

Modifier and Type	Method	Description
final void	appendData(char[] characters, int start, int end)	Adds another data chunk to the data block for the current element.
final Map<String,Attribute>	getAttributes()	Returns the attributes of the element.
final String	getData()	Returns the data block for this element.
final String	getLocalName()	Returns the local name of the element.
final Optional<AdvancedContentHandler.Element>	getParent()	Returns the parent element.
final String	getPath()	Returns to XML path to this element.
final String	getPrefix()	Returns the prefix from the element's qualified name.
final String	getQName()	Returns the qualified name of the element.
final Optional<URI>	getURI()	Returns the namespace URI of the element.

Methods inherited from class java.lang.Object

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

Field Details

m_Attributes

private final Map<String,Attribute> m_Attributes

The attributes.

m_Data

private final StringBuilder m_Data

The data.

m_LocalName

private final String m_LocalName

The element's local name.

m_Parent

private final Optional<AdvancedContentHandler.Element> m_Parent

The parent for this element.

m_Path

private final String m_Path

The path to the element.

m_QName

private final String m_QName

The element's qualified name.

m_URI

private final URI m_URI

The namespace for this element; if null, the qualified name and the local name are the same.

Constructor Details

Element

Element(String qName,
 String localName,
 URI uri,
 Map<String,Attribute> attributes,
 String path,
 AdvancedContentHandler.Element parent)

Create a new object of this class from an element's name and its attributes.

Parameters:

qName - The element's qualified name.

localName - The element's local name.

uri - The namespace for the element; can be null.

attributes - The element's attributes.

path - The path to the element; this is a string, compiled from the element's name, separated by slashes ("/").

parent - The parent element for this element; may be null.

Method Details

appendData

public final void appendData(char[] characters,
 int start,
 int end)

Adds another data chunk to the data block for the current element.

Parameters:

characters - The characters.

start - The start position inside the characters array.

end - The ending position inside the array.

getAttributes

public final Map<String,Attribute> getAttributes()

Returns the attributes of the element.

Returns:

The attributes.

getData

public final String getData()

Returns the data block for this element.

Returns:

The data block.

getLocalName

public final String getLocalName()

Returns the local name of the element.

Returns:

The local name of the element.

getParent

public final Optional<AdvancedContentHandler.Element> getParent()

Returns the parent element.

Returns:

An instance of Optional that holds the parent element; will be empty if this element does not have a parent.

getPath

public final String getPath()

Returns to XML path to this element.

Returns:

The element's path.

getPrefix

public final String getPrefix()

Returns the prefix from the element's qualified name.

Returns:

The prefix; if there is no prefix, the empty String will be returned.

getQName

public final String getQName()

Returns the qualified name of the element.

Returns:

The qualified name of the element.

getURI

public final Optional<URI> getURI()

Returns the namespace URI of the element.

Returns:

An instance of Optional that holds the namespace URI of the element.