org.barfuin.texttree.api

Class TreeOptions

java.lang.Object

org.barfuin.texttree.api.TreeOptions

public final class TreeOptions
extends Object

Configuration options that apply to one complete rendered tree.

Constructor Summary

Constructors

Constructor and Description
TreeOptions()

Method Summary

Modifier and Type	Method and Description
static TreeOptions	copyOf(TreeOptions pTreeOptions)
AnnotationPosition	getAnnotationPosition()
ColorScheme	getColorScheme()
CycleProtection	getCycleProtection()
IdentityScheme	getIdentityScheme()
int	getMaxDepth()
TreeStyle	getStyle()
int	getVerticalSpacing()
boolean	isCycleAsPruned()
void	setAnnotationPosition(AnnotationPosition pAnnotationPosition)
void	setColorScheme(ColorScheme pColorScheme)
void	setCycleAsPruned(boolean pCycleAsPruned) Setter.
void	setCycleProtection(CycleProtection pCycleProtection)
void	setEnableDefaultColoring(boolean pEnableDefaultColoring) Setter.
void	setIdentityScheme(IdentityScheme pIdentityScheme)
void	setMaxDepth(int pMaxDepth) Setter.
void	setStyle(TreeStyle pStyle)
void	setVerticalSpacing(int pVerticalSpacing) Setter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TreeOptions

public TreeOptions()

Method Detail

copyOf

public static TreeOptions copyOf(@Nonnull
                                 TreeOptions pTreeOptions)

getAnnotationPosition

@Nonnull
public AnnotationPosition getAnnotationPosition()

getColorScheme

@Nonnull
public ColorScheme getColorScheme()

getCycleProtection

@Nonnull
public CycleProtection getCycleProtection()

getIdentityScheme

@Nonnull
public IdentityScheme getIdentityScheme()

getMaxDepth

public int getMaxDepth()

getStyle

@Nonnull
public TreeStyle getStyle()

getVerticalSpacing

public int getVerticalSpacing()

isCycleAsPruned

public boolean isCycleAsPruned()

setAnnotationPosition

public void setAnnotationPosition(@Nullable
                                  AnnotationPosition pAnnotationPosition)

setColorScheme

public void setColorScheme(@Nullable
                           ColorScheme pColorScheme)

setCycleAsPruned

public void setCycleAsPruned(boolean pCycleAsPruned)

Setter.

Parameters:

pCycleAsPruned - flag indicating whether detected cycles should be flagged with a "shown before" callout instead of a "CYCLE" callout. This would tune down the cycles a bit, a behavior which may be desired by the invoking application.

setCycleProtection

public void setCycleProtection(@Nullable
                               CycleProtection pCycleProtection)

setEnableDefaultColoring

public void setEnableDefaultColoring(boolean pEnableDefaultColoring)

Setter.

Parameters:

pEnableDefaultColoring - flag indicating whether the resulting tree should have default colors (true) or not be colored at all (false). The default is false. Individual node colors will always be displayed if set.

See Also:

setColorScheme(org.barfuin.texttree.api.color.ColorScheme)

setIdentityScheme

public void setIdentityScheme(@Nullable
                              IdentityScheme pIdentityScheme)

setMaxDepth

public void setMaxDepth(int pMaxDepth)

Setter.

Parameters:

pMaxDepth - the maximum depth of the resulting tree. Nodes which are lower down will be clipped. A value of zero indicates unlimited depth.

setStyle

public void setStyle(@Nullable
                     TreeStyle pStyle)

setVerticalSpacing

public void setVerticalSpacing(int pVerticalSpacing)

Setter.

Parameters:

pVerticalSpacing - the number of blank lines to print before each node (defaults to 0)