jme3utilities.debug

Class Dumper

java.lang.Object

jme3utilities.debug.Dumper

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

PhysicsDumper

public class Dumper
extends java.lang.Object
implements java.lang.Cloneable

Dump portions of a Libbulletjme object for debugging.

The level of detail can be configured dynamically.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.PrintStream	stream stream to use for output: set by constructor

Constructor Summary

Constructors

Constructor and Description
Dumper() Instantiate a dumper that will use System.out for output.
Dumper(java.io.PrintStream printStream) Instantiate a dumper that will use the specified output stream.

Method Summary

Modifier and Type	Method and Description
protected void	addDescription(java.lang.String description) If the specified description is non-empty, print it to the stream, prefixed by a blank.
protected void	addLine(java.lang.String indent) Print a newline, followed by the specified indentation.
Dumper	clone() Create a deep copy of this Dumper.
Describer	getDescriber() Access the Describer used by this dumper.
java.lang.String	indentIncrement() Return the indent increment.
Dumper	setDescriber(Describer newDescriber) Replace the current Describer with the specified one.
Dumper	setIndentIncrement(java.lang.String newValue) Configure the indent increment.

Methods inherited from class java.lang.Object

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

Field Detail

stream

protected final java.io.PrintStream stream

stream to use for output: set by constructor

Constructor Detail

Dumper

public Dumper()

Instantiate a dumper that will use System.out for output.

Dumper

public Dumper(java.io.PrintStream printStream)

Instantiate a dumper that will use the specified output stream.

Parameters:

printStream - the output stream (not null, alias created)

Method Detail

getDescriber

public Describer getDescriber()

Access the Describer used by this dumper.

Returns:

the pre-existing instance (not null)

indentIncrement

public java.lang.String indentIncrement()

Return the indent increment.

Returns:

(not null, may be empty)

setDescriber

public Dumper setDescriber(Describer newDescriber)

Replace the current Describer with the specified one.

Parameters:

newDescriber - the desired Describer (not null, alias created)

Returns:

this instance for chaining

setIndentIncrement

public Dumper setIndentIncrement(java.lang.String newValue)

Configure the indent increment.

Parameters:

newValue - (not null, default=" ")

Returns:

this instance for chaining

addDescription

protected void addDescription(java.lang.String description)

If the specified description is non-empty, print it to the stream, prefixed by a blank.

Parameters:

description - (not null)

addLine

protected void addLine(java.lang.String indent)

Print a newline, followed by the specified indentation.

Parameters:

indent - (not null)

clone

public Dumper clone()
             throws java.lang.CloneNotSupportedException

Create a deep copy of this Dumper.

Overrides:

clone in class java.lang.Object

Returns:

a new instance, equivalent to this one, with its own Describer

Throws:

java.lang.CloneNotSupportedException - if the superclass isn't cloneable