Skip navigation links
text-tree v2.0.0
A C D G I N O R S T U V W 

A

addChild(DefaultNode) - Method in class org.barfuin.texttree.api.DefaultNode
 
AnnotationPosition - Enum in org.barfuin.texttree.api.style
Where to place node annotations.
ASCII - Static variable in class org.barfuin.texttree.api.style.TreeStyles
A tree style made purely of ASCII characters, for maximum portability.
ASCII_ROUNDED - Static variable in class org.barfuin.texttree.api.style.TreeStyles
Same as the ASCII tree style, but with nice rounded-off corners.

C

ColorScheme - Interface in org.barfuin.texttree.api.color
Describes a color scheme for the entire tree.
copyOf(TreeOptions) - Static method in class org.barfuin.texttree.api.TreeOptions
 
CycleProtection - Enum in org.barfuin.texttree.api
How cycle protection is handled.

D

DefaultColorScheme - Class in org.barfuin.texttree.api.color
The default color scheme for colored trees.
DefaultColorScheme() - Constructor for class org.barfuin.texttree.api.color.DefaultColorScheme
 
DefaultNode - Class in org.barfuin.texttree.api
A default implementation of the Node interface.
DefaultNode() - Constructor for class org.barfuin.texttree.api.DefaultNode
Constructor that initializes a node which contains the empty string as its node text.
DefaultNode(String) - Constructor for class org.barfuin.texttree.api.DefaultNode
Constructor.
DefaultNode(String, String, NodeColor, String, List<DefaultNode>) - Constructor for class org.barfuin.texttree.api.DefaultNode
 

G

getAnnotation() - Method in class org.barfuin.texttree.api.DefaultNode
 
getAnnotation() - Method in interface org.barfuin.texttree.api.Node
Return a String here to display as a node annotation.
getAnnotationColor() - Method in interface org.barfuin.texttree.api.color.ColorScheme
Getter.
getAnnotationColor() - Method in class org.barfuin.texttree.api.color.DefaultColorScheme
 
getAnnotationColor() - Method in class org.barfuin.texttree.api.color.NoColorScheme
 
getAnnotationColor() - Method in class org.barfuin.texttree.api.DefaultNode
 
getAnnotationColor() - Method in interface org.barfuin.texttree.api.Node
Return a color here for colored annotations.
getAnnotationPosition() - Method in class org.barfuin.texttree.api.TreeOptions
 
getBlankIndent() - Method in class org.barfuin.texttree.api.style.TreeStyle
 
getBlankIndentTrimmed() - Method in class org.barfuin.texttree.api.style.TreeStyle
 
getCalloutEnd() - Method in class org.barfuin.texttree.api.style.TreeStyle
 
getCalloutErrorColor() - Method in interface org.barfuin.texttree.api.color.ColorScheme
Getter.
getCalloutErrorColor() - Method in class org.barfuin.texttree.api.color.DefaultColorScheme
 
getCalloutErrorColor() - Method in class org.barfuin.texttree.api.color.NoColorScheme
 
getCalloutNoteColor() - Method in interface org.barfuin.texttree.api.color.ColorScheme
Getter.
getCalloutNoteColor() - Method in class org.barfuin.texttree.api.color.DefaultColorScheme
 
getCalloutNoteColor() - Method in class org.barfuin.texttree.api.color.NoColorScheme
 
getCalloutStart() - Method in class org.barfuin.texttree.api.style.TreeStyle
 
getChildren() - Method in class org.barfuin.texttree.api.DefaultNode
 
getChildren() - Method in interface org.barfuin.texttree.api.Node
The node's child nodes.
getColor() - Method in class org.barfuin.texttree.api.DefaultNode
 
getColor() - Method in interface org.barfuin.texttree.api.Node
Return a color here for colored node text.
getColorScheme() - Method in class org.barfuin.texttree.api.TreeOptions
 
getCycleProtection() - Method in class org.barfuin.texttree.api.TreeOptions
 
getEdgeColor() - Method in interface org.barfuin.texttree.api.color.ColorScheme
Getter.
getEdgeColor() - Method in class org.barfuin.texttree.api.color.DefaultColorScheme
 
getEdgeColor() - Method in class org.barfuin.texttree.api.color.NoColorScheme
 
getIdentityScheme() - Method in class org.barfuin.texttree.api.TreeOptions
 
getIndent() - Method in class org.barfuin.texttree.api.style.TreeStyle
 
getIndentTrimmed() - Method in class org.barfuin.texttree.api.style.TreeStyle
 
getJunction() - Method in class org.barfuin.texttree.api.style.TreeStyle
 
getKey() - Method in class org.barfuin.texttree.api.DefaultNode
 
getKey() - Method in interface org.barfuin.texttree.api.Node
An optional primary key for the node.
getLastJunction() - Method in class org.barfuin.texttree.api.style.TreeStyle
 
getMaxDepth() - Method in class org.barfuin.texttree.api.TreeOptions
 
getStyle() - Method in class org.barfuin.texttree.api.TreeOptions
 
getText() - Method in class org.barfuin.texttree.api.DefaultNode
 
getText() - Method in interface org.barfuin.texttree.api.Node
The node's text.
getTextColor() - Method in interface org.barfuin.texttree.api.color.ColorScheme
Getter.
getTextColor() - Method in class org.barfuin.texttree.api.color.DefaultColorScheme
 
getTextColor() - Method in class org.barfuin.texttree.api.color.NoColorScheme
 
getVerticalSpacing() - Method in class org.barfuin.texttree.api.TreeOptions
 

I

IdentityScheme - Enum in org.barfuin.texttree.api
How the internal cycle detector should identify objects.
isCycleAsPruned() - Method in class org.barfuin.texttree.api.TreeOptions
 
isStartsOnNewLine() - Method in enum org.barfuin.texttree.api.style.AnnotationPosition
 

N

newInstance(TreeOptions) - Static method in interface org.barfuin.texttree.api.TextTree
Factory method.
newInstance() - Static method in interface org.barfuin.texttree.api.TextTree
Factory method.
NoColorScheme - Class in org.barfuin.texttree.api.color
A pseudo color scheme which simply disables all coloring.
NoColorScheme() - Constructor for class org.barfuin.texttree.api.color.NoColorScheme
 
Node - Interface in org.barfuin.texttree.api
A data node in the tree to be rendered.
NodeColor - Enum in org.barfuin.texttree.api.color
The colors that a part of the rendered tree may take.
NPM6 - Static variable in class org.barfuin.texttree.api.style.TreeStyles
Similar to the ASCII_ROUNDED style, this is modified with a smaller indent to look just like the trees drawn by the Node Package Manager (NPM) in its version 6.x.

O

org.barfuin.texttree.api - package org.barfuin.texttree.api
The text-tree Java API.
org.barfuin.texttree.api.color - package org.barfuin.texttree.api.color
The text-tree API classes for coloring of tree elements.
org.barfuin.texttree.api.style - package org.barfuin.texttree.api.style
The text-tree API classes for tree styling (how it's drawn).

R

render(Node) - Method in interface org.barfuin.texttree.api.TextTree
Render the given tree into a String representation (synchronously).

S

setAnnotation(String) - Method in class org.barfuin.texttree.api.DefaultNode
 
setAnnotationColor(NodeColor) - Method in class org.barfuin.texttree.api.DefaultNode
 
setAnnotationPosition(AnnotationPosition) - Method in class org.barfuin.texttree.api.TreeOptions
 
setChildren(List<DefaultNode>) - Method in class org.barfuin.texttree.api.DefaultNode
 
setColor(NodeColor) - Method in class org.barfuin.texttree.api.DefaultNode
 
setColorScheme(ColorScheme) - Method in class org.barfuin.texttree.api.TreeOptions
 
setCycleAsPruned(boolean) - Method in class org.barfuin.texttree.api.TreeOptions
Setter.
setCycleProtection(CycleProtection) - Method in class org.barfuin.texttree.api.TreeOptions
 
setEnableDefaultColoring(boolean) - Method in class org.barfuin.texttree.api.TreeOptions
Setter.
setIdentityScheme(IdentityScheme) - Method in class org.barfuin.texttree.api.TreeOptions
 
setKey(String) - Method in class org.barfuin.texttree.api.DefaultNode
 
setMaxDepth(int) - Method in class org.barfuin.texttree.api.TreeOptions
Setter.
setStyle(TreeStyle) - Method in class org.barfuin.texttree.api.TreeOptions
 
setText(String) - Method in class org.barfuin.texttree.api.DefaultNode
 
setVerticalSpacing(int) - Method in class org.barfuin.texttree.api.TreeOptions
Setter.

T

TextTree - Interface in org.barfuin.texttree.api
Use this type to render trees.
TreeOptions - Class in org.barfuin.texttree.api
Configuration options that apply to one complete rendered tree.
TreeOptions() - Constructor for class org.barfuin.texttree.api.TreeOptions
 
TreeStyle - Class in org.barfuin.texttree.api.style
Describes a tree style, giving all the text elements needed for rendering.
TreeStyle(String, String, String, String, String) - Constructor for class org.barfuin.texttree.api.style.TreeStyle
Constructor.
TreeStyle(String, String, String) - Constructor for class org.barfuin.texttree.api.style.TreeStyle
Constructor.
TreeStyles - Class in org.barfuin.texttree.api.style
The pre-defined tree styles.

U

UNICODE - Static variable in class org.barfuin.texttree.api.style.TreeStyles
A tree style made of Unicode line drawing characters.
UNICODE_ROUNDED - Static variable in class org.barfuin.texttree.api.style.TreeStyles
Same as the UNICODE tree style, but with nice rounded-off corners.

V

valueOf(String) - Static method in enum org.barfuin.texttree.api.color.NodeColor
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.barfuin.texttree.api.CycleProtection
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.barfuin.texttree.api.IdentityScheme
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.barfuin.texttree.api.style.AnnotationPosition
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.barfuin.texttree.api.color.NodeColor
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.barfuin.texttree.api.CycleProtection
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.barfuin.texttree.api.IdentityScheme
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.barfuin.texttree.api.style.AnnotationPosition
Returns an array containing the constants of this enum type, in the order they are declared.

W

WIN_TREE - Static variable in class org.barfuin.texttree.api.style.TreeStyles
Similar to the UNICODE tree style, but without padding, just like what the Windows tree command produces (at least on Windows 10).
A C D G I N O R S T U V W 
Skip navigation links
text-tree v2.0.0