facets.util.treecode
Class TreeCoded

java.lang.Object
  facets.util.Tracer
      facets.util.treecode.TreeCoded

All Implemented Interfaces:

Titled, java.lang.Comparable<TreeCoded>

Direct Known Subclasses:

TreeCodeContext

public abstract class TreeCoded
extends Tracer
implements Titled, java.lang.Comparable<TreeCoded>

Wraps a DataNode containing its code and has a (possibly empty) TreeCoded.Label.

Nested Class Summary

static class

TreeCoded.Label Identifies a TreeCoded.

Field Summary

boolean	debug
TreeCoded.Label	label
DataNode	source
TreeCodeType	treeType

Constructor Summary

protected

TreeCoded(DataNode source, TreeCodeType type)

Method Summary

int	compareTo(TreeCoded q)
java.lang.String	title() Return human-readable identifying text.
java.lang.String	toString()
protected void	traceOutput(java.lang.String msg) Outputs complete trace messages to console or elsewhere.

Methods inherited from class facets.util.Tracer

trace, trace, trace, trace, trace, traceDebug, traceDebug, traceObjectText, traceOutputWithClass

Methods inherited from class java.lang.Object

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

Field Detail

source

public final DataNode source

label

public final TreeCoded.Label label

debug

public final boolean debug

treeType

public final TreeCodeType treeType

Constructor Detail

TreeCoded

protected TreeCoded(DataNode source,
                    TreeCodeType type)

Method Detail

traceOutput

protected void traceOutput(java.lang.String msg)

Description copied from class: Tracer

Outputs complete trace messages to console or elsewhere.

Default prepends helpful classname to message.

Overrides:

traceOutput in class Tracer

Parameters:

msg - passed from one of the public methods

title

public final java.lang.String title()

Description copied from interface: Titled

Return human-readable identifying text.

Specified by:

title in interface Titled

Returns:

non-null, non-empty string with no structural whitespace

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(TreeCoded q)

Specified by:

compareTo in interface java.lang.Comparable<TreeCoded>