ITreeNode.DefaultTreeNode (0opslab-utils 1.0.0 API)

字段
限定符和类型	字段和说明
`protected SortedSet`	`m_children` A `List`of child `ITreeNode` instances.
`protected Object`	`m_userObject` Member for saving the user Object.
`protected boolean`	`marked` Flag for saving the marking-state.

构造器
构造器和说明
`ITreeNode.DefaultTreeNode()` Create a `ITreeNode` without a parent, user Object and m_children.
`ITreeNode.DefaultTreeNode(Object userObject)` Create a `ITreeNode` without a parent that carries the given user Object.
`ITreeNode.DefaultTreeNode(Object userObject, ITreeNode child)` Create a `ITreeNode` without a parent that carries the given user Object and has the given `ITreeNode` as child.
`ITreeNode.DefaultTreeNode(Object userObject, ITreeNode[] children)` Create a `ITreeNode` without a parent that carries the given user Object and has the given `ITreeNode` instances as m_children.

方法
限定符和类型	方法和说明
`ITreeNode`	`addChild(Object userObject)` The given `Object` will be stored in a newly created `ITreeNode` which will get assigned this node to be it's father, while this instance will store the new node in it's list (unconditionally: e.g. no test, if already contained).
`boolean`	`addChildNode(ITreeNode node)` The given `ITreeNode` will become this node to be it's father, while this instance will store the given node in it's list if not null (unconditionally: e.g. no test, if already contained).
`boolean`	`addChildNodes(ITreeNode[] nodes)` Adds all given `ITreeNode` instances to the set of this instances childs.
`ITreeNode[]`	`addChildren(Object[] userObjects)` Adds all given Objects to newly instanciated `ITreeNode` instances that are added to the set of this instances childs.
`int`	`compareTo(ITreeNode o)`
`boolean`	`contains(Object userObject)` Find out, wether a certain "user" Object is carried by any of this `ITreeNodes` subtree.
`boolean`	`containsNode(ITreeNode node)` Find out, wether the given `ITreeNode` is a member of this node's subtree.
`boolean`	`equals(Object obj)` Two instances are equal, if they both are of this type and user objects are equal.
`List`	`getAllChildren()` Get all child nodes of the `ITreeNode`.
`int`	`getChildCount()` Returns the amount of child `ITreeNodes` of this `ITreeNode`.
`Iterator`	`getChilds()` The `Iterator`returned will not traverse the whole subtree but only the direct child nodes of this `ITreeNode`.
`ITreeNode`	`getParent()` Get the parent node of this `ITreeNode`.
`void`	`getPathFromRoot(List l)`
`int`	`getSubtreeCount()` Get the amount of direct and indirect childs of this `ITreeNode`.
`Object`	`getUserObject()` Returns the "user" Object that may be carried by the `ITreeNode`, or null, if no one was assigned.
`void`	`getUserObjectPathFromRoot(List l)`
`boolean`	`isLeaf()` Find out, wether this `ITreeNode` is a childless leaf.
`boolean`	`isMarked()` Check, wether this `ITreeNode` is marked.
`boolean`	`isRoot()` Find out, wether there is no path to a higher parental node from this `ITreeNode`.
`void`	`mark()` Marks this `ITreeNode` instance (e.g. for being visited or invisible).
`ITreeNode`	`newInstance()` Generic operations in default implementations may need to allocate new instances but have to choose the right type to support the provided invariants.
`ITreeNode`	`remove(Object userObject)` The search is a "prefix-search": A / \ B C / \ D E The search will be done in the order: `A,B,D,E,C`.
`List`	`removeAllChildren()` Remove all child nodes of the `ITreeNode`.
`boolean`	`removeChild(ITreeNode node)` Remove the given `ITreeNode` from this node.
`void`	`setParent(ITreeNode parent)` This method should not be called from outside.
`Object`	`setUserObject(Object store)` Assigns the "user" Object that may be carried by the `ITreeNode`.
`String`	`toString()`
`protected void`	`toStringInternal(StringBuffer buf, int depth)`
`void`	`unmark()` Unmarks this `ITreeNode` instance (e.g. for being visited or invisible).

java.lang.Object
- info.monitorenter.cpdetector.util.collections.ITreeNode.DefaultTreeNode

所有已实现的接口:

ITreeNode, Comparable<ITreeNode>

直接已知子类:

TreeNodeUniqueChildren

封闭接口:

ITreeNode
```
public static class ITreeNode.DefaultTreeNode
extends Object
implements ITreeNode, Comparable<ITreeNode>
```
Plain-forward implementation of the ITreeNodeinterface.

This implementation covers many of the algorithms that may be somewhat tricky to implement in an elegant way for beginners. Subclasses may add other policies and constraints to achieve a special invariant with a certain behaviour.
作者:
- 嵌套类概要
  
  从接口继承的嵌套类/接口 info.monitorenter.cpdetector.util.collections.ITreeNode
  ITreeNode.DefaultTreeNode
  
  字段概要
  
  字段
  限定符和类型字段和说明
  
  protected SortedSet m_children
  A Listof child ITreeNode instances.
  
  protected Object m_userObject
  Member for saving the user Object.
  
  protected boolean marked
  Flag for saving the marking-state.
  
  从接口继承的字段 info.monitorenter.cpdetector.util.collections.ITreeNode
  ROOT
  
  构造器概要
  
  构造器
  构造器和说明
  
  ITreeNode.DefaultTreeNode()
  Create a ITreeNode without a parent, user Object and m_children.
  
  ITreeNode.DefaultTreeNode(Object userObject)
  Create a ITreeNode without a parent that carries the given user Object.
  
  ITreeNode.DefaultTreeNode(Object userObject, ITreeNode child)
  Create a ITreeNode without a parent that carries the given user Object and has the given ITreeNode as child.
  
  ITreeNode.DefaultTreeNode(Object userObject, ITreeNode[] children)
  Create a ITreeNode without a parent that carries the given user Object and has the given ITreeNode instances as m_children.
  
  方法概要
  
  方法
  限定符和类型方法和说明
  
  ITreeNode addChild(Object userObject)
  The given Object will be stored in a newly created ITreeNode which will get assigned this node to be it's father, while this instance will store the new node in it's list (unconditionally: e.g. no test, if already contained).
  
  boolean addChildNode(ITreeNode node)
  The given ITreeNode will become this node to be it's father, while this instance will store the given node in it's list if not null (unconditionally: e.g. no test, if already contained).
  
  boolean addChildNodes(ITreeNode[] nodes)
  Adds all given ITreeNode instances to the set of this instances childs.
  
  ITreeNode[] addChildren(Object[] userObjects)
  Adds all given Objects to newly instanciated ITreeNode instances that are added to the set of this instances childs.
  
  int compareTo(ITreeNode o)
  
  boolean contains(Object userObject)
  Find out, wether a certain "user" Object is carried by any of this ITreeNodes subtree.
  
  boolean containsNode(ITreeNode node)
  Find out, wether the given ITreeNode is a member of this node's subtree.
  
  boolean equals(Object obj)
  Two instances are equal, if they both are of this type and user objects are equal.
  
  List getAllChildren()
  Get all child nodes of the ITreeNode.
  
  int getChildCount()
  Returns the amount of child ITreeNodes of this ITreeNode.
  
  Iterator getChilds()
  The Iteratorreturned will not traverse the whole subtree but only the direct child nodes of this ITreeNode.
  
  ITreeNode getParent()
  Get the parent node of this ITreeNode.
  
  void getPathFromRoot(List l)
  
  int getSubtreeCount()
  Get the amount of direct and indirect childs of this ITreeNode.
  
  Object getUserObject()
  Returns the "user" Object that may be carried by the ITreeNode, or null, if no one was assigned.
  
  void getUserObjectPathFromRoot(List l)
  
  boolean isLeaf()
  Find out, wether this ITreeNode is a childless leaf.
  
  boolean isMarked()
  Check, wether this ITreeNode is marked.
  
  boolean isRoot()
  Find out, wether there is no path to a higher parental node from this ITreeNode.
  
  void mark()
  Marks this ITreeNode instance (e.g. for being visited or invisible).
  
  ITreeNode newInstance()
  Generic operations in default implementations may need to allocate new instances but have to choose the right type to support the provided invariants.
  
  ITreeNode remove(Object userObject)
  The search is a "prefix-search": A / \ B C / \ D E The search will be done in the order: A,B,D,E,C.
  
  List removeAllChildren()
  Remove all child nodes of the ITreeNode.
  
  boolean removeChild(ITreeNode node)
  Remove the given ITreeNode from this node.
  
  void setParent(ITreeNode parent)
  This method should not be called from outside.
  
  Object setUserObject(Object store)
  Assigns the "user" Object that may be carried by the ITreeNode.
  
  String toString()
  
  protected void toStringInternal(StringBuffer buf, int depth)
  
  void unmark()
  Unmarks this ITreeNode instance (e.g. for being visited or invisible).
  
  从类继承的方法 java.lang.Object
  clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - marked
```
protected boolean marked
```
    Flag for saving the marking-state. False by default.
  - m_userObject
```
protected Object m_userObject
```
    Member for saving the user Object.
    
    另请参阅:
    getUserObject()
  - m_children
```
protected SortedSet m_children
```
    A Listof child ITreeNode instances.
- 构造器详细资料
  - ITreeNode.DefaultTreeNode
```
public ITreeNode.DefaultTreeNode()
```
    Create a ITreeNode without a parent, user Object and m_children. After this call, this instance will be the root node (no parent).
  - ITreeNode.DefaultTreeNode
```
public ITreeNode.DefaultTreeNode(Object userObject)
```
    Create a ITreeNode without a parent that carries the given user Object.
    
    参数:
    userObject - An Object that is desired to be stored in the node.
  - ITreeNode.DefaultTreeNode
```
public ITreeNode.DefaultTreeNode(Object userObject,
                         ITreeNode child)
```
    Create a ITreeNode without a parent that carries the given user Object and has the given ITreeNode as child.
    
    参数:
    userObject - An Object that is desired to be stored in the node.
    child - The first child of this node.
  - ITreeNode.DefaultTreeNode
```
public ITreeNode.DefaultTreeNode(Object userObject,
                         ITreeNode[] children)
```
    Create a ITreeNode without a parent that carries the given user Object and has the given ITreeNode instances as m_children.
    
    Perhaps the most useful constructor. It allows to construct trees in a short overviewable way:
```
        new DefaultTreeNode(
          new Integer(1),
          new ITreeNode[]{
            new DefaultTreeNode(
              new Integer(2)
            ),
            new DefaultTreeNode(
              new Integer(3),
              new DefaultTreeNode(
                new Integer
              )
            )
        );
 
```
    参数:
    userObject - An Object that is desired to be stored in the node.
    children - An array of ITreeNode instances that will become childs of this node.
- 方法详细资料
  - equals
```
public boolean equals(Object obj)
```
    Two instances are equal, if they both are of this type and user objects are equal.
    
    指定者:
    
    equals 在接口中 ITreeNode
    
    覆盖:
    
    equals 在类中 Object
    
    参数:
    obj - Possibly a ITreeNode that has to be checked for equality.
    
    返回:
    True, if your implementation judges both instances equal.
    另请参阅:
    setUserObject(Object), Object.equals(Object)
  - addChild
```
public final ITreeNode addChild(Object userObject)
```
    The given Object will be stored in a newly created ITreeNode which will get assigned this node to be it's father, while this instance will store the new node in it's list (unconditionally: e.g. no test, if already contained).
    
    指定者:
    
    addChild 在接口中 ITreeNode
    
    参数:
    userObject - The Object that should be carried by the new ITreeNode or null, if no one is desired.
    
    返回:
    See the ITreeNode{interface}: Null may be returned in case of failure!!!
    另请参阅:
    ITreeNode.addChild(Object)
  - addChildNode
```
public boolean addChildNode(ITreeNode node)
```
    The given ITreeNode will become this node to be it's father, while this instance will store the given node in it's list if not null (unconditionally: e.g. no test, if already contained).
    
    指定者:
    
    addChildNode 在接口中 ITreeNode
    
    参数:
    node - the node to add as child.
    
    返回:
    True, if the operation was succesful: For example some implementations (e.g. with support for unique user Objects in childs on the same level with the same parent node) may dissallow duplicate child nodes.
    另请参阅:
    ITreeNode.addChildNode(ITreeNode)
  - contains
```
public final boolean contains(Object userObject)
```
    从接口复制的说明: ITreeNode
    
    Find out, wether a certain "user" Object is carried by any of this ITreeNodes subtree.
    
    指定者:
    
    contains 在接口中 ITreeNode
    
    参数:
    userObject - Any Object, that might be contained in this tree - Identification is done by the means of the Objects Object.equals(Object)- method.
    
    返回:
    True, if any node of this subtree (including this ITreeNode contained a user Object that was equal to the given argument.
  containsNode
  
  public final boolean containsNode(ITreeNode node)
  
  从接口复制的说明: ITreeNode
  
  Find out, wether the given ITreeNode is a member of this node's subtree.
  
  指定者:
  
  containsNode 在接口中 ITreeNode
  
  参数:
  node - A ITreeNode that migth possibly linked to (or be) this instance by the means of the equals operation.
  
  返回:
  True, if an ITreeNode equal to the argument was found in the subtree started by this node.
  另请参阅:
  ITreeNode.equals(Object)
  
  getChildCount
  
  public final int getChildCount()
  
  从接口复制的说明: ITreeNode
  
  Returns the amount of child ITreeNodes of this ITreeNode.
  
  指定者:
  
  getChildCount 在接口中 ITreeNode
  
  getChilds
  
  public final Iterator getChilds()
  
  从接口复制的说明: ITreeNode
  
  The Iteratorreturned will not traverse the whole subtree but only the direct child nodes of this ITreeNode.
  
  指定者:
  
  getChilds 在接口中 ITreeNode
  
  返回:
  An Iteratorover the direct childs of this ITreeNode.
  
  getParent
  
  public final ITreeNode getParent()
  
  从接口复制的说明: ITreeNode
  
  Get the parent node of this ITreeNode. If the TreeNode has no parent node (e.g. a member of an implementation for the parent node is null), ITreeNode.ROOThas to be returned.
  
  指定者:
  
  getParent 在接口中 ITreeNode
  
  返回:
  The parent ITreeNode of this node or ITreeNode.ROOT, if this node is the root.
  
  getSubtreeCount
  
  public final int getSubtreeCount()
  
  从接口复制的说明: ITreeNode
  
  Get the amount of direct and indirect childs of this ITreeNode.
  
  指定者:
  
  getSubtreeCount 在接口中 ITreeNode
  
  返回:
  The total amount of all ITreeNode instances of this subtree (including this node).
  
  getUserObject
  
  public final Object getUserObject()
  
  从接口复制的说明: ITreeNode
  
  Returns the "user" Object that may be carried by the ITreeNode, or null, if no one was assigned.
  
  指定者:
  
  getUserObject 在接口中 ITreeNode
  
  返回:
  The user Object carried by this treenode or null, if no one was assigned.
  
  mark
  
  public final void mark()
  
  从接口复制的说明: ITreeNode
  
  Marks this ITreeNode instance (e.g. for being visited or invisible). Marking may be used to traverse the tree in an asynchronous manner from outside (TreeIterator) or for other desireable tasks.
  
  Subsequent calls to this method should not change the state to "unmarked".
  
  指定者:
  
  mark 在接口中 ITreeNode
  
  isMarked
  
  public final boolean isMarked()
  
  从接口复制的说明: ITreeNode
  
  Check, wether this ITreeNode is marked.
  
  指定者:
  
  isMarked 在接口中 ITreeNode
  
  返回:
  True, if this ITreeNode is marked, false else.
  
  remove
  
  public final ITreeNode remove(Object userObject)
  
  The search is a "prefix-search":
  A / \ B C / \ D E
  The search will be done in the order: A,B,D,E,C. If this ITreeNode contains the user Object equal to the argument, itself will be returned. This ITreeNode may be the root!
  
  指定者:
  
  remove 在接口中 ITreeNode
  
  参数:
  userObject - The user Object identifying the treenode to remove.
  
  返回:
  The TreeNode (being the new root of it's subtree) that was removed from this node's subtree or null, if no ITreeNode contained an equal user Object.
  另请参阅:
  ITreeNode.remove(Object)
  
  removeAllChildren
  
  public final List removeAllChildren()
  
  从接口复制的说明: ITreeNode
  
  Remove all child nodes of the ITreeNode.
  
  指定者:
  
  removeAllChildren 在接口中 ITreeNode
  
  返回:
  A Listcontaining all removed child nodes. An empty List should be provided instead of null!
  
  removeChild
  
  public boolean removeChild(ITreeNode node)
  
  从接口复制的说明: ITreeNode
  
  Remove the given ITreeNode from this node. If the operation is successful the given node will not have any parent node (e.g. null for parent member) but be the root node of it's subtree.
  
  The operation may fail, if the given ITreeNode is no child of this node, or the implementation permits the removal.
  
  指定者:
  
  removeChild 在接口中 ITreeNode
  
  参数:
  node - A child of this ITreeNode (by the means of the ITreeNode.equals(Object)operation) .
  
  返回:
  True, if the removal was successful, false if not.
  
  setUserObject
  
  public final Object setUserObject(Object store)
  
  从接口复制的说明: ITreeNode
  
  Assigns the "user" Object that may be carried by the ITreeNode.
  
  指定者:
  
  setUserObject 在接口中 ITreeNode
  
  返回:
  The previous user Object that was carried or null, if no one was assigned.
  
  unmark
  
  public final void unmark()
  
  从接口复制的说明: ITreeNode
  
  Unmarks this ITreeNode instance (e.g. for being visited or invisible). Marking may be used to traverse the tree in an asynchronous manner from outside (TreeIterator) or for other desireable tasks.
  
  Subsequent calls to this method should not change the state to "marked".
  
  指定者:
  
  unmark 在接口中 ITreeNode
  
  setParent
  
  public final void setParent(ITreeNode parent)
  
  从接口复制的说明: ITreeNode
  
  This method should not be called from outside. It is a callback for the method ITreeNode.addChildNode(ITreeNode)and should be used by implementations of that method but not any further. Else inconsistencies could occur: A node thinks it is the father of another node which itself does not know about that relation any more (remove itself from the old parent member's list could avoid it).
  
  指定者:
  
  setParent 在接口中 ITreeNode
  
  参数:
  parent - The new parental node.
  
  isLeaf
  
  public final boolean isLeaf()
  
  从接口复制的说明: ITreeNode
  
  Find out, wether this ITreeNode is a childless leaf.
  
  指定者:
  
  isLeaf 在接口中 ITreeNode
  
  返回:
  True, if this ITreeNode has no child nodes.
  
  isRoot
  
  public final boolean isRoot()
  
  从接口复制的说明: ITreeNode
  
  Find out, wether there is no path to a higher parental node from this ITreeNode.
  
  指定者:
  
  isRoot 在接口中 ITreeNode
  
  返回:
  True if this poor node is an orphan.
  
  toString
  
  public String toString()
  
  覆盖:
  
  toString 在类中 Object
  
  toStringInternal
  
  protected void toStringInternal(StringBuffer buf, int depth)
  
  addChildNodes
  
  public final boolean addChildNodes(ITreeNode[] nodes)
  
  从接口复制的说明: ITreeNode
  
  Adds all given ITreeNode instances to the set of this instances childs. This operation should delegate to ITreeNode.addChildNode(ITreeNode).
  
  指定者:
  
  addChildNodes 在接口中 ITreeNode
  
  参数:
  nodes - An arry of ITreeNode instances.
  
  返回:
  True, if all childs could be added (null instances are skipped), false else.
  
  addChildren
  
  public final ITreeNode[] addChildren(Object[] userObjects)
  
  从接口复制的说明: ITreeNode
  
  Adds all given Objects to newly instanciated ITreeNode instances that are added to the set of this instances childs. This operation should delegate to ITreeNode.addChild(Object).
  
  指定者:
  
  addChildren 在接口中 ITreeNode
  
  参数:
  userObjects - An arry of Objects instances which will become the m_userObject members of the newly created ITreeNode instances.
  
  返回:
  An array containing all new ITreeNode instances created (they contain the user objects).
  
  getAllChildren
  
  public final List getAllChildren()
  
  从接口复制的说明: ITreeNode
  
  Get all child nodes of the ITreeNode.
  
  指定者:
  
  getAllChildren 在接口中 ITreeNode
  
  返回:
  A Listcontaining all child nodes. An empty List should be provided instead of null!
  
  newInstance
  
  public ITreeNode newInstance()
  
  从接口复制的说明: ITreeNode
  
  Generic operations in default implementations may need to allocate new instances but have to choose the right type to support the provided invariants.
  
  If you provide a subclass that has invariants you should overload this.
  
  指定者:
  
  newInstance 在接口中 ITreeNode
  
  返回:
  A new allocated instance of the concrete impelementation.
  
  getPathFromRoot
  
  public void getPathFromRoot(List l)
  
  指定者:
  
  getPathFromRoot 在接口中 ITreeNode
  
  参数:
  l - An empty List: After this call it will be filled with ITreeNodeinstances starting from the root node to the current node that is invoked.
  
  getUserObjectPathFromRoot
  
  public void getUserObjectPathFromRoot(List l)
  
  指定者:
  
  getUserObjectPathFromRoot 在接口中 ITreeNode
  
  参数:
  l - An empty List: After this call it will be filled with the ITreeNode.getUserObject()instances starting from the root node to the current node that was invoked.
  
  compareTo
  
  public int compareTo(ITreeNode o) throws ClassCastException
  
  指定者:
  
  compareTo 在接口中 Comparable<ITreeNode>
  
  抛出:
  
  ClassCastException

类 ITreeNode.DefaultTreeNode

嵌套类概要

从接口继承的嵌套类/接口 info.monitorenter.cpdetector.util.collections.ITreeNode

字段概要

从接口继承的字段 info.monitorenter.cpdetector.util.collections.ITreeNode

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

marked

m_userObject

m_children

构造器详细资料

ITreeNode.DefaultTreeNode

ITreeNode.DefaultTreeNode

ITreeNode.DefaultTreeNode

ITreeNode.DefaultTreeNode

方法详细资料

equals

addChild

addChildNode

contains

containsNode

getChildCount

getChilds

getParent

getSubtreeCount

getUserObject

mark

isMarked

remove

removeAllChildren

removeChild

setUserObject

unmark

setParent

isLeaf

isRoot

toString

toStringInternal

addChildNodes

addChildren

getAllChildren

newInstance

getPathFromRoot

getUserObjectPathFromRoot

compareTo