io.mats3.serial

Enum MatsTrace.KeepMatsTrace

java.lang.Object

java.lang.Enum<MatsTrace.KeepMatsTrace>

io.mats3.serial.MatsTrace.KeepMatsTrace

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MatsTrace.KeepMatsTrace>

Enclosing interface:

MatsTrace<Z>

public static enum MatsTrace.KeepMatsTrace
extends java.lang.Enum<MatsTrace.KeepMatsTrace>

Specifies how the MatsTrace will handle historic values that are present just for debugging. Notice the annoyance that this is effectively specified twice, once in the Mats API, and once here. That is better, IMHO, than this package depending on the Mats API only for that enum.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPACT Default: Nulls out Data for other than current call while still keeping the meta-info for the call history, and condenses State to a pure stack.
FULL Keeps all Data and State history for the entire trace.
MINIMAL Only keep the current call, and condenses State to a pure stack.

Method Summary

Modifier and Type	Method and Description
static MatsTrace.KeepMatsTrace	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MatsTrace.KeepMatsTrace[]	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

FULL

public static final MatsTrace.KeepMatsTrace FULL

Keeps all Data and State history for the entire trace. (Still the from and stack will be nulled, as it provide zero value that cannot be deduced from the previous calls).

COMPACT

public static final MatsTrace.KeepMatsTrace COMPACT

Default: Nulls out Data for other than current call while still keeping the meta-info for the call history, and condenses State to a pure stack.

MINIMAL

public static final MatsTrace.KeepMatsTrace MINIMAL

Only keep the current call, and condenses State to a pure stack.

Method Detail

values

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

Returns:

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

valueOf

public static MatsTrace.KeepMatsTrace 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