org.barfuin.texttree.api.style

Enum AnnotationPosition

java.lang.Object

java.lang.Enum<AnnotationPosition>

org.barfuin.texttree.api.style.AnnotationPosition

All Implemented Interfaces:

Serializable, Comparable<AnnotationPosition>

public enum AnnotationPosition
extends Enum<AnnotationPosition>

Where to place node annotations.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Aligned Like Inline, but all aligned to the same column.
Indented Annotations are printed on the next line, but moved to the left as far as possible, while continuing the tree structure to the left of the annotation.
Inline The node annotation is displayed on the same line as the node text, e.g. node text (annotation).
InlineRight Annotations are placed to the right of the node text (like Inline), but all lines of a multi-line annotation are aligned to begin on the same column.
NextLine The node annotation is positioned in a new line following the node text.
None Annotations are not printed even if present.

Method Summary

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

Aligned

public static final AnnotationPosition Aligned

Like Inline, but all aligned to the same column.

 sample tree
 ├─── node         (annotation)
 ├─── another node (annotation)
 ╰─── last node    (annotation)

Indented

public static final AnnotationPosition Indented

Annotations are printed on the next line, but moved to the left as far as possible, while continuing the tree structure to the left of the annotation. One space is added to separate the annotation from the tree structure. Where a node has no children, the annotation is indented by the same amount, so that a uniform appearance is achieved.

 sample tree
 │ (annotation)
 ├─── node
 │      (annotation)
 ╰─── last node
        (annotation)

Inline

public static final AnnotationPosition Inline

The node annotation is displayed on the same line as the node text, e.g. node text (annotation).

 sample tree
 ├─── node (annotation)
 ├─── another node (annotation)
 ╰─── last node

InlineRight

public static final AnnotationPosition InlineRight

Annotations are placed to the right of the node text (like Inline), but all lines of a multi-line annotation are aligned to begin on the same column. The tree structure is continued to the left of the annotation. Indent defined by the tree style is preserved.

 root (annotation line 1)
 │    (annotation line 2)
 ├─── n1   (annotation line 1)
 │         (annotation line 2)
 ├─── another node (annotation line 1)
 │                 (annotation line 2)
 ╰─── last node

NextLine

public static final AnnotationPosition NextLine

The node annotation is positioned in a new line following the node text.

 sample tree
 ├─── node
 │    (annotation)
 ├─── another node
 │    (annotation)
 ╰─── last node

None

public static final AnnotationPosition None

Annotations are not printed even if present.

Method Detail

isStartsOnNewLine

public boolean isStartsOnNewLine()

valueOf

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

Returns:

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