Package net.sf.ehcache.config

Enum SizeOfPolicyConfiguration.MaxDepthExceededBehavior

java.lang.Object

java.lang.Enum<SizeOfPolicyConfiguration.MaxDepthExceededBehavior>

net.sf.ehcache.config.SizeOfPolicyConfiguration.MaxDepthExceededBehavior

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SizeOfPolicyConfiguration.MaxDepthExceededBehavior>

Enclosing class:

SizeOfPolicyConfiguration

public static enum SizeOfPolicyConfiguration.MaxDepthExceededBehavior
extends java.lang.Enum<SizeOfPolicyConfiguration.MaxDepthExceededBehavior>

Enum of the possible behaviors of the SizeOf engine when the max depth is exceeded

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABORT	Abort the SizeOf engine's traversal and immediately return the partially calculated size
CONTINUE	Warn about the exceeded max depth but continue traversal of the sized element

Method Summary

Modifier and Type	Method	Description
boolean	isAbort()	Returns true if this behavior is equal to ABORT
boolean	isContinue()	Returns true if this behavior is equal to CONTINUE
static SizeOfPolicyConfiguration.MaxDepthExceededBehavior	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SizeOfPolicyConfiguration.MaxDepthExceededBehavior[]	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

ABORT

public static final SizeOfPolicyConfiguration.MaxDepthExceededBehavior ABORT

Abort the SizeOf engine's traversal and immediately return the partially calculated size

CONTINUE

public static final SizeOfPolicyConfiguration.MaxDepthExceededBehavior CONTINUE

Warn about the exceeded max depth but continue traversal of the sized element

Method Detail

values

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

Returns:

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

valueOf

public static SizeOfPolicyConfiguration.MaxDepthExceededBehavior 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

isAbort

public boolean isAbort()

Returns true if this behavior is equal to ABORT

Returns:

true if this behavior is equal to ABORT

isContinue

public boolean isContinue()

Returns true if this behavior is equal to CONTINUE

Returns:

true if this behavior is equal to CONTINUE