org.barfuin.texttree.api

Enum Callout

java.lang.Object

java.lang.Enum<Callout>

org.barfuin.texttree.api.Callout

All Implemented Interfaces:

Serializable, Comparable<Callout>

public enum Callout
extends Enum<Callout>

The possible callouts. Callouts are not annotations, but extra information added by the tree rendering algorithm.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Cycle a cycle was detected, i.e.
MaxDepth the maximum configured tree depth was exceeded
None no callout is displayed
RepeatingNode a subtree that was already printed before was pruned this time

Method Summary

Modifier and Type	Method and Description
String	getText() Get the text of the callout.
static Callout	valueOf(String name) Returns the enum constant of this type with the specified name.
static Callout[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Cycle

public static final Callout Cycle

a cycle was detected, i.e. a node was encountered who is a parent of itself

MaxDepth

public static final Callout MaxDepth

the maximum configured tree depth was exceeded

None

public static final Callout None

no callout is displayed

RepeatingNode

public static final Callout RepeatingNode

a subtree that was already printed before was pruned this time

Method Detail

getText

@Nonnull
public String getText()

Get the text of the callout.

Returns:

the callout text

valueOf

public static Callout valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

values

public static Callout[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Callout c : Callout.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared