org.barfuin.texttree.api

Enum CycleProtection

java.lang.Object

java.lang.Enum<CycleProtection>

org.barfuin.texttree.api.CycleProtection

All Implemented Interfaces:

Serializable, Comparable<CycleProtection>

public enum CycleProtection
extends Enum<CycleProtection>

How cycle protection is handled. This controls what happens when a node appears as its own child node, or when a node appears in multiple place around the tree.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Off We do nothing about cycles, every node is printed as-is.
On Cycles are detected according to the IdentityScheme and the tree is clipped when a cycle occurs on the current path in the tree.
PruneRepeating In this mode, any repeating node will be clipped, even if the repeat occurrence is in a parallel subtree.

Method Summary

Modifier and Type	Method and Description
static CycleProtection	valueOf(String name) Returns the enum constant of this type with the specified name.
static CycleProtection[]	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

Off

public static final CycleProtection Off

We do nothing about cycles, every node is printed as-is. Use this only when you are very sure about your input data not containing cycles. Be careful, stack overflows lurk here.

On

public static final CycleProtection On

Cycles are detected according to the IdentityScheme and the tree is clipped when a cycle occurs on the current path in the tree. In other words, when a node is its own child node at some point.

When a reoccurring node is clipped in this mode, the node text is still printed, but not its annotation or child nodes, and a callout <CYCLE> is appended to the node text.

PruneRepeating

public static final CycleProtection PruneRepeating

In this mode, any repeating node will be clipped, even if the repeat occurrence is in a parallel subtree. Repeating nodes are detected according to the IdentityScheme. This is useful if it should be avoided to show repeating information.

When a reoccurring node is clipped in this mode, the node text is still printed, but not its annotation or child nodes, and a callout <shown before> is appended to the node text.

Cycles of the form described for On can still occur in this mode, and will be flagged accordingly.

Method Detail

valueOf

public static CycleProtection 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 CycleProtection[] 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 (CycleProtection c : CycleProtection.values())
    System.out.println(c);

Returns:

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