de.ipcon.db.core.boprocs

Enum BOProcIFormatterMode

java.lang.Object

java.lang.Enum<BOProcIFormatterMode>

de.ipcon.db.core.boprocs.BOProcIFormatterMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BOProcIFormatterMode>

public enum BOProcIFormatterMode
extends java.lang.Enum<BOProcIFormatterMode>

the available modes (classes) by which BO procs can be formatted. For use with TransactionFormatterBuilder

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONCISE
MASS_CHANGES
VERBOSE

Method Summary

Modifier and Type	Method and Description
BOProcIFormatter	getNewFormatter(boolean html) Get a new formatter based on this mode and the provided HTML configuration.
BOProcIFormatter	getNewFormatter(boolean html, int maxChars) Construct and return a new formatter based on this mode and the provided configuration parameters.
static BOProcIFormatterMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BOProcIFormatterMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONCISE

public static final BOProcIFormatterMode CONCISE

VERBOSE

public static final BOProcIFormatterMode VERBOSE

MASS_CHANGES

public static final BOProcIFormatterMode MASS_CHANGES

Method Detail

values

public static BOProcIFormatterMode[] 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 (BOProcIFormatterMode c : BOProcIFormatterMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static BOProcIFormatterMode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getNewFormatter

public BOProcIFormatter getNewFormatter(boolean html)

Get a new formatter based on this mode and the provided HTML configuration. Otherwise, the formatter uses its default configuration.

Parameters:

html - if true, output as html, otherwise output plain text

Returns:

a new BOProcIFormatter instance with html either enabled or disabled

getNewFormatter

public BOProcIFormatter getNewFormatter(boolean html,
                                        int maxChars)

Construct and return a new formatter based on this mode and the provided configuration parameters.

Parameters:

html - if true, output as html, otherwise output plain text

maxChars - the number of maximum characters per proc

Returns:

a new BOProcIFormatter instanced based on this mode and the provided configuration