Package cdc.util.data

Class Element

java.lang.Object

cdc.util.data.AbstractChild

cdc.util.data.Element

All Implemented Interfaces:

Child, Node, Parent

public final class Element
extends AbstractChild
implements Parent

XML like Element node.

It has a name, can have children (elements, comments or texts).
It can also have attributes.

Author:

Damien Carbonne

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Comparator<Element>	NAME_COMPARATOR	A comparator of elements using their names.

Fields inherited from interface cdc.util.data.Node

ANY_NODE, ELEMENT_NAME_AND_ATTRIBUTES_COMPARATOR, ELEMENT_NAME_COMPARATOR, IS_COMMENT, IS_ELEMENT, IS_IGNORABLE_TEXT, IS_PURE_ELEMENT, IS_TEXT

Constructor Summary

Constructors

Constructor	Description
Element(Element other)	Creates an element by cloning another one.
Element(Parent parent, java.lang.String name)	Creates an element.
Element(java.lang.String name)	Creates an element.

Method Summary

Modifier and Type	Method	Description
void	addAttribute(Attribute attribute)	Adds an attribute.
void	addAttribute(java.lang.String name, boolean value)	Adds a boolean attribute.
void	addAttribute(java.lang.String name, byte value)	Adds a byte attribute.
void	addAttribute(java.lang.String name, double value)	Adds a double attribute.
void	addAttribute(java.lang.String name, float value)	Adds a float attribute.
void	addAttribute(java.lang.String name, int value)	Adds an int attribute.
void	addAttribute(java.lang.String name, long value)	Adds a long attribute.
void	addAttribute(java.lang.String name, short value)	Adds a short attribute.
void	addAttribute(java.lang.String name, java.lang.Object value)	Adds an object attribute.
void	addAttribute(java.lang.String name, java.lang.String value)	Adds a string attribute.
void	addAttributes(Attribute... attributes)	Adds an array of attributes to this element.
void	addAttributes(java.util.Collection<Attribute> attributes)	Adds all attributes of a collection to this element.
Text	addText(java.lang.String content)	Adds a text as last child.
Text	addText(java.lang.String content, boolean merge)	Adds a text as last child.
boolean	canAddChild(Child child)	Returns true when a child can be added.
void	changeAttributeValue(java.lang.String name, java.util.function.Function<java.lang.String,java.lang.String> modifier)	Changes the value of attributes that have a given name.
void	changeAttributeValue(java.lang.String name, java.util.function.Function<java.lang.String,java.lang.String> modifier, boolean recurse)	Changes the value of attributes that have a given name.
void	changeName(java.util.function.Function<java.lang.String,java.lang.String> modifier)	Changes the element name.
void	changeName(java.util.function.Function<java.lang.String,java.lang.String> modifier, boolean recurse)	Changes element names recursively.
Element	clone(boolean recurse)	Return a clone of this node.
static java.util.Comparator<Element>	compareAttribute(java.lang.String attributeName)	Returns a comparator that compares the values of a particular attribute.
static java.util.Comparator<Element>	compareNameAndAttribute(java.lang.String attributeName)	Returns a comparator that compares the names then the values of a particular attribute.
boolean	deepEquals(Node node)	Return true when this node and its descendants equals other node hierarchy.
Attribute	getAttribute(java.lang.String name)	Returns the attribute that has a particular name, or null.
boolean	getAttributeAsBoolean(java.lang.String name, boolean def)	Returns the value associated to an attribute as a boolean or a default value.
byte	getAttributeAsByte(java.lang.String name, byte def)	Returns the value associated to an attribute as a byte.
double	getAttributeAsDouble(java.lang.String name, double def)	Returns the value associated to an attribute as a double.
<E extends java.lang.Enum<E>> E	getAttributeAsEnum(java.lang.String name, java.lang.Class<E> enumClass, E def)	Returns the value associated to an attribute as an enum.
float	getAttributeAsFloat(java.lang.String name, float def)	Returns the value associated to an attribute as a float.
int	getAttributeAsInt(java.lang.String name, int def)	Returns the value associated to an attribute as an int.
long	getAttributeAsLong(java.lang.String name, long def)	Returns the value associated to an attribute as a long.
java.lang.Boolean	getAttributeAsOptionalBoolean(java.lang.String name, java.lang.Boolean def)	Returns the value associated to an attribute as a Boolean or a default value.
java.lang.Byte	getAttributeAsOptionalByte(java.lang.String name, java.lang.Byte def)	Returns the value associated to an attribute as a Byte.
java.lang.Double	getAttributeAsOptionalDouble(java.lang.String name, java.lang.Double def)	Returns the value associated to an attribute as a Double.
<E extends java.lang.Enum<E>> E	getAttributeAsOptionalEnum(java.lang.String name, java.lang.Class<E> enumClass, E def)
java.lang.Float	getAttributeAsOptionalFloat(java.lang.String name, java.lang.Float def)	Returns the value associated to an attribute as a Float.
java.lang.Integer	getAttributeAsOptionalInt(java.lang.String name, java.lang.Integer def)	Returns the value associated to an attribute as an Integer.
java.lang.Long	getAttributeAsOptionalLong(java.lang.String name, java.lang.Long def)	Returns the value associated to an attribute as a Long.
java.lang.Enum<?>	getAttributeAsOptionalRawEnum(java.lang.String name, java.lang.Class<? extends java.lang.Enum<?>> enumClass, java.lang.Enum<?> def)
java.lang.Short	getAttributeAsOptionalShort(java.lang.String name, java.lang.Short def)	Returns the value associated to an attribute as a Short.
java.lang.Enum<?>	getAttributeAsRawEnum(java.lang.String name, java.lang.Class<? extends java.lang.Enum<?>> enumClass, java.lang.Enum<?> def)
short	getAttributeAsShort(java.lang.String name, short def)	Returns the value associated to an attribute as a short.
Attribute	getAttributeAt(int index)	Returns the attribute at a given index.
int	getAttributeIndex(java.lang.String name)	Returns the index of the attribute that has a particular name or -1.
java.util.List<Attribute>	getAttributes()
int	getAttributesCount()
java.lang.String	getAttributeValue(java.lang.String name)	Returns the value associated to an attribute as a string or null.
java.lang.String	getAttributeValue(java.lang.String name, java.lang.String def)	Returns the value associated to an attribute as a string or a default value.
java.lang.String	getAttributeValue(java.lang.String name, java.lang.String def, cdc.util.lang.FailureReaction missingReaction)	Returns the value associated to an attribute.
java.util.List<Child>	getChildren()
ElementContentType	getContentType()
java.lang.String	getElementNamedText(java.lang.String name)	Returns the text content of the first child element that has a given name.
java.lang.String	getElementNamedText(java.lang.String name, java.lang.String def)	Returns the text content of the first child element that has a given name.
java.util.List<Child>	getModifiableChildren()
java.lang.String	getName()
java.lang.String	getQName()
java.util.List<Attribute>	getSortedAttributes()
java.lang.String	getText()	Returns the merged content of all children text nodes, if this node has no element children.
java.lang.String	getText(java.lang.String def)	Returns the merged content of all children text nodes, if this node has no element children.
boolean	getTextAsBoolean(boolean def)
byte	getTextAsByte(byte def)
double	getTextAsDouble(double def)
<E extends java.lang.Enum<E>> E	getTextAsEnum(java.lang.Class<E> enumClass, E def)
float	getTextAsFloat(float def)
int	getTextAsInt(int def)
long	getTextAsLong(long def)
java.lang.Boolean	getTextAsOptionalBoolean(java.lang.Boolean def)
java.lang.Byte	getTextAsOptionalByte(java.lang.Byte def)
java.lang.Double	getTextAsOptionalDouble(java.lang.Double def)
<E extends java.lang.Enum<E>> E	getTextAsOptionalEnum(java.lang.Class<E> enumClass, E def)
java.lang.Float	getTextAsOptionalFloat(java.lang.Float def)
java.lang.Integer	getTextAsOptionalInt(java.lang.Integer def)
java.lang.Long	getTextAsOptionalLong(java.lang.Long def)
java.lang.Short	getTextAsOptionalShort(java.lang.Short def)
short	getTextAsShort(short def)
NodeType	getType()
boolean	hasAttribute(java.lang.String name)	Returns true when an attribute with a particular name exists.
static java.util.function.Predicate<Node>	hasAttribute(java.lang.String attributeName, java.lang.String attributeValue)	Creates a Predicate that accepts Nodes that are elements that have an attribute with a given value.
boolean	hasAttributes()
boolean	hasOnlyNonText()
boolean	hasOnlyText()
boolean	isEmpty()
boolean	isMixed()
boolean	isPure()
boolean	isRoot()
static java.util.function.Predicate<Node>	matching(java.util.Set<SPath> paths)
static java.util.function.Predicate<Node>	named(java.lang.String name)	Creates a Predicate that accepts Nodes that are element with a given name.
static java.util.function.Predicate<Node>	named(java.lang.String... names)	Creates a Predicate that accepts Nodes that are element whose named belongs to an array.
static java.util.function.Predicate<Node>	named(java.util.Set<java.lang.String> names)	Creates a Predicate that accepts Nodes that are element whose named belongs to a set.
static java.util.function.Predicate<Node>	namedIgnoreCase(java.lang.String name)	Creates a Predicate that accepts Nodes that are element with a given name, ignoring case.
static java.util.function.Predicate<Node>	namedWithAttribute(java.lang.String name, java.lang.String attributeName, java.lang.String attributeValue)	Creates a Predicate that accepts Nodes that are elements with a given name and have an attribute with a given value.
Attribute	removeAttribute(java.lang.String name)	Removes an attribute identified by its name.
void	removeAttributes()	Remove all attributes of this element.
void	removeAttributes(java.util.function.Predicate<Attribute> predicate)
void	removeAttributes(java.util.function.Predicate<Attribute> predicate, boolean recurse)
void	removeAttributesNamed(java.lang.String name)
void	removeAttributesNamed(java.lang.String... names)
void	removeAttributesNamed(java.lang.String name, boolean recurse)
void	removeAttributesNamed(java.util.Set<java.lang.String> names)
void	removeAttributesNamed(java.util.Set<java.lang.String> names, boolean recurse)
void	setName(java.lang.String name)	Sets the name of this element.
java.lang.String	toString()

Methods inherited from class cdc.util.data.AbstractChild

equals, getDocument, getParent, getRootElement, hashCode, resetParent, setParent

Methods inherited from interface cdc.util.data.Child

detach, getIndex, getParent, getRootChild, setIndex

Methods inherited from interface cdc.util.data.Node

getDocument, getNameAndAttributes, getRootElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface cdc.util.data.Parent

addChild, addChildren, addChildren, addComment, addComment, addElement, changeComments, changeComments, changeNamedTexts, changeNamedTexts, changeTexts, changeTexts, getChild, getChild, getChildAt, getChildAt, getChildAt, getChildren, getChildren, getChildrenCount, getChildrenCount, getChildrenCount, getComments, getElementNamed, getElementNamedAt, getElementNamedIgnoreCase, getElementNamedIgnoreCaseAt, getElementNamedWithAttribute, getElements, getElementsNamed, getElementsNamedIgnoreCase, getLastChild, getTexts, hasChildren, hasChildren, hasChildren, hasComments, hasElements, hasTexts, mergeComments, mergeComments, mergeTexts, mergeTexts, removeChild, removeChildAt, removeChildren, removeChildren, removeChildren, removeComments, removeComments, removeElementsNamed, removeElementsNamed, removeIgnorableTexts, removeIgnorableTexts, removeTexts, removeTexts, sortChildren, sortChildren

Field Detail

NAME_COMPARATOR

public static final java.util.Comparator<Element> NAME_COMPARATOR

A comparator of elements using their names.

Constructor Detail

Element

public Element(java.lang.String name)

Creates an element.

Parameters:

name - The element name.

Throws:

java.lang.IllegalArgumentException - When name is invalid.

Element

public Element(Parent parent,
               java.lang.String name)

Creates an element.

Parameters:

parent - The element's parent.

name - The element name.

Throws:

java.lang.IllegalArgumentException - When name is invalid.

java.lang.IllegalStateException - When parent can not not be set.

Element

public Element(Element other)

Creates an element by cloning another one.

Cloning is shallow.
For deep cloning, use clone(boolean).

Parameters:

other - The element to clone.

Method Detail

compareAttribute

public static java.util.Comparator<Element> compareAttribute(java.lang.String attributeName)

Returns a comparator that compares the values of a particular attribute.

Parameters:

attributeName - The name of the attribute to use.

Returns:

A comparator comparing the value of attributes named attributeName.

compareNameAndAttribute

public static java.util.Comparator<Element> compareNameAndAttribute(java.lang.String attributeName)

Returns a comparator that compares the names then the values of a particular attribute.

Parameters:

attributeName - The name of the attribute to use.

Returns:

A comparator that compares the names then the values of attributes named attributeName.

getType

public NodeType getType()

Specified by:

getType in interface Node

Returns:

The node type.

clone

public Element clone(boolean recurse)

Description copied from interface: Node

Return a clone of this node.

Specified by:

clone in interface Child

Specified by:

clone in interface Node

Specified by:

clone in interface Parent

Specified by:

clone in class AbstractChild

Parameters:

recurse - If true, also clone children nodes.

Returns:

A clone of this node, and optionally its children.

deepEquals

public boolean deepEquals(Node node)

Description copied from interface: Node

Return true when this node and its descendants equals other node hierarchy.

Parents are ignored.

Specified by:

deepEquals in interface Node

Parameters:

node - The other node to compare.

Returns:

True when this node and other node have same hierarchies.

getQName

public java.lang.String getQName()

Specified by:

getQName in interface Node

Returns:

A string representation of this node. May be used for debug.

canAddChild

public boolean canAddChild(Child child)

Description copied from interface: Parent

Returns true when a child can be added.

Specified by:

canAddChild in interface Parent

Parameters:

child - The child

Returns:

true when child can be added.

getModifiableChildren

public java.util.List<Child> getModifiableChildren()

Specified by:

getModifiableChildren in interface Parent

getChildren

public java.util.List<Child> getChildren()

Specified by:

getChildren in interface Parent

Returns:

A list of children.

setName

public void setName(java.lang.String name)

Sets the name of this element.

Parameters:

name - The name.

Throws:

java.lang.IllegalArgumentException - When name is invalid.

getName

public java.lang.String getName()

Returns:

the name of this element.

getContentType

public ElementContentType getContentType()

Returns:

The content type of this element.

isEmpty

public boolean isEmpty()

Returns:

true if this element has no children. It may have attributes.

isPure

public boolean isPure()

Returns:

true if this element is empty and has no attributes.

hasOnlyText

public boolean hasOnlyText()

Returns:

true if this element has only text children.

hasOnlyNonText

public boolean hasOnlyNonText()

Returns:

true if this element has only non-text (comments and elements) children.

isMixed

public boolean isMixed()

Returns:

true if this element has text and non-text children.

isRoot

public boolean isRoot()

Returns:

true if this element is a root element.

getAttributes

public java.util.List<Attribute> getAttributes()

Returns:

A list of attributes of this element.

getSortedAttributes

public java.util.List<Attribute> getSortedAttributes()

Returns:

A list of attributes of this element, sorted by names.

getAttributesCount

public int getAttributesCount()

Returns:

The number of attributes of this element.

hasAttributes

public boolean hasAttributes()

Returns:

true if this element has attributes.

getAttributeAt

public Attribute getAttributeAt(int index)

Returns the attribute at a given index.

Parameters:

index - The index.

Returns:

The attribute at index.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of range (index < 0 || index >= getAttributesCount())

hasAttribute

public boolean hasAttribute(java.lang.String name)

Returns true when an attribute with a particular name exists.

Parameters:

name - The name.

Returns:

true when an attribute named name exists.

getAttribute

public Attribute getAttribute(java.lang.String name)

Returns the attribute that has a particular name, or null.

Parameters:

name - The name.

Returns:

The attribute named name or null.

getAttributeIndex

public int getAttributeIndex(java.lang.String name)

Returns the index of the attribute that has a particular name or -1.

Parameters:

name - The name.

Returns:

The index of attribute named name or -1.

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name,
                                          java.lang.String def,
                                          cdc.util.lang.FailureReaction missingReaction)

Returns the value associated to an attribute.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists.

missingReaction - The reaction to adopt when attribute is not found.

Returns:

The value of attribute named name or def.

Throws:

cdc.util.lang.NotFoundException - when attribute is not found and missingReaction is FailureReaction.FAIL.

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name,
                                          java.lang.String def)

Returns the value associated to an attribute as a string or a default value.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists.

Returns:

The value of attribute named name or def.

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name)

Returns the value associated to an attribute as a string or null.

Parameters:

name - The attribute name.

Returns:

The value of attribute named name.

Throws:

cdc.util.lang.NotFoundException - when attribute is not found.

getAttributeAsBoolean

public boolean getAttributeAsBoolean(java.lang.String name,
                                     boolean def)

Returns the value associated to an attribute as a boolean or a default value.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a boolean.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to a boolean, then def is returned and a warning is issued.

getAttributeAsOptionalBoolean

public java.lang.Boolean getAttributeAsOptionalBoolean(java.lang.String name,
                                                       java.lang.Boolean def)

Returns the value associated to an attribute as a Boolean or a default value.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a Boolean.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to a Boolean, then def is returned and a warning is issued.

getAttributeAsLong

public long getAttributeAsLong(java.lang.String name,
                               long def)

Returns the value associated to an attribute as a long.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a long.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to a long, then def is returned and a warning is issued.

getAttributeAsOptionalLong

public java.lang.Long getAttributeAsOptionalLong(java.lang.String name,
                                                 java.lang.Long def)

Returns the value associated to an attribute as a Long.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a Long.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to a Long, then def is returned and a warning is issued.

getAttributeAsInt

public int getAttributeAsInt(java.lang.String name,
                             int def)

Returns the value associated to an attribute as an int.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to an int.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to an int, then def is returned and a warning is issued.

getAttributeAsOptionalInt

public java.lang.Integer getAttributeAsOptionalInt(java.lang.String name,
                                                   java.lang.Integer def)

Returns the value associated to an attribute as an Integer.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to an Integer.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to an Integer, then def is returned and a warning is issued.

getAttributeAsShort

public short getAttributeAsShort(java.lang.String name,
                                 short def)

Returns the value associated to an attribute as a short.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a short.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to a short, then def is returned and a warning is issued.

getAttributeAsOptionalShort

public java.lang.Short getAttributeAsOptionalShort(java.lang.String name,
                                                   java.lang.Short def)

Returns the value associated to an attribute as a Short.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a Short.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to a Short, then def is returned and a warning is issued.

getAttributeAsByte

public byte getAttributeAsByte(java.lang.String name,
                               byte def)

Returns the value associated to an attribute as a byte.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a byte.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to a byte, then def is returned and a warning is issued.

getAttributeAsOptionalByte

public java.lang.Byte getAttributeAsOptionalByte(java.lang.String name,
                                                 java.lang.Byte def)

Returns the value associated to an attribute as a Byte.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a Byte.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to a Byte, then def is returned and a warning is issued.

getAttributeAsDouble

public double getAttributeAsDouble(java.lang.String name,
                                   double def)

Returns the value associated to an attribute as a double.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a double.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to a double, then def is returned and a warning is issued.

getAttributeAsOptionalDouble

public java.lang.Double getAttributeAsOptionalDouble(java.lang.String name,
                                                     java.lang.Double def)

Returns the value associated to an attribute as a Double.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a Double.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to a Double, then def is returned and a warning is issued.

getAttributeAsFloat

public float getAttributeAsFloat(java.lang.String name,
                                 float def)

Returns the value associated to an attribute as a float.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a float.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to a float, then def is returned and a warning is issued.

getAttributeAsOptionalFloat

public java.lang.Float getAttributeAsOptionalFloat(java.lang.String name,
                                                   java.lang.Float def)

Returns the value associated to an attribute as a Float.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a Float.

Returns:

The value of attribute named name or def.
If the attribute exists but its value can not be converted to a Float, then def is returned and a warning is issued.

getAttributeAsRawEnum

public java.lang.Enum<?> getAttributeAsRawEnum(java.lang.String name,
                                               java.lang.Class<? extends java.lang.Enum<?>> enumClass,
                                               java.lang.Enum<?> def)

getAttributeAsOptionalRawEnum

public java.lang.Enum<?> getAttributeAsOptionalRawEnum(java.lang.String name,
                                                       java.lang.Class<? extends java.lang.Enum<?>> enumClass,
                                                       java.lang.Enum<?> def)

getAttributeAsEnum

public <E extends java.lang.Enum<E>> E getAttributeAsEnum(java.lang.String name,
                                                          java.lang.Class<E> enumClass,
                                                          E def)

Returns the value associated to an attribute as an enum.

Type Parameters:

E - The enum type.

Parameters:

name - The attribute name.

enumClass - The enum class.

def - The value to return if no attribute named name exists or if its value can not be converted to an enum.

Returns:

The value of attribute named name or def.

getAttributeAsOptionalEnum

public <E extends java.lang.Enum<E>> E getAttributeAsOptionalEnum(java.lang.String name,
                                                                  java.lang.Class<E> enumClass,
                                                                  E def)

addAttribute

public void addAttribute(Attribute attribute)

Adds an attribute.

Parameters:

attribute - The attribute.

Throws:

java.lang.IllegalArgumentException - When attribute is invalid or another attribute with same name already exists.

addAttributes

public void addAttributes(java.util.Collection<Attribute> attributes)

Adds all attributes of a collection to this element.

Parameters:

attributes - The attributes to add.

Throws:

java.lang.IllegalArgumentException - When one of attributes is invalid or another attribute with same name already exists.

addAttributes

public void addAttributes(Attribute... attributes)

Adds an array of attributes to this element.

Parameters:

attributes - The attributes to add.

Throws:

java.lang.IllegalArgumentException - When one of attributes is invalid or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.Object value)

Adds an object attribute.

The string value is constructed using value.toString().

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is invalid or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.String value)

Adds a string attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is invalid or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         boolean value)

Adds a boolean attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is invalid or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         long value)

Adds a long attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is invalid or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         int value)

Adds an int attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is invalid or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         short value)

Adds a short attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is invalid or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         byte value)

Adds a byte attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is invalid or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         double value)

Adds a double attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is invalid or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         float value)

Adds a float attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is invalid or another attribute with same name already exists.

removeAttribute

public Attribute removeAttribute(java.lang.String name)

Removes an attribute identified by its name.

Parameters:

name - The name of the attribute to remove.

Returns:

The removed attribute or null.

removeAttributes

public void removeAttributes(java.util.function.Predicate<Attribute> predicate)

removeAttributes

public void removeAttributes(java.util.function.Predicate<Attribute> predicate,
                             boolean recurse)

removeAttributesNamed

public void removeAttributesNamed(java.lang.String name)

removeAttributesNamed

public void removeAttributesNamed(java.lang.String name,
                                  boolean recurse)

removeAttributesNamed

public void removeAttributesNamed(java.util.Set<java.lang.String> names)

removeAttributesNamed

public void removeAttributesNamed(java.util.Set<java.lang.String> names,
                                  boolean recurse)

removeAttributesNamed

public void removeAttributesNamed(java.lang.String... names)

removeAttributes

public void removeAttributes()

Remove all attributes of this element.

changeAttributeValue

public void changeAttributeValue(java.lang.String name,
                                 java.util.function.Function<java.lang.String,java.lang.String> modifier)

Changes the value of attributes that have a given name.

Parameters:

name - The attribute name.

modifier - A function that take value and returns new value.

changeAttributeValue

public void changeAttributeValue(java.lang.String name,
                                 java.util.function.Function<java.lang.String,java.lang.String> modifier,
                                 boolean recurse)

Changes the value of attributes that have a given name.

Parameters:

name - The attribute name.

modifier - A function that take value and returns new value.

recurse - If true, then this is applied recursively.

changeName

public void changeName(java.util.function.Function<java.lang.String,java.lang.String> modifier)

Changes the element name.

Parameters:

modifier - A function that take name and returns new name.

changeName

public void changeName(java.util.function.Function<java.lang.String,java.lang.String> modifier,
                       boolean recurse)

Changes element names recursively.

Parameters:

modifier - A function that take name and returns new name.

recurse - If true, then this is applied recursively.

addText

public Text addText(java.lang.String content,
                    boolean merge)

Adds a text as last child.

Parameters:

content - The text content.

merge - If true, then if last child exists and is a text, content is added to this last child.
Otherwise, a text child is created and added to last position.

Returns:

The modified or created text.

addText

public Text addText(java.lang.String content)

Adds a text as last child.

If last child exists and is a text, content is added to this last child.
Otherwise, a text child is created and added to last position.

Parameters:

content - The text content.

Returns:

The modified or created text.

getText

public java.lang.String getText(java.lang.String def)

Returns the merged content of all children text nodes, if this node has no element children.

This will work when this node has only text and comment children.
If it has element children, the default value is returned.

Parameters:

def - The default value.

Returns:

The merged content of children texts (ignoring comments) or def.

getText

public java.lang.String getText()

Returns the merged content of all children text nodes, if this node has no element children.

This will work when this node has only text and comment children.
If it has element children, null is returned.

Returns:

The merged content of children texts (ignoring comments) or null.

getTextAsBoolean

public boolean getTextAsBoolean(boolean def)

getTextAsOptionalBoolean

public java.lang.Boolean getTextAsOptionalBoolean(java.lang.Boolean def)

getTextAsLong

public long getTextAsLong(long def)

getTextAsOptionalLong

public java.lang.Long getTextAsOptionalLong(java.lang.Long def)

getTextAsInt

public int getTextAsInt(int def)

getTextAsOptionalInt

public java.lang.Integer getTextAsOptionalInt(java.lang.Integer def)

getTextAsShort

public short getTextAsShort(short def)

getTextAsOptionalShort

public java.lang.Short getTextAsOptionalShort(java.lang.Short def)

getTextAsByte

public byte getTextAsByte(byte def)

getTextAsOptionalByte

public java.lang.Byte getTextAsOptionalByte(java.lang.Byte def)

getTextAsDouble

public double getTextAsDouble(double def)

getTextAsOptionalDouble

public java.lang.Double getTextAsOptionalDouble(java.lang.Double def)

getTextAsFloat

public float getTextAsFloat(float def)

getTextAsOptionalFloat

public java.lang.Float getTextAsOptionalFloat(java.lang.Float def)

getTextAsEnum

public <E extends java.lang.Enum<E>> E getTextAsEnum(java.lang.Class<E> enumClass,
                                                     E def)

getTextAsOptionalEnum

public <E extends java.lang.Enum<E>> E getTextAsOptionalEnum(java.lang.Class<E> enumClass,
                                                             E def)

getElementNamedText

public java.lang.String getElementNamedText(java.lang.String name,
                                            java.lang.String def)

Returns the text content of the first child element that has a given name.

Parameters:

name - The child name.

def - The default value.

Returns:

The text of the first child named name or def.

getElementNamedText

public java.lang.String getElementNamedText(java.lang.String name)

Returns the text content of the first child element that has a given name.

Parameters:

name - The child name.

Returns:

The text of the first child named name or null.

toString

public java.lang.String toString()

Overrides:

toString in class AbstractChild

named

public static java.util.function.Predicate<Node> named(java.lang.String name)

Creates a Predicate that accepts Nodes that are element with a given name.

Parameters:

name - The name.

Returns:

A new Predicate that accepts Nodes that are elements named name.

named

public static java.util.function.Predicate<Node> named(java.util.Set<java.lang.String> names)

Creates a Predicate that accepts Nodes that are element whose named belongs to a set.

Parameters:

names - The names.

Returns:

A new Predicate that accepts Nodes that are elements whose name belongs to names.

named

public static java.util.function.Predicate<Node> named(java.lang.String... names)

Creates a Predicate that accepts Nodes that are element whose named belongs to an array.

Parameters:

names - The names.

Returns:

A new Predicate that accepts Nodes that are elements whose name belongs to names.

matching

public static java.util.function.Predicate<Node> matching(java.util.Set<SPath> paths)

namedWithAttribute

public static java.util.function.Predicate<Node> namedWithAttribute(java.lang.String name,
                                                                    java.lang.String attributeName,
                                                                    java.lang.String attributeValue)

Creates a Predicate that accepts Nodes that are elements with a given name and have an attribute with a given value.

Parameters:

name - The element name.

attributeName - The attribute name.

attributeValue - The attribute value.

Returns:

A new Predicate that accepts Nodes that are elements named name with an attribute named attributeName and containing attributeValue.

hasAttribute

public static java.util.function.Predicate<Node> hasAttribute(java.lang.String attributeName,
                                                              java.lang.String attributeValue)

Creates a Predicate that accepts Nodes that are elements that have an attribute with a given value.

Parameters:

attributeName - The attribute name.

attributeValue - The attribute value.

Returns:

A new Predicate that accepts Nodes that are elements that have an attribute named attributeName and containing attributeValue.

namedIgnoreCase

public static java.util.function.Predicate<Node> namedIgnoreCase(java.lang.String name)

Creates a Predicate that accepts Nodes that are element with a given name, ignoring case.

Parameters:

name - The name.

Returns:

A new Predicate that accepts Nodes that are elements named name, ignoring case.