Package org.codehaus.groovy.tools.groovydoc

Class ClassTree.Node

java.lang.Object

org.codehaus.groovy.tools.groovydoc.ClassTree.Node

Enclosing class:

ClassTree

public static final class ClassTree.Node
extends Object

A node in an inheritance/extension tree.

If classDoc is non-null the node represents a documented type (rendered as a link); otherwise it represents an external type joining documented children to a common ancestor (rendered as plain text using qualifiedName).

Method Summary

Modifier and Type	Method	Description
List<ClassTree.Node>	getChildren()	Children in insertion order; callers typically sort before rendering.
GroovyClassDoc	getClassDoc()	Returns the class doc for this node, or null if this is an external (non-link) node.
String	getQualifiedName()	Returns the fully qualified name of this node's type.

Methods inherited from class java.lang.Object

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

Method Details

getQualifiedName

public String getQualifiedName()

Returns the fully qualified name of this node's type.

getClassDoc

public GroovyClassDoc getClassDoc()

Returns the class doc for this node, or null if this is an external (non-link) node.

getChildren

public List<ClassTree.Node> getChildren()

Children in insertion order; callers typically sort before rendering.