org.barfuin.texttree.api

Interface TextTree

public interface TextTree

Use this type to render trees. 🌳🌲🌳

Method Summary

Modifier and Type	Method and Description
static TextTree	newInstance() Factory method.
static TextTree	newInstance(TreeOptions pOptions) Factory method.
String	render(Node pNode) Render the given tree into a String representation (synchronously).

Method Detail

newInstance

@Nonnull
static TextTree newInstance()

Factory method.

Returns:

a TextTree instance that is ready to go

newInstance

@Nonnull
static TextTree newInstance(@Nullable
                                     TreeOptions pOptions)

Factory method.

Parameters:

pOptions - tree options

Returns:

a TextTree instance that is ready to go

render

@Nonnull
String render(@Nullable
                       Node pNode)

Render the given tree into a String representation (synchronously).

Parameters:

pNode - a tree

Returns:

the entire tree in a String representation, optionally colorized