org.barfuin.texttree.api

Class DefaultNode

java.lang.Object

org.barfuin.texttree.api.DefaultNode

All Implemented Interfaces:

Node

public class DefaultNode
extends Object
implements Node

A default implementation of the Node interface.

Constructor Summary

Constructors

Constructor and Description
DefaultNode() Constructor that initializes a node which contains the empty string as its node text.
DefaultNode(String pText) Constructor.
DefaultNode(String pText, String pKey, NodeColor pColorOverride, String pAnnotation, List<DefaultNode> pChildren)

Method Summary

Modifier and Type	Method and Description
void	addChild(DefaultNode pChild)
String	getAnnotation() Return a String here to display as a node annotation.
NodeColor	getAnnotationColor() Return a color here for colored annotations.
List<DefaultNode>	getChildren() The node's child nodes.
NodeColor	getColor() Return a color here for colored node text.
String	getKey() An optional primary key for the node.
String	getText() The node's text.
void	setAnnotation(String pAnnotation)
void	setAnnotationColor(NodeColor pAnnotationColorOverride)
void	setChildren(List<DefaultNode> pChildren)
void	setColor(NodeColor pColorOverride)
void	setKey(String pKey)
void	setText(String pText)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultNode

public DefaultNode()

Constructor that initializes a node which contains the empty string as its node text.

DefaultNode

public DefaultNode(String pText)

Constructor.

Parameters:

pText - the node's text

DefaultNode

public DefaultNode(@Nullable
                   String pText,
                   @Nullable
                   String pKey,
                   @Nullable
                   NodeColor pColorOverride,
                   @Nullable
                   String pAnnotation,
                   @Nullable
                   List<DefaultNode> pChildren)

Method Detail

addChild

public void addChild(@Nullable
                     DefaultNode pChild)

getAnnotation

@CheckForNull
public String getAnnotation()

Description copied from interface: Node

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().

Specified by:

getAnnotation in interface Node

Returns:

the annotation, or null for no annotation

getAnnotationColor

@CheckForNull
public NodeColor getAnnotationColor()

Description copied from interface: Node

Return a color here for colored annotations. The color set here takes precedence over the tree's color scheme.

Specified by:

getAnnotationColor in interface Node

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

@Nonnull
public List<DefaultNode> getChildren()

Description copied from interface: Node

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).

Specified by:

getChildren in interface Node

Returns:

the list of child nodes, or null / empty if this is a leaf node

getColor

@CheckForNull
public NodeColor getColor()

Description copied from interface: Node

Return a color here for colored node text. The color set here takes precedence over the tree's color scheme.

Specified by:

getColor in interface Node

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
public String getKey()

Description copied from interface: Node

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).

Specified by:

getKey in interface Node

Returns:

an identifying String

getText

@CheckForNull
public String getText()

Description copied from interface: Node

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().

Specified by:

getText in interface Node

Returns:

the node's text

setAnnotation

public void setAnnotation(@Nullable
                          String pAnnotation)

setAnnotationColor

public void setAnnotationColor(@Nullable
                               NodeColor pAnnotationColorOverride)

setChildren

public void setChildren(@Nullable
                        List<DefaultNode> pChildren)

setColor

public void setColor(@Nullable
                     NodeColor pColorOverride)

setKey

public void setKey(@Nullable
                   String pKey)

setText

public void setText(@Nullable
                    String pText)