Node (text-tree)

All Known Implementing Classes:

DefaultNode
```
public interface Node
```
A data node in the tree to be rendered. Implement this interface in the elements of your tree.
These methods may be called multiple times during the generation of the tree, and they must return the same value every time.

See Also:

DefaultNode

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default String`	`getAnnotation()` Return a String here to display as a node annotation.
`default NodeColor`	`getAnnotationColor()` Return a color here for colored annotations.
`Iterable<? extends Node>`	`getChildren()` The node's child nodes.
`default NodeColor`	`getColor()` Return a color here for colored node text.
`default String`	`getKey()` An optional primary key for the node.
`String`	`getText()` The node's text.

- Method Detail
  - getAnnotation
```
@CheckForNull
default String getAnnotation()
```
    Return a String here to display as a node annotation.
    May contain line breaks. The line breaks must be in system-specific format (CRLF vs. LF). Best create them using System.lineSeparator().
    
    Returns:
    
    the annotation, or null for no annotation
  - getAnnotationColor
```
@CheckForNull
default NodeColor getAnnotationColor()
```
    Return a color here for colored annotations. The color set here takes precedence over the tree's color scheme.
    
    Returns:
    
    the annotation color, or null to use the color from the tree's color scheme. A value of NodeColor.None indicates that the annotation must not be colored.
  - getChildren
```
@CheckForNull
Iterable<? extends Node> getChildren()
```
    The node's child nodes. This method may be called multiple times, and it is expected to return the same elements on each invocation. Nodes returned by this iterator may also be null (shouldn't, but we can handle it).
    
    Returns:
    
    the list of child nodes, or null / empty if this is a leaf node
  - getColor
```
@CheckForNull
default NodeColor getColor()
```
    Return a color here for colored node text. The color set here takes precedence over the tree's color scheme.
    
    Returns:
    
    the node color, or null to use the color from the tree's color scheme. A value of NodeColor.None indicates that the node must not be colored.
  - getKey
```
@CheckForNull
default String getKey()
```
    An optional primary key for the node. This can be used to identify nodes for cycle detection. It defaults to the node text if not overridden. The value returned from this method is used only if the IdentityScheme.ByKey is explicitly selected. Otherwise, this method should be left to its default implementation.
    If you actually use this value (because you've chosen IdentityScheme.ByKey), then you should make sure that it not return null. All nodes which do that will be considered the same node then (which may be what you want. I'm just saying).
    
    Returns:
    
    an identifying String
  - getText
```
@CheckForNull
String getText()
```
    The node's text.
    May contain line breaks. The line breaks must be in system-specific format (CRLF vs. LF). Best create them using System.lineSeparator().
    
    Returns:
    
    the node's text

Interface Node

Method Summary

Method Detail

getAnnotation

getAnnotationColor

getChildren

getColor

getKey

getText