Package cdc.util.data

Interface Parent

All Superinterfaces:

Node

All Known Implementing Classes:

Document, Element

public interface Parent
extends Node

Interface implemented by nodes that are parents (they have children nodes): Document and Element.

Author:

Damien Carbonne

Field Summary

Fields inherited from interface cdc.util.data.Node

ANY_NODE, IS_COMMENT, IS_ELEMENT, IS_EMPTY_ELEMENT, IS_IGNORABLE_TEXT, IS_TEXT

Method Summary

Modifier and Type	Method	Description
boolean	addChild(Child child)	Add a child to this parent, if possible.
boolean	canAddChild(Child child)	Returns true when a child can be added.
void	clearChildren()	Removes all children.
Parent	clone(boolean recurse)	Return a clone of this node.
void	ensureChildren()
default Child	getChildAt(int index)	Return the child at a given, index or null.
java.util.List<AbstractChild>	getChildren()
default <T extends Node> java.lang.Iterable<T>	getChildren(java.lang.Class<T> childClass)	Returns an Iterable of children that are instance of a given class.
default <T extends Node> java.lang.Iterable<T>	getChildren(java.lang.Class<T> childClass, java.util.function.Predicate<? super T> predicate)	Returns an Iterable of children that are instance of a given class and match a predicate.
default int	getChildrenCount()
default int	getChildrenCount(java.lang.Class<? extends Node> childClass)
default Child	getLastChild()
default boolean	hasChildren(java.lang.Class<? extends Node> childClass)
boolean	removeChild(Child child)	Remove a child.
Child	removeChildAt(int index)	Remove the child located at a given index.
boolean	supportsChildType(NodeType type)	Returns true when this node supports a child of a given type.

Methods inherited from interface cdc.util.data.Node

deepEquals, getDocument, getRootElement, getType

Method Detail

clone

Parent clone(boolean recurse)

Description copied from interface: Node

Return a clone of this node.

Specified by:

clone in interface Node

Parameters:

recurse - If true, also clone children nodes.

Returns:

A clone of this node, and optionally its children.

supportsChildType

boolean supportsChildType(NodeType type)

Returns true when this node supports a child of a given type.

Parameters:

type - The type.

Returns:

true when type is supported for a child.

canAddChild

boolean canAddChild(Child child)

Returns true when a child can be added.

Parameters:

child - The child

Returns:

True when child an be added.

ensureChildren

void ensureChildren()

getChildren

java.util.List<AbstractChild> getChildren()

Returns:

A list of children.

getChildren

default <T extends Node> java.lang.Iterable<T> getChildren(java.lang.Class<T> childClass)

Returns an Iterable of children that are instance of a given class.

Type Parameters:

T - Type of searched children.

Parameters:

childClass - The class of searched children.

Returns:

An Iterable of children that are instance of childClass.

getChildren

default <T extends Node> java.lang.Iterable<T> getChildren(java.lang.Class<T> childClass,
                                                           java.util.function.Predicate<? super T> predicate)

Returns an Iterable of children that are instance of a given class and match a predicate.

Type Parameters:

T - Type of searched children.

Parameters:

childClass - The class of searched children.

predicate - The predicate.

Returns:

An Iterable of children that are instance of childClass and match predicate.

getChildrenCount

default int getChildrenCount()

Returns:

The number of children.

getChildrenCount

default int getChildrenCount(java.lang.Class<? extends Node> childClass)

hasChildren

default boolean hasChildren(java.lang.Class<? extends Node> childClass)

getChildAt

default Child getChildAt(int index)

Return the child at a given, index or null.

Null is returned when index is invalid.

Parameters:

index - The index.

Returns:

The child at index or null.

getLastChild

default Child getLastChild()

Returns:

The last child, if any, or null.

addChild

boolean addChild(Child child)

Add a child to this parent, if possible.

If possible, child current parent is changed to this node.

Parameters:

child - The child.

Returns:

True when the child was added, false otherwise.

removeChild

boolean removeChild(Child child)

Remove a child.

If child is not a child of this parent, then false is returned.

Parameters:

child - The child.

Returns:

true if child was removed, false otherwise.

removeChildAt

Child removeChildAt(int index)

Remove the child located at a given index.

If index is invalid, returns false.

Parameters:

index - The index.

Returns:

true when removal was a success, false otherwise.

clearChildren

void clearChildren()

Removes all children.