org.sodeac.common.typedtree

Class TypedTreeMetaModel.RootBranchNode<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

java.lang.Object

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

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

org.sodeac.common.typedtree.TypedTreeMetaModel.RootBranchNode<P,R>

Type Parameters:

P - type of parent model

R - type of root node

All Implemented Interfaces:

ITree<P,R>

Enclosing class:

TypedTreeMetaModel<T extends TypedTreeMetaModel>

public static class TypedTreeMetaModel.RootBranchNode<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>
extends BranchNode<P,R>
implements ITree<P,R>

A root node represents a typed tree

Author:

Sebastian Palarus

Nested Class Summary

Nested classes/interfaces inherited from class org.sodeac.common.typedtree.BranchNode

BranchNode.ModifyListenerContainer, BranchNode.NodeContainer

Field Summary

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

parentNode, rootNode

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

disposed, rootLinked

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RootBranchNode(BranchNodeType<P,R> type, Class<? extends TypedTreeMetaModel<?>> modelClass) Constructor of root node.

Method Summary

Modifier and Type	Method and Description
TypedTreeMetaModel.RootBranchNode<P,R>	addTreeModifyListener(ITreeModifyListener modifyListener) Adds modify listener to tree.
TypedTreeMetaModel.RootBranchNode<P,R>	addTreeModifyListeners(ITreeModifyListener... modifyListeners) Adds modify listeners to tree.
void	dispose() Dispose complete tree.
protected ReentrantReadWriteLock.ReadLock	getReadLock()
protected ReentrantReadWriteLock.WriteLock	getWriteLock()
XMLMarshaller	getXMLMarshaller()
boolean	isBranchNodeApplyToConsumerAutoCreate() Getter for apply-to-consumer-auto-create-option.
boolean	isBranchNodeGetterAutoCreate() Getter for getter-auto-create-option.
boolean	isDisableAllListener()
boolean	isImmutable() Getter for immutable option.
boolean	isSynchronized() Getter for synchronized option
protected long	nextOID() Sequencer for tree's object-ID
protected <C extends INodeType<?,?>,T> void	notifyAfterModify(BranchNode<?,?> parentNode, BranchNode.NodeContainer nodeContainer, T oldValue, T newValue)
protected <C extends INodeType<?,?>,T> boolean	notifyBeforeModify(BranchNode<?,?> parentNode, BranchNode.NodeContainer nodeContainer, T oldValue, T newValue)
TypedTreeMetaModel.RootBranchNode<P,R>	removeTreeModifyListener(ITreeModifyListener modifyListener) Removes modify listener to tree.
TypedTreeMetaModel.RootBranchNode<P,R>	setBranchNodeApplyToConsumerAutoCreate(boolean branchNodeConsumeAutoCreate) Setter for apply-to-consumer-auto-create-option of child nodes.
TypedTreeMetaModel.RootBranchNode<P,R>	setBranchNodeGetterAutoCreate(boolean branchNodeGetterAutoCreate) Setter for getter-auto-create-option.
TypedTreeMetaModel.RootBranchNode<P,R>	setDisableAllListener(boolean disableAllListener)
TypedTreeMetaModel.RootBranchNode<P,R>	setImmutable() Sets tree immutable.
TypedTreeMetaModel.RootBranchNode<P,R>	setSynchronized(boolean nodeSynchronized) Setter for synchronized option.

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

addChildNodeListener, addChildNodeListener, applyToConsumer, applyToConsumer, applyToConsumer, applyToConsumer, applyToConsumerWithReadLock, applyToConsumerWithWriteLock, clear, copyFrom, create, create, create, create, createIfAbsent, disposeNode, get, get, get, getBranchNodeListTypeList, getBranchNodeTypeList, getLeafNodeTypeList, getNodeType, getParentNode, getRootNode, getUnmodifiableNodeList, getUnmodifiableNodeListSnapshot, getUnmodifiableNodeListSnapshot, getValue, registerForModify, remove, remove, remove, removeChildNodeListener, setComperator, setRootLinked, setValue, unregisterForModify

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

Constructor Detail

RootBranchNode

protected RootBranchNode(BranchNodeType<P,R> type,
                         Class<? extends TypedTreeMetaModel<?>> modelClass)

Constructor of root node.

Parameters:

type - static type instance defined in model

Method Detail

getReadLock

protected ReentrantReadWriteLock.ReadLock getReadLock()

getWriteLock

protected ReentrantReadWriteLock.WriteLock getWriteLock()

isDisableAllListener

public boolean isDisableAllListener()

Specified by:

isDisableAllListener in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

setDisableAllListener

public TypedTreeMetaModel.RootBranchNode<P,R> setDisableAllListener(boolean disableAllListener)

Specified by:

setDisableAllListener in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

dispose

public void dispose()

Description copied from interface: ITree

Dispose complete tree.

Specified by:

dispose in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

isSynchronized

public boolean isSynchronized()

Description copied from interface: ITree

Getter for synchronized option

Specified by:

isSynchronized in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

Returns:

true, if access to tree is synchronized, otherwise false

setSynchronized

public TypedTreeMetaModel.RootBranchNode<P,R> setSynchronized(boolean nodeSynchronized)

Description copied from interface: ITree

Setter for synchronized option. This option determines, whether access to tree is synchronized or not.

Specified by:

setSynchronized in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

Parameters:

nodeSynchronized - synchronized option to set

Returns:

root node

isImmutable

public boolean isImmutable()

Description copied from interface: ITree

Getter for immutable option.

Specified by:

isImmutable in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

Returns:

true, if tree is immutable, otherwise false

setImmutable

public TypedTreeMetaModel.RootBranchNode<P,R> setImmutable()

Description copied from interface: ITree

Sets tree immutable. After this the tree structure can not be changed any more.

Specified by:

setImmutable in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

Returns:

root node

isBranchNodeGetterAutoCreate

public boolean isBranchNodeGetterAutoCreate()

Description copied from interface: ITree

Getter for getter-auto-create-option. This option determines, whether BranchNode.get(BranchNodeType) will automatically create child nodes, if requested node is null.

Specified by:

isBranchNodeGetterAutoCreate in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

Returns:

getter-auto-create-option of child nodes

setBranchNodeGetterAutoCreate

public TypedTreeMetaModel.RootBranchNode<P,R> setBranchNodeGetterAutoCreate(boolean branchNodeGetterAutoCreate)

Description copied from interface: ITree

Setter for getter-auto-create-option. This option determines, whether BranchNode.get(BranchNodeType) will automatically create child nodes, if requested node is null.

Specified by:

setBranchNodeGetterAutoCreate in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

Parameters:

branchNodeGetterAutoCreate - getter-auto-create-option of child node

Returns:

root node

isBranchNodeApplyToConsumerAutoCreate

public boolean isBranchNodeApplyToConsumerAutoCreate()

Description copied from interface: ITree

Getter for apply-to-consumer-auto-create-option. This option determines, whether BranchNode.applyToConsumer(BranchNodeType, java.util.function.BiConsumer) and BranchNode.applyToConsumer(BranchNodeType, java.util.function.BiConsumer, java.util.function.BiConsumer) will automatically create child nodes, if requested node is null.

Specified by:

isBranchNodeApplyToConsumerAutoCreate in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

Returns:

apply-to-consumer-auto-create-option

setBranchNodeApplyToConsumerAutoCreate

public TypedTreeMetaModel.RootBranchNode<P,R> setBranchNodeApplyToConsumerAutoCreate(boolean branchNodeConsumeAutoCreate)

Description copied from interface: ITree

Setter for apply-to-consumer-auto-create-option of child nodes. This option determines, whether BranchNode.applyToConsumer(BranchNodeType, java.util.function.BiConsumer) and BranchNode.applyToConsumer(BranchNodeType, java.util.function.BiConsumer, java.util.function.BiConsumer) will automatically create child nodes, if requested node is null.

Specified by:

setBranchNodeApplyToConsumerAutoCreate in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

Parameters:

branchNodeConsumeAutoCreate - apply-to-consumer-auto-create-option of child node

Returns:

root node

nextOID

protected long nextOID()

Sequencer for tree's object-ID

Returns:

next objectId

addTreeModifyListener

public TypedTreeMetaModel.RootBranchNode<P,R> addTreeModifyListener(ITreeModifyListener modifyListener)

Description copied from interface: ITree

Adds modify listener to tree.

Specified by:

addTreeModifyListener in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

Parameters:

modifyListener - modify listener to add

Returns:

root node

addTreeModifyListeners

public TypedTreeMetaModel.RootBranchNode<P,R> addTreeModifyListeners(ITreeModifyListener... modifyListeners)

Description copied from interface: ITree

Adds modify listeners to tree.

Specified by:

addTreeModifyListeners in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

Parameters:

modifyListeners - modify listeners to add

Returns:

root node

removeTreeModifyListener

public TypedTreeMetaModel.RootBranchNode<P,R> removeTreeModifyListener(ITreeModifyListener modifyListener)

Description copied from interface: ITree

Removes modify listener to tree.

Specified by:

removeTreeModifyListener in interface ITree<P extends TypedTreeMetaModel,R extends BranchNodeMetaModel>

Parameters:

modifyListener - modify listeners to remove

Returns:

root node

notifyBeforeModify

protected <C extends INodeType<?,?>,T> boolean notifyBeforeModify(BranchNode<?,?> parentNode,
                                                                  BranchNode.NodeContainer nodeContainer,
                                                                  T oldValue,
                                                                  T newValue)

notifyAfterModify

protected <C extends INodeType<?,?>,T> void notifyAfterModify(BranchNode<?,?> parentNode,
                                                              BranchNode.NodeContainer nodeContainer,
                                                              T oldValue,
                                                              T newValue)

getXMLMarshaller

public XMLMarshaller getXMLMarshaller()