org.nuiton.jaxx.runtime.swing.tree

Class DefaultIterableTreeNode<O>

java.lang.Object

org.nuiton.jaxx.runtime.swing.tree.DefaultIterableTreeNode<O>

All Implemented Interfaces:

Iterable<IterableTreeNode<?>>, TreeNode, IterableTreeNode<O>

public class DefaultIterableTreeNode<O>
extends Object
implements IterableTreeNode<O>

Default implementation of a IterableTreeNode.

Created by tchemit on 05/01/2018.

Author:

Tony Chemit - dev@tchemit.fr

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuiton.jaxx.runtime.swing.tree.IterableTreeNode

IterableTreeNode.BreadthFirstIterator, IterableTreeNode.PostorderIterator, IterableTreeNode.PreorderIterator

Field Summary

Fields inherited from interface org.nuiton.jaxx.runtime.swing.tree.IterableTreeNode

EMPTY_ITERATOR, STREAM_CHARACTERISTICS

Constructor Summary

Constructors

Constructor and Description
DefaultIterableTreeNode(O userObject, boolean allowsChildren)

Method Summary

Modifier and Type	Method and Description
void	addChild(IterableTreeNode<?> newChild)
Enumeration	children()
boolean	getAllowsChildren()
IterableTreeNode<?>	getChildAt(int childIndex)
int	getChildCount()
int	getIndex(TreeNode node)
IterableTreeNode<?>	getParent()
IterableTreeNode<?>	getRoot()
O	getUserObject()
void	insertChild(IterableTreeNode<?> newChild, int position)
boolean	isEmpty()
boolean	isLeaf()
boolean	isNodeAncestor(IterableTreeNode anotherNode) Returns true if anotherNode is an ancestor of this node -- if it is this node, this node's parent, or an ancestor of this node's parent.
boolean	isRoot()
Iterator<IterableTreeNode<?>>	iterator()
void	removeChild(int index) Remove child at given index.
void	removeChild(IterableTreeNode<?> child) Remove given given child.
void	removeChildren() Removes all of this node's children, setting their parents to null.
void	removeChildren(List<IterableTreeNode<?>> children) Remove given children.
void	setAllowsChildren(boolean allowsChildren)
void	setParent(IterableTreeNode<?> parent)
void	setUserObject(O userObject)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuiton.jaxx.runtime.swing.tree.IterableTreeNode

breadthFirstIterator, postorderIterator, preorderIterator, stream, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DefaultIterableTreeNode

public DefaultIterableTreeNode(O userObject,
                               boolean allowsChildren)

Method Detail

getChildAt

public IterableTreeNode<?> getChildAt(int childIndex)

Specified by:

getChildAt in interface TreeNode

getChildCount

public final int getChildCount()

Specified by:

getChildCount in interface TreeNode

isRoot

public final boolean isRoot()

Specified by:

isRoot in interface IterableTreeNode<O>

getRoot

public IterableTreeNode<?> getRoot()

Specified by:

getRoot in interface IterableTreeNode<O>

getParent

public IterableTreeNode<?> getParent()

Specified by:

getParent in interface TreeNode

Specified by:

getParent in interface IterableTreeNode<O>

setParent

public final void setParent(IterableTreeNode<?> parent)

Specified by:

setParent in interface IterableTreeNode<O>

getIndex

public final int getIndex(TreeNode node)

Specified by:

getIndex in interface TreeNode

getAllowsChildren

public final boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

setAllowsChildren

public final void setAllowsChildren(boolean allowsChildren)

Specified by:

setAllowsChildren in interface IterableTreeNode<O>

isLeaf

public boolean isLeaf()

Specified by:

isLeaf in interface TreeNode

children

public final Enumeration children()

Specified by:

children in interface TreeNode

iterator

public final Iterator<IterableTreeNode<?>> iterator()

Specified by:

iterator in interface Iterable<IterableTreeNode<?>>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface IterableTreeNode<O>

getUserObject

public final O getUserObject()

Specified by:

getUserObject in interface IterableTreeNode<O>

setUserObject

public final void setUserObject(O userObject)

Specified by:

setUserObject in interface IterableTreeNode<O>

addChild

public final void addChild(IterableTreeNode<?> newChild)

Specified by:

addChild in interface IterableTreeNode<O>

insertChild

public final void insertChild(IterableTreeNode<?> newChild,
                              int position)

Specified by:

insertChild in interface IterableTreeNode<O>

removeChild

public final void removeChild(IterableTreeNode<?> child)

Description copied from interface: IterableTreeNode

Remove given given child.

Will throw exception if given child is not a child of this node.

Specified by:

removeChild in interface IterableTreeNode<O>

Parameters:

child - child to remove

removeChild

public final void removeChild(int index)

Description copied from interface: IterableTreeNode

Remove child at given index.

Will throw exception if no child at index.

Specified by:

removeChild in interface IterableTreeNode<O>

Parameters:

index - position of child to remove

removeChildren

public void removeChildren()

Description copied from interface: IterableTreeNode

Removes all of this node's children, setting their parents to null. If this node has no children, this method does nothing.

Specified by:

removeChildren in interface IterableTreeNode<O>

removeChildren

public void removeChildren(List<IterableTreeNode<?>> children)

Description copied from interface: IterableTreeNode

Remove given children. Acts as method IterableTreeNode.removeChild(IterableTreeNode) for each element.

Specified by:

removeChildren in interface IterableTreeNode<O>

Parameters:

children - children to remove

isNodeAncestor

public final boolean isNodeAncestor(IterableTreeNode anotherNode)

Returns true if anotherNode is an ancestor of this node -- if it is this node, this node's parent, or an ancestor of this node's parent. (Note that a node is considered an ancestor of itself.) If anotherNode is null, this method returns false. This operation is at worst O(h) where h is the distance from the root to this node.

Parameters:

anotherNode - node to test as an ancestor of this node

Returns:

true if this node is a descendant of anotherNode