uk.ac.ed.ph.snuggletex.internal.util

Class ObjectDumper

java.lang.Object

uk.ac.ed.ph.snuggletex.internal.util.ObjectDumper

public final class ObjectDumper
extends Object

Trivial but slightly useful helper for creating deep dumps of Objects and their its properties, which can be useful for displaying status messages and debugging. (This is copied from ph-commons-util.)

Version:

$Revision$

Author:

David McKain

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INDENT_WIDTH
static int	DEFAULT_MAX_DEPTH

Constructor Summary

Constructors

Constructor and Description
ObjectDumper(StringBuilder result)

Method Summary

Modifier and Type	Method and Description
void	appendObject(Object object) Does a dump of the given Object, using whatever DumpMode is providied for its class.
void	appendObject(Object object, DumpMode dumpMode) Does a dump of the given Object using the given DumpMode.
static String	dumpObject(Object object, DumpMode dumpMode) Convenience method to do a DumpMode.DEEP dump of a single Object and return the resulting String.
int	getIndentWidth()
int	getMaxDepth()
void	setIndentWidth(int indentWidth)
void	setMaxDepth(int maxDepth)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INDENT_WIDTH

public static final int DEFAULT_INDENT_WIDTH

See Also:

Constant Field Values

DEFAULT_MAX_DEPTH

public static final int DEFAULT_MAX_DEPTH

See Also:

Constant Field Values

Constructor Detail

ObjectDumper

public ObjectDumper(StringBuilder result)

Method Detail

dumpObject

public static String dumpObject(Object object,
                                DumpMode dumpMode)

Convenience method to do a DumpMode.DEEP dump of a single Object and return the resulting String.

getIndentWidth

public int getIndentWidth()

setIndentWidth

public void setIndentWidth(int indentWidth)

getMaxDepth

public int getMaxDepth()

setMaxDepth

public void setMaxDepth(int maxDepth)

appendObject

public void appendObject(Object object)

Does a dump of the given Object, using whatever DumpMode is providied for its class. If the Object is null, then DumpMode.TO_STRING is used.

appendObject

public void appendObject(Object object,
                         DumpMode dumpMode)

Does a dump of the given Object using the given DumpMode.

Parameters:

object -

dumpMode - if DumpMode.DEEP then the Object is dumped deeply, if DumpMode.TO_STRING then the Object's Object.toString() is called, if DumpMode.IGNORE then nothing happens.