org.terracotta.context

Interface TreeNode

All Superinterfaces:

WeakIdentityHashMap.Cleanable

public interface TreeNode
extends WeakIdentityHashMap.Cleanable

A context tree node associated with a Java object.

A TreeNode allows access to both the context information associated with a Java object and to information regarding the contexts position within the overall context tree or trees.

Method Summary

Modifier and Type	Method and Description
Set<? extends TreeNode>	getChildren() Returns the immediate children of this context.
ContextElement	getContext() Returns the context information associated with this node.
List<? extends TreeNode>	getPath() Returns the unique rooting path of this context element.
Collection<List<? extends TreeNode>>	getPaths() Returns the complete set of rooting paths for this context element.
String	toTreeString()

Methods inherited from interface org.terracotta.context.WeakIdentityHashMap.Cleanable

clean

Method Detail

getChildren

Set<? extends TreeNode> getChildren()

Returns the immediate children of this context.

Returns:

the context children

getPath

List<? extends TreeNode> getPath()
                          throws IllegalStateException

Returns the unique rooting path of this context element.

If this context element is not connected to a root in any ContextManager instance or is rooted via multiple distinct paths then an IllegalStateException will be thrown.

Returns:

the unique rooting path

Throws:

IllegalStateException - if the context is not uniquely rooted

getPaths

Collection<List<? extends TreeNode>> getPaths()

Returns the complete set of rooting paths for this context element.

Returns:

the set of rooting paths

getContext

ContextElement getContext()

Returns the context information associated with this node.

Returns:

node context information

toTreeString

String toTreeString()