Package com.tonic.analysis.simulation.heap

Enum EscapeAnalyzer.EscapeState

java.lang.Object

java.lang.Enum<EscapeAnalyzer.EscapeState>

com.tonic.analysis.simulation.heap.EscapeAnalyzer.EscapeState

All Implemented Interfaces:

Serializable, Comparable<EscapeAnalyzer.EscapeState>

Enclosing class:

EscapeAnalyzer

public static enum EscapeAnalyzer.EscapeState
extends Enum<EscapeAnalyzer.EscapeState>

How far an allocation escapes its allocating method.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARG_ESCAPE	The allocation is handed to a callee but no further; this analyzer never reports it.
GLOBAL_ESCAPE	The allocation is visible outside the method, having been marked escaped, stored into a static field, or made reachable from an escaped object.
NO_ESCAPE	The allocation stays confined to its allocating method, so it is a candidate for stack allocation or scalar replacement.

Method Summary

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

NO_ESCAPE

public static final EscapeAnalyzer.EscapeState NO_ESCAPE

The allocation stays confined to its allocating method, so it is a candidate for stack allocation or scalar replacement.

ARG_ESCAPE

public static final EscapeAnalyzer.EscapeState ARG_ESCAPE

The allocation is handed to a callee but no further; this analyzer never reports it.

GLOBAL_ESCAPE

public static final EscapeAnalyzer.EscapeState GLOBAL_ESCAPE

The allocation is visible outside the method, having been marked escaped, stored into a static field, or made reachable from an escaped object.

Method Detail

values

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

Returns:

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

valueOf

public static EscapeAnalyzer.EscapeState 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