org.vishia.util

Interface TreeNode_ifc<DerivedNode extends TreeNode_ifc<DerivedNode,Data>,Data>

Type Parameters:

DerivedNode - The instance type which is the implementor of this.

Data - The data type which are referred with a that tree node.

All Known Implementing Classes:

TreeNodeBase, TreeNodeBase.MetaNode, TreeNodeBase.TreeNode, XmlNodeSimple

public interface TreeNode_ifc<DerivedNode extends TreeNode_ifc<DerivedNode,Data>,Data>

Interface for instances, which are organized with the TreeNodeBase class. This interface can be used as super interface of an interface of such instances.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	version Version, history and license.

Method Summary

Modifier and Type	Method and Description
void	addNode(DerivedNode childNode)
DerivedNode	addNode(java.lang.String itsKey, Data leaf)
void	addNodeFirst(DerivedNode childNode)
void	addSiblingNext(DerivedNode childNode)
void	detach()
DerivedNode	firstChild()
java.lang.String	getKey()
DerivedNode	getNode(java.lang.String path, java.lang.String separator)
DerivedNode	getOrCreateNode(java.lang.String path, java.lang.String separator)
Data	getParentData()
boolean	hasChildren()
IterableIterator<DerivedNode>	iteratorChildren() Returns an iterator through the list of all children of the node.
IterableIterator<DerivedNode>	iteratorChildren(java.lang.String keyP)
DerivedNode	lastChild()
DerivedNode	nextSibling()
int	nrofChildren()
DerivedNode	parent()
boolean	parentEquals(TreeNode_ifc<DerivedNode,Data> cmpr) Checks whether the parent is a known node.
DerivedNode	prevSibling()
void	removeChildren()

Field Detail

version

static final java.lang.String version

Version, history and license.

• 2017-08-27 Hartmut enhanced: iteratorChildren() for all children in given order
• 2013-11-11 Hartmut created. The class TreeNodeBase was existing already. The reason for this interface:
  • Overview over methods
  • super interface if any tree node has an interface.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

Method Detail

addNode

DerivedNode addNode(java.lang.String itsKey,
                    Data leaf)

addNode

void addNode(DerivedNode childNode)

addNodeFirst

void addNodeFirst(DerivedNode childNode)

addSiblingNext

void addSiblingNext(DerivedNode childNode)

detach

void detach()

removeChildren

void removeChildren()

getKey

java.lang.String getKey()

getParentData

Data getParentData()

getNode

DerivedNode getNode(java.lang.String path,
                    java.lang.String separator)

getOrCreateNode

DerivedNode getOrCreateNode(java.lang.String path,
                            java.lang.String separator)

parent

DerivedNode parent()

parentEquals

boolean parentEquals(TreeNode_ifc<DerivedNode,Data> cmpr)

Checks whether the parent is a known node. This test can be done for example to check whether the parent is the root node. Note that especially the root node may be from another type. Therefore parent() fails because a ClassCastException to the DerivedNode.

Parameters:

cmpr - The node to compare with

Returns:

true if the parent node is the same instance as the given node.

nextSibling

DerivedNode nextSibling()

prevSibling

DerivedNode prevSibling()

hasChildren

boolean hasChildren()

nrofChildren

int nrofChildren()

firstChild

DerivedNode firstChild()

lastChild

DerivedNode lastChild()

iteratorChildren

IterableIterator<DerivedNode> iteratorChildren(java.lang.String keyP)

iteratorChildren

IterableIterator<DerivedNode> iteratorChildren()

Returns an iterator through the list of all children of the node.

Returns:

The iterator or null if there isn't any children.