org.rvpf.base.xml

Class XMLElement

Object

XMLElement

Direct Known Subclasses:

DocumentElement

@NotThreadSafe
public class XMLElement
extends Object

XML element.

Instances of this class are not thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XMLElement.Factory Factory.
static interface	XMLElement.Handler Handler.

Constructor Summary

Constructors

Constructor and Description
XMLElement(String name) Constructs an instance.
XMLElement(String name, Object... contents) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
XMLElement	addChild(String name) Adds a child.
void	addChild(XMLElement child) Adds a child.
void	addText(String text) Adds the element's text.
boolean	containsAttribute(String name) Asks if this element contains a specified attribute.
XMLElement	copy() Creates a copy of this element.
protected void	disownChildren() Disowns the children.
boolean	equals(Object other)
static String	escape(CharSequence text, char quote) Escapes protected characters.
int	getAttributeCount() Gets the attributes count.
List<XMLAttribute>	getAttributes() Gets the element's attributes.
Optional<String>	getAttributeValue(String name, Optional<String> defaultValue) Gets an attribute's value by its name.
XMLElement	getChild(int index) Gets the element's child at an index.
int	getChildCount() Gets the child count.
Set<? extends String>	getChildNames() Gets the element's child names.
List<? extends XMLElement>	getChildren() Gets the element's children.
List<? extends XMLElement>	getChildren(String name) Gets the element's children with a specific name.
XMLElement.Factory	getFactory() Gets the xml element factory.
Optional<XMLElement>	getFirstChild(String name) Gets the first child element with a specific name.
String	getName() Gets this element's name.
Optional<? extends XMLElement>	getParent() Gets the parent.
String	getPath() Gets the path.
String	getText() Gets the element's text.
int	hashCode()
boolean	isNameEmpty() Asks if the name is empty.
void	removeAttribute(String attributeName) Removes an element's attribute.
void	setAttribute(String attributeName, boolean attributeValue) Sets an element's attribute.
void	setAttribute(String attributeName, Optional<String> attributeValue) Sets an element's attribute.
void	setAttribute(String attributeName, String attributeValue) Sets an element's attribute.
void	setAttribute(XMLAttribute attribute) Sets an element's attribute.
void	setName(String elementName) Sets the element's name.
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XMLElement

public XMLElement(@Nonnull
                  String name)

Constructs an instance.

Note: this constructor is needed by some script langauges.

Parameters:

name - The element's name.

XMLElement

public XMLElement(@Nonnull
                  String name,
                  @Nonnull
                  Object... contents)

Constructs an instance.

Parameters:

name - The element's name.

contents - The element's contents.

Method Detail

escape

@Nonnull
 @CheckReturnValue
public static String escape(@Nonnull
                                                          CharSequence text,
                                                          char quote)

Escapes protected characters.

Parameters:

text - The source text.

quote - The quote character ('"', '\'' or '\0').

Returns:

The encoded text.

addChild

@Nonnull
public XMLElement addChild(@Nonnull
                                     String name)

Adds a child.

Parameters:

name - The name of the child.

Returns:

The newly created child.

addChild

public void addChild(@Nonnull
                     XMLElement child)

Adds a child.

Parameters:

child - The child.

addText

public final void addText(@Nonnull
                          String text)

Adds the element's text.

Parameters:

text - Some text.

containsAttribute

@CheckReturnValue
public boolean containsAttribute(@Nonnull
                                                    String name)

Asks if this element contains a specified attribute.

Parameters:

name - The name of the attribute.

Returns:

True if the attribute is present.

copy

@Nonnull
 @CheckReturnValue
public XMLElement copy()

Creates a copy of this element.

Returns:

The copy.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getAttributeCount

@CheckReturnValue
public final int getAttributeCount()

Gets the attributes count.

Returns:

The attribute count.

getAttributeValue

@Nonnull
 @CheckReturnValue
public Optional<String> getAttributeValue(@Nonnull
                                                                        String name,
                                                                        @Nonnull
                                                                        Optional<String> defaultValue)

Gets an attribute's value by its name.

Parameters:

name - The name of the attribute.

defaultValue - The value to return if the attribute is not present.

Returns:

The value of the attribute or its default.

getAttributes

@Nonnull
 @CheckReturnValue
public final List<XMLAttribute> getAttributes()

Gets the element's attributes.

Returns:

The element's attributes.

getChild

@Nonnull
 @CheckReturnValue
public XMLElement getChild(int index)

Gets the element's child at an index.

Parameters:

index - An origin 0 index;

Returns:

The element's child.

getChildCount

@CheckReturnValue
public final int getChildCount()

Gets the child count.

Returns:

The child count.

getChildNames

@Nonnull
 @CheckReturnValue
public Set<? extends String> getChildNames()

Gets the element's child names.

Returns:

The child names.

getChildren

@Nonnull
 @CheckReturnValue
public List<? extends XMLElement> getChildren()

Gets the element's children.

Returns:

The element's children.

getChildren

@Nonnull
 @CheckReturnValue
public List<? extends XMLElement> getChildren(@Nonnull
                                                                            String name)

Gets the element's children with a specific name.

Parameters:

name - The children's name.

Returns:

The element's children.

getFactory

@Nonnull
 @CheckReturnValue
public XMLElement.Factory getFactory()

Gets the xml element factory.

Returns:

The xml element factory.

getFirstChild

@Nonnull
 @CheckReturnValue
public final Optional<XMLElement> getFirstChild(@Nonnull
                                                                              String name)

Gets the first child element with a specific name.

Parameters:

name - The child name.

Returns:

The optional child element.

getName

@Nonnull
 @CheckReturnValue
public final String getName()

Gets this element's name.

Returns:

The element's name.

getParent

@Nonnull
 @CheckReturnValue
public final Optional<? extends XMLElement> getParent()

Gets the parent.

Returns:

The parent (empty if this is the root).

getPath

@Nonnull
 @CheckReturnValue
public final String getPath()

Gets the path.

Returns:

The path.

getText

@Nonnull
 @CheckReturnValue
public String getText()

Gets the element's text.

Returns:

The element's text.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isNameEmpty

@CheckReturnValue
public final boolean isNameEmpty()

Asks if the name is empty.

Returns:

True if the name is empty.

removeAttribute

public final void removeAttribute(@Nonnull
                                  String attributeName)

Removes an element's attribute.

Parameters:

attributeName - The attribute name.

setAttribute

public final void setAttribute(@Nonnull
                               XMLAttribute attribute)

Sets an element's attribute.

Parameters:

attribute - The attribute.

setAttribute

public final void setAttribute(@Nonnull
                               String attributeName,
                               boolean attributeValue)

Sets an element's attribute.

Parameters:

attributeName - The attribute name.

attributeValue - The attribute value.

setAttribute

public final void setAttribute(@Nonnull
                               String attributeName,
                               @Nonnull
                               Optional<String> attributeValue)

Sets an element's attribute.

Parameters:

attributeName - The attribute name.

attributeValue - The attribute value (empty means remove).

setAttribute

public final void setAttribute(@Nonnull
                               String attributeName,
                               @Nonnull
                               String attributeValue)

Sets an element's attribute.

Parameters:

attributeName - The attribute name.

attributeValue - The attribute value.

setName

public final void setName(@Nonnull
                          String elementName)

Sets the element's name.

Parameters:

elementName - The element's name.

toString

public final String toString()

Overrides:

toString in class Object

disownChildren

protected final void disownChildren()

Disowns the children.