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()
BiFunction<Callout,Node,String>	getCalloutProcessor() Getter.
String	getCalloutText(Callout pCalloutType) Look up the callout type in order to check if a specific callout text is registered for this callout type.
ColorScheme	getColorScheme()
CycleProtection	getCycleProtection()
IdentityScheme	getIdentityScheme()
int	getMaxDepth()
TreeStyle	getStyle()
int	getVerticalSpacing()
boolean	isCycleAsPruned()
void	setAnnotationPosition(AnnotationPosition pAnnotationPosition)
void	setCalloutProcessor(BiFunction<Callout,Node,String> pCalloutProcessor) Registers a callout processor.
void	setCalloutText(Callout pCalloutType, String pText) Register a callout text for a callout type, which will be printed instead of the normal callout text.
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()

getCalloutProcessor

@CheckForNull
public BiFunction<Callout,Node,String> getCalloutProcessor()

Getter.

Returns:

the callout processor registered with setCalloutProcessor(java.util.function.BiFunction<org.barfuin.texttree.api.Callout, org.barfuin.texttree.api.Node, java.lang.String>), if any

getCalloutText

@CheckForNull
public String getCalloutText(@Nonnull
                                            Callout pCalloutType)

Look up the callout type in order to check if a specific callout text is registered for this callout type. If so, return that text.

Parameters:

pCalloutType - the type of callout to check

Returns:

the callout text, or null if no text was registered

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)

setCalloutProcessor

public void setCalloutProcessor(@Nullable
                                BiFunction<Callout,Node,String> pCalloutProcessor)

Registers a callout processor. A callout processor is a lambda function which is passed the callout type and the node for which the callout shall be displayed and returns a String with the callout text. The function may also choose to return null, in which case no callout will be printed.

The callout processor can only affect the callout texts, not other behavior. For example, when a cycle is detected and the callout processor returns null, then no callout will be printed, but printing of child nodes will still stop because of the cycle.

The node passed to the callout processor is the real object from your tree, which should be treated as read-only, i.e. the callout processor should not modify the node.

The callout processor may refer to the text that would have been printed without it by calling Callout.getText() on its first argument.

This method allows for highly dynamic callout texts which depend on the individual node as well as the callout type. For simpler cases, consider using setCalloutText(org.barfuin.texttree.api.Callout, java.lang.String) which simply sets a text per callout type.

For example, in order to disable printing of callouts entirely, setCalloutProcessor((c, n) -> null);

A callout processor takes precedence over callout texts registered with setCalloutText(org.barfuin.texttree.api.Callout, java.lang.String).

Parameters:

pCalloutProcessor - the callout processor, or null to unregister

See Also:

setCalloutText(org.barfuin.texttree.api.Callout, java.lang.String)

setCalloutText

public void setCalloutText(@Nonnull
                           Callout pCalloutType,
                           @Nullable
                           String pText)

Register a callout text for a callout type, which will be printed instead of the normal callout text.

Note that callout texts produced by a callout processor take precedence over texts registered with this method.

Parameters:

pCalloutType - the callout type

pText - the text to display for that callout, or null to show the default text

See Also:

setCalloutProcessor(java.util.function.BiFunction<org.barfuin.texttree.api.Callout, org.barfuin.texttree.api.Node, java.lang.String>)

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 RepeatingNode callout instead of a Cycle. 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)