Package io.mats3

Enum Class MatsInitiator.KeepTrace

java.lang.Object

java.lang.Enum<MatsInitiator.KeepTrace>

io.mats3.MatsInitiator.KeepTrace

All Implemented Interfaces:

Serializable, Comparable<MatsInitiator.KeepTrace>, Constable

Enclosing interface:

MatsInitiator

public static enum MatsInitiator.KeepTrace
extends Enum<MatsInitiator.KeepTrace>

A hint to the underlying implementation of how much historic debugging information for the call flow should be retained in the underlying protocol.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPACT	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	Default: Keep all history for request and reply DTOs, and all history for state STOs.
MINIMAL	Only keep the current call, and condenses State to a pure stack.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FULL

public static final MatsInitiator.KeepTrace FULL

Default: Keep all history for request and reply DTOs, and all history for state STOs.

All calls with data and state should be kept, which e.g means that at the Terminator, all request and reply DTOs, and all STOs (with their changing values between each stage of a multi-stage endpoint) will be present in the underlying protocol.

COMPACT

public static final MatsInitiator.KeepTrace COMPACT

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.

This is a compromise between FULL and MINIMAL, where the DTOs and STOs except for the ones needed in the stack, are "nulled out", while the call trace itself (with metadata) is still present, which e.g. means that at the Terminator, you will know all endpoints and stages that the call flow traversed, but not the data or state except for what is pertinent for the Terminator.

MINIMAL

public static final MatsInitiator.KeepTrace MINIMAL

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

Keep zero history, where only the current call, and only the STOs needed for the current stack, are present. This e.g. means that at the Terminator, no Calls nor DTOs and STOs except for the current incoming to the Terminator will be present in the underlying protocol.

Method Details

values

public static MatsInitiator.KeepTrace[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MatsInitiator.KeepTrace valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null