-
- Type Parameters:
V- the generic type of the valueT- the generic type of the concrete tree node
- All Superinterfaces:
java.io.Serializable
public interface ITree<V,T> extends java.io.SerializableThe InterfaceITreeholds the children in aCollectionobject
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddChild(T child)Adds the given childvoidaddChildren(@NonNull java.util.Collection<T> children)Adds all the given childrenvoidclearAll()Removes all the descendantsvoidclearChildren()Removes all the childrenbooleancontains(T treeNode)Checks if the givenITreeobject is a descendant of this tree nodebooleancontainsAll(@NonNull java.util.Collection<T> treeNodes)Checks if the givenCollectionobject ofITreeobjects are descendants of this tree nodejava.util.Collection<T>findAllByValue(V value)Find allITreeobjects that have the same value as the given valueTfindByValue(V value)Find allITreeobjects that have the same value as the given valuejava.util.Collection<T>getAllSiblings()Returns all siblings of this node in the parent's children list.intgetChildCount()Gets the child count.java.util.Collection<T>getChildren()Gets the children.java.lang.StringgetDisplayValue()Gets the optional display value.intgetLevel()Returns the distance from the root to this node.TgetNextSibling()Returns the next sibling of this node in the parent's children list.TgetParent()Gets the parent.TgetPreviousSibling()Returns the previous sibling of this node in the parent's children list.TgetRoot()Gets the root objectVgetValue()Gets the value.booleanhasChildren()Checks for children.booleanhasParent()Checks for parentbooleanisLeaf()Checks if is leaf.booleanisNode()Checks if is node.booleanisRoot()voidremoveChild(T child)Removes the child.voidremoveChildren()Removes all the childrenvoidremoveChildren(@NonNull java.util.Collection<T> children)Removes all the given childrenvoidsetChildren(java.util.Collection<T> children)Sets the children.voidsetDisplayValue(java.lang.String displayValue)Sets the optional display value.voidsetLeaf(boolean leaf)Sets the flag that indicates if this tree node is a node or a leafvoidsetParent(T parent)Sets the parent.voidsetValue(V value)Sets the value.java.util.List<T>toList()Traverse this node and adds all descendant with this included in to aListobjectjava.util.Collection<T>traverse()Traverse this node and adds all descendant with this included in to aCollectionobject
-
-
-
Method Detail
-
addChild
void addChild(T child)
Adds the given child- Parameters:
child- the child
-
addChildren
void addChildren(@NonNull @NonNull java.util.Collection<T> children)Adds all the given children- Parameters:
children- the children to add
-
getAllSiblings
java.util.Collection<T> getAllSiblings()
Returns all siblings of this node in the parent's children list. Returns null if this node is the root.- Returns:
- Returns all siblings of this node or null if this node is the root.
-
getPreviousSibling
T getPreviousSibling()
Returns the previous sibling of this node in the parent's children list. Returns null if this node is the root or is the parent's first child.- Returns:
- the next sibling of this node or null if this node is the root or is the parent's last child.
-
getNextSibling
T getNextSibling()
Returns the next sibling of this node in the parent's children list. Returns null if this node is the root or is the parent's last child.- Returns:
- the next sibling of this node or null if this node is the root or is the parent's last child.
-
getChildCount
int getChildCount()
Gets the child count.- Returns:
- the child count
-
getChildren
java.util.Collection<T> getChildren()
Gets the children.- Returns:
- the children
-
setChildren
void setChildren(java.util.Collection<T> children)
Sets the children.- Parameters:
children- the new children
-
getDisplayValue
java.lang.String getDisplayValue()
Gets the optional display value.- Returns:
- the display value
-
setDisplayValue
void setDisplayValue(java.lang.String displayValue)
Sets the optional display value.- Parameters:
displayValue- the new optional display value
-
getLevel
int getLevel()
Returns the distance from the root to this node. Returns 0 if this node is the root.- Returns:
- the level from this node.
-
getParent
T getParent()
Gets the parent.- Returns:
- the parent
-
setParent
void setParent(T parent)
Sets the parent.- Parameters:
parent- the new parent
-
getRoot
T getRoot()
Gets the root object- Returns:
- the root object
-
getValue
V getValue()
Gets the value.- Returns:
- the value
-
setValue
void setValue(V value)
Sets the value.- Parameters:
value- the new value
-
hasChildren
boolean hasChildren()
Checks for children.- Returns:
- true, if successful
-
hasParent
boolean hasParent()
Checks for parent- Returns:
- true, if successful
-
isLeaf
boolean isLeaf()
Checks if is leaf.- Returns:
- true, if is leaf
-
setLeaf
void setLeaf(boolean leaf)
Sets the flag that indicates if this tree node is a node or a leaf- Parameters:
leaf- The flag to set that indicates if this tree node is a node or a leaf
-
isNode
boolean isNode()
Checks if is node.- Returns:
- true, if is node
-
removeChild
void removeChild(T child)
Removes the child.- Parameters:
child- the child
-
clearChildren
void clearChildren()
Removes all the children
-
clearAll
void clearAll()
Removes all the descendants
-
removeChildren
void removeChildren()
Removes all the children
-
removeChildren
void removeChildren(@NonNull @NonNull java.util.Collection<T> children)Removes all the given children- Parameters:
children- the children to remove
-
findAllByValue
java.util.Collection<T> findAllByValue(V value)
Find allITreeobjects that have the same value as the given value- Parameters:
value- the value for the search process- Returns:
- a
Collectionobject with all found occurrences that have the same value as the given value
-
findByValue
T findByValue(@NonNull V value)
Find allITreeobjects that have the same value as the given value- Parameters:
value- the value for the search process- Returns:
- a
Collectionobject with all found occurrences that have the same value as the given value
-
contains
boolean contains(T treeNode)
Checks if the givenITreeobject is a descendant of this tree node- Parameters:
treeNode- the tree node to check- Returns:
- true if the given
ITreeobject is a descendant of this tree node otherwise false
-
containsAll
boolean containsAll(@NonNull @NonNull java.util.Collection<T> treeNodes)Checks if the givenCollectionobject ofITreeobjects are descendants of this tree node- Parameters:
treeNodes- the children to add- Returns:
- true if the given
Collectionobject ofITreeobjects are descendants of this tree node otherwise false
-
toList
java.util.List<T> toList()
Traverse this node and adds all descendant with this included in to aListobject- Returns:
- a
Listobject with this node and add all descendant
-
traverse
java.util.Collection<T> traverse()
Traverse this node and adds all descendant with this included in to aCollectionobject- Returns:
- a
Collectionobject with this node and add all descendant
-
-