org.sodeac.common.typedtree

Class BranchNode<P extends BranchNodeMetaModel,T extends BranchNodeMetaModel>

java.lang.Object

org.sodeac.common.typedtree.Node<P,T>

org.sodeac.common.typedtree.BranchNode<P,T>

Type Parameters:

P - type of parent branch node

T - type of branch node

Direct Known Subclasses:

TypedTreeMetaModel.RootBranchNode

public class BranchNode<P extends BranchNodeMetaModel,T extends BranchNodeMetaModel>
extends Node<P,T>

A branch node is an instance of complex tree node.

Author:

Sebastian Palarus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BranchNode.ModifyListenerContainer
protected static class	BranchNode.NodeContainer

Field Summary

Fields

Modifier and Type	Field and Description
protected BranchNode<?,P>	parentNode
protected TypedTreeMetaModel.RootBranchNode<?,?>	rootNode

Fields inherited from class org.sodeac.common.typedtree.Node

disposed, rootLinked

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BranchNode(TypedTreeMetaModel.RootBranchNode<?,?> rootNode, BranchNode<?,P> parentNode, BranchNode.NodeContainer referencedNodeContainer) Constructor to create new branch node.

Method Summary

Modifier and Type	Method and Description
BranchNode<P,T>	addChildNodeListener(IChildNodeListener<T> listener, INodeType<T,?>... childNodeTypeMask) Add listener to get notified if child leaf nodes are updated , and child branch nodes are removed or created.
<X> BranchNode<P,T>	addChildNodeListener(LeafNodeType<T,X> nodeType, IChildNodeListener.ILeafNodeListener<T,X> listener)
<X extends BranchNodeMetaModel> BranchNode<P,T>	applyToConsumer(BranchNodeType<T,X> nodeType, BiConsumer<BranchNode<P,T>,BranchNode<?,X>> consumer) Applies a child node of requested BranchNodeType to consumer.
<X extends BranchNodeMetaModel> BranchNode<P,T>	applyToConsumer(BranchNodeType<T,X> nodeType, BiConsumer<BranchNode<P,T>,BranchNode<T,X>> ifAbsent, BiConsumer<BranchNode<P,T>,BranchNode<T,X>> ifPresent) Applies a child node of requested BranchNodeType to consumer.
BranchNode<P,T>	applyToConsumer(Consumer<BranchNode<P,T>> consumer) Applies this branch node to a consumer.
<X> BranchNode<P,T>	applyToConsumer(LeafNodeType<? super T,X> nodeType, BiConsumer<BranchNode<P,? super T>,LeafNode<? super T,X>> consumer) Applies a child node of requested LeafNodeType to consumer.
BranchNode<P,T>	applyToConsumerWithReadLock(Consumer<BranchNode<P,T>> consumer) Applies this branch node to a consumer locked by tree's read lock.
BranchNode<P,T>	applyToConsumerWithWriteLock(Consumer<BranchNode<P,T>> consumer) Applies this branch node to a consumer locked by tree's write lock.
<X extends BranchNodeMetaModel> BranchNode<P,T>	clear(BranchNodeListType<T,X> nodeType) Remove all child nodes of requested BranchNodeListType.
BranchNode<P,T>	copyFrom(BranchNode<? extends BranchNodeMetaModel,? extends T> copyFrom)
<X extends BranchNodeMetaModel> BranchNode<T,X>	create(BranchNodeListType<T,X> nodeType) Creates new a child node of requested BranchNodeListType.
<X extends BranchNodeMetaModel> BranchNode<P,T>	create(BranchNodeListType<T,X> nodeType, BiConsumer<BranchNode<P,T>,BranchNode<T,X>> consumer) Creates new a child node of requested BranchNodeListType.
<X extends BranchNodeMetaModel> BranchNode<T,X>	create(BranchNodeType<T,X> nodeType) Creates a new child node of requested BranchNodeType.
<X extends BranchNodeMetaModel> BranchNode<T,X>	create(BranchNodeType<T,X> nodeType, BiConsumer<BranchNode<P,T>,BranchNode<T,X>> consumer) Creates a new child node of requested BranchNodeType.
<X extends BranchNodeMetaModel> BranchNode<P,T>	createIfAbsent(BranchNodeListType<T,X> nodeType, Predicate<BranchNode<T,X>> predicate, BiConsumer<BranchNode<P,T>,BranchNode<T,X>> consumer) Creates a new child node of requested BranchNodeListType, if no item exists matched by predicate.
protected void	disposeNode() Dispose this node and all child nodes.
<X extends BranchNodeMetaModel> BranchNode<T,X>	get(BranchNodeListType<T,X> nodeType, Predicate<BranchNode<T,X>> predicate) Get first matched child node of requested BranchNodeListType.
<X extends BranchNodeMetaModel> BranchNode<T,X>	get(BranchNodeType<T,X> nodeType) Getter for a child node of requested BranchNodeType.
<X> LeafNode<T,X>	get(LeafNodeType<? super T,X> nodeType) Getter for a child node of requested LeafNodeType.
List<BranchNodeListType>	getBranchNodeListTypeList() returns all branch node list types of model
List<BranchNodeType>	getBranchNodeTypeList() returns all branch node types of model
List<LeafNodeType>	getLeafNodeTypeList() returns all leaf node types of model
INodeType<P,T>	getNodeType()
BranchNode<?,P>	getParentNode() Getter for parent node.
TypedTreeMetaModel.RootBranchNode<?,?>	getRootNode() Getter for root node.
<X extends BranchNodeMetaModel> List<BranchNode<T,X>>	getUnmodifiableNodeList(BranchNodeListType<T,X> nodeType) Getter for unmodifiable child node list with all child nodes of requested BranchNodeListType.
<X extends BranchNodeMetaModel> List<BranchNode<T,X>>	getUnmodifiableNodeListSnapshot(BranchNodeListType<T,X> nodeType) Getter for a snapshot of unmodifiable child node list with all child nodes of requested BranchNodeListType.
<X extends BranchNodeMetaModel> List<BranchNode<T,X>>	getUnmodifiableNodeListSnapshot(BranchNodeListType<T,X> nodeType, Predicate<BranchNode<T,X>> predicate) Getter for a snapshot of unmodifiable child node list with filtered child nodes of requested BranchNodeListType.
<X> X	getValue(LeafNodeType<? super T,X> nodeType) Gets a value of the child node of requested LeafNodeType
<X> void	registerForModify(ModelPath<T,X> path, IModifyListener<X> listener)
<X extends BranchNodeMetaModel> boolean	remove(BranchNodeListType<T,X> nodeType, BranchNode<P,T> node) Remove child node of requested BranchNodeListType.
<X extends BranchNodeMetaModel> boolean	remove(BranchNodeListType<T,X> nodeType, int index) Remove child node of requested BranchNodeListType.
<X extends BranchNodeMetaModel> BranchNode<P,T>	remove(BranchNodeType<T,X> nodeType) Removes a child node of requested BranchNodeType.
BranchNode<P,T>	removeChildNodeListener(IChildNodeListener<T> listener) Removes child node listener
<X extends BranchNodeMetaModel> BranchNode<P,T>	setComperator(BranchNodeListType<T,X> nodeType, Comparator<BranchNode<T,X>> comparator) Sets a comparator to sort all child nodes for requested BranchNodeListType.
protected void	setRootLinked(boolean rootLinked)
<X> BranchNode<P,T>	setValue(LeafNodeType<? super T,X> nodeType, X value) Sets a value for the child node of requested LeafNodeType
<X> void	unregisterForModify(ModelPath<T,X> path)

Methods inherited from class org.sodeac.common.typedtree.Node

isDisposed, isRootLinked

Methods inherited from class java.lang.Object

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

Field Detail

rootNode

protected TypedTreeMetaModel.RootBranchNode<?,?> rootNode

parentNode

protected BranchNode<?,P extends BranchNodeMetaModel> parentNode

Constructor Detail

BranchNode

protected BranchNode(TypedTreeMetaModel.RootBranchNode<?,?> rootNode,
                     BranchNode<?,P> parentNode,
                     BranchNode.NodeContainer referencedNodeContainer)

Constructor to create new branch node.

Parameters:

rootNode - root node instance

parentNode - parent node instance

referencedNodeContainer - static type instance defined in model

Method Detail

disposeNode

protected void disposeNode()

Dispose this node and all child nodes.

Specified by:

disposeNode in class Node<P extends BranchNodeMetaModel,T extends BranchNodeMetaModel>

getNodeType

public INodeType<P,T> getNodeType()

Specified by:

getNodeType in class Node<P extends BranchNodeMetaModel,T extends BranchNodeMetaModel>

setRootLinked

protected void setRootLinked(boolean rootLinked)

Overrides:

setRootLinked in class Node<P extends BranchNodeMetaModel,T extends BranchNodeMetaModel>

getRootNode

public TypedTreeMetaModel.RootBranchNode<?,?> getRootNode()

Getter for root node.

Returns:

root node

getParentNode

public BranchNode<?,P> getParentNode()

Getter for parent node.

Returns:

parent node

getLeafNodeTypeList

public List<LeafNodeType> getLeafNodeTypeList()

returns all leaf node types of model

Returns:

all leaf node types of model

getBranchNodeTypeList

public List<BranchNodeType> getBranchNodeTypeList()

returns all branch node types of model

Returns:

all branch node types of model

getBranchNodeListTypeList

public List<BranchNodeListType> getBranchNodeListTypeList()

returns all branch node list types of model

Returns:

all branch node list types of model

applyToConsumer

public BranchNode<P,T> applyToConsumer(Consumer<BranchNode<P,T>> consumer)

Applies this branch node to a consumer.

Parameters:

consumer - consumer to consume this branch node

Returns:

this branch node

applyToConsumerWithReadLock

public BranchNode<P,T> applyToConsumerWithReadLock(Consumer<BranchNode<P,T>> consumer)

Applies this branch node to a consumer locked by tree's read lock.

Parameters:

consumer - consumer to consume this branch node

Returns:

this branch node

applyToConsumerWithWriteLock

public BranchNode<P,T> applyToConsumerWithWriteLock(Consumer<BranchNode<P,T>> consumer)

Applies this branch node to a consumer locked by tree's write lock.

Parameters:

consumer - consumer to consume this branch node

Returns:

this branch node

get

public <X> LeafNode<T,X> get(LeafNodeType<? super T,X> nodeType)

Getter for a child node of requested LeafNodeType.

Parameters:

nodeType - static child node type instance from meta model

Returns:

child node

applyToConsumer

public <X> BranchNode<P,T> applyToConsumer(LeafNodeType<? super T,X> nodeType,
                                           BiConsumer<BranchNode<P,? super T>,LeafNode<? super T,X>> consumer)

Applies a child node of requested LeafNodeType to consumer.

Parameters:

nodeType - static child node type instance from meta model

consumer - consumer to consume child node

Returns:

this branch node

setValue

public <X> BranchNode<P,T> setValue(LeafNodeType<? super T,X> nodeType,
                                    X value)

Sets a value for the child node of requested LeafNodeType

Parameters:

nodeType - static child node type instance from meta model

value - value for child node

Returns:

this branch node

getValue

public <X> X getValue(LeafNodeType<? super T,X> nodeType)

Gets a value of the child node of requested LeafNodeType

Parameters:

nodeType - static child node type instance from meta model

Returns:

node value

applyToConsumer

public <X extends BranchNodeMetaModel> BranchNode<P,T> applyToConsumer(BranchNodeType<T,X> nodeType,
                                                                       BiConsumer<BranchNode<P,T>,BranchNode<?,X>> consumer)

Applies a child node of requested BranchNodeType to consumer.

Parameters:

nodeType - static child node type instance from meta model

consumer - consumer

Returns:

this branch node

applyToConsumer

public <X extends BranchNodeMetaModel> BranchNode<P,T> applyToConsumer(BranchNodeType<T,X> nodeType,
                                                                       BiConsumer<BranchNode<P,T>,BranchNode<T,X>> ifAbsent,
                                                                       BiConsumer<BranchNode<P,T>,BranchNode<T,X>> ifPresent)

Applies a child node of requested BranchNodeType to consumer.

Parameters:

nodeType - static child node type instance from meta model

ifAbsent - consumer to use if the child node does not already exist

ifPresent - consumer to use if the child node already exists

Returns:

this branch node

remove

public <X extends BranchNodeMetaModel> BranchNode<P,T> remove(BranchNodeType<T,X> nodeType)

Removes a child node of requested BranchNodeType.

Parameters:

nodeType - static child node type instance from meta model

Returns:

this branch node

create

public <X extends BranchNodeMetaModel> BranchNode<T,X> create(BranchNodeType<T,X> nodeType)

Creates a new child node of requested BranchNodeType.

Parameters:

nodeType - static child node type instance from meta model

Returns:

new child node

create

public <X extends BranchNodeMetaModel> BranchNode<T,X> create(BranchNodeType<T,X> nodeType,
                                                              BiConsumer<BranchNode<P,T>,BranchNode<T,X>> consumer)

Creates a new child node of requested BranchNodeType.

Parameters:

nodeType - static child node type instance from meta model

consumer - builder to set up the child

Returns:

new child node

get

public <X extends BranchNodeMetaModel> BranchNode<T,X> get(BranchNodeType<T,X> nodeType)

Getter for a child node of requested BranchNodeType. If the child node does not exist and TypedTreeMetaModel.RootBranchNode.setBranchNodeGetterAutoCreate(boolean) was invoked with parameter true, the child node will be created automatically.

Parameters:

nodeType - static child node type instance from meta model

Returns:

child node or null, if child node does not exist and auto-create-mode is off

getUnmodifiableNodeList

public <X extends BranchNodeMetaModel> List<BranchNode<T,X>> getUnmodifiableNodeList(BranchNodeListType<T,X> nodeType)

Getter for unmodifiable child node list with all child nodes of requested BranchNodeListType.

Parameters:

nodeType - static child node type instance from meta model

Returns:

unmodifiable node list

getUnmodifiableNodeListSnapshot

public <X extends BranchNodeMetaModel> List<BranchNode<T,X>> getUnmodifiableNodeListSnapshot(BranchNodeListType<T,X> nodeType)

Getter for a snapshot of unmodifiable child node list with all child nodes of requested BranchNodeListType.

Parameters:

nodeType - static child node type instance from meta model

Returns:

unmodifiable node list snapshot

getUnmodifiableNodeListSnapshot

public <X extends BranchNodeMetaModel> List<BranchNode<T,X>> getUnmodifiableNodeListSnapshot(BranchNodeListType<T,X> nodeType,
                                                                                             Predicate<BranchNode<T,X>> predicate)

Getter for a snapshot of unmodifiable child node list with filtered child nodes of requested BranchNodeListType.

Parameters:

nodeType - static child node type instance from meta model

predicate - filter for snapshot

Returns:

snapshot unmodifiable node list snapshot

setComperator

public <X extends BranchNodeMetaModel> BranchNode<P,T> setComperator(BranchNodeListType<T,X> nodeType,
                                                                     Comparator<BranchNode<T,X>> comparator)

Sets a comparator to sort all child nodes for requested BranchNodeListType.

Parameters:

nodeType - static child node type instance from meta model.

comparator - comparator to apply

Returns:

this branch node

get

public <X extends BranchNodeMetaModel> BranchNode<T,X> get(BranchNodeListType<T,X> nodeType,
                                                           Predicate<BranchNode<T,X>> predicate)

Get first matched child node of requested BranchNodeListType.

Parameters:

nodeType - static child node type instance from meta model

predicate - filter

Returns:

first matched node

create

public <X extends BranchNodeMetaModel> BranchNode<T,X> create(BranchNodeListType<T,X> nodeType)

Creates new a child node of requested BranchNodeListType.

Parameters:

nodeType - type static child node type instance from meta model.

Returns:

new child node

create

public <X extends BranchNodeMetaModel> BranchNode<P,T> create(BranchNodeListType<T,X> nodeType,
                                                              BiConsumer<BranchNode<P,T>,BranchNode<T,X>> consumer)

Creates new a child node of requested BranchNodeListType.

Parameters:

nodeType - static child node type instance from meta model.

consumer - setup new child node

Returns:

this branch node

createIfAbsent

public <X extends BranchNodeMetaModel> BranchNode<P,T> createIfAbsent(BranchNodeListType<T,X> nodeType,
                                                                      Predicate<BranchNode<T,X>> predicate,
                                                                      BiConsumer<BranchNode<P,T>,BranchNode<T,X>> consumer)

Creates a new child node of requested BranchNodeListType, if no item exists matched by predicate.

Parameters:

nodeType - static child node type instance from meta model.

predicate - predicate to test existing items

consumer - setup new child node

Returns:

this child node

remove

public <X extends BranchNodeMetaModel> boolean remove(BranchNodeListType<T,X> nodeType,
                                                      BranchNode<P,T> node)

Remove child node of requested BranchNodeListType.

Parameters:

nodeType - static child node type instance from meta model

node - node instance to remove

Returns:

true, if node successfully removed, otherwise false

clear

public <X extends BranchNodeMetaModel> BranchNode<P,T> clear(BranchNodeListType<T,X> nodeType)

Remove all child nodes of requested BranchNodeListType.

Parameters:

nodeType - static child node type instance from meta model return this branch node

remove

public <X extends BranchNodeMetaModel> boolean remove(BranchNodeListType<T,X> nodeType,
                                                      int index)

Remove child node of requested BranchNodeListType.

Parameters:

nodeType - static child node type instance from meta model

index - position index of child node in list

Returns:

true, if node is successfully removed, otherwise false

removeChildNodeListener

public BranchNode<P,T> removeChildNodeListener(IChildNodeListener<T> listener)

Removes child node listener

Parameters:

listener - listener to remove

Returns:

this branch node

addChildNodeListener

public <X> BranchNode<P,T> addChildNodeListener(LeafNodeType<T,X> nodeType,
                                                IChildNodeListener.ILeafNodeListener<T,X> listener)

addChildNodeListener

public BranchNode<P,T> addChildNodeListener(IChildNodeListener<T> listener,
                                            INodeType<T,?>... childNodeTypeMask)

Add listener to get notified if child leaf nodes are updated , and child branch nodes are removed or created.

Parameters:

listener - listener to register

childNodeTypeMask - affected child node types

Returns:

this branch node

registerForModify

public <X> void registerForModify(ModelPath<T,X> path,
                                  IModifyListener<X> listener)

unregisterForModify

public <X> void unregisterForModify(ModelPath<T,X> path)

copyFrom

public BranchNode<P,T> copyFrom(BranchNode<? extends BranchNodeMetaModel,? extends T> copyFrom)