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

Enum DumpMode

java.lang.Object

java.lang.Enum<DumpMode>

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

All Implemented Interfaces:

Serializable, Comparable<DumpMode>

public enum DumpMode
extends Enum<DumpMode>

Enumerates the different options that can be used when specifying how to dump out properties or types in ObjectDumper.

They are listed in order of verbosity. (This is copied from ph-commons-util.)

Version:

$Revision$

Author:

David McKain

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEEP Uses ObjectDumper to do a deep dump of the given type or property.
IGNORE Ignores the given property.
TO_STRING Calls Object.toString() on the given type or property.

Method Summary

Modifier and Type	Method and Description
static DumpMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DumpMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IGNORE

public static final DumpMode IGNORE

Ignores the given property.

TO_STRING

public static final DumpMode TO_STRING

Calls Object.toString() on the given type or property.

DEEP

public static final DumpMode DEEP

Uses ObjectDumper to do a deep dump of the given type or property.

Method Detail

values

public static DumpMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DumpMode c : DumpMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DumpMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null