Package com.jprofiler.api.platform.parameters

Enum Class Liveness

java.lang.Object

java.lang.Enum<Liveness>

com.jprofiler.api.platform.parameters.Liveness

All Implemented Interfaces:

Serializable, Comparable<Liveness>, Constable

public enum Liveness
extends Enum<Liveness>

Represents all supported liveness types.

These constants are used as parameters in various Connection methods.

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
ALL	Live and garbage collected objects.
GCED	Garbage collected objects only.
LIVE	Live objects only.

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns a verbose description of the liveness type.
String	toString()
static Liveness	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Liveness[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LIVE

public static final Liveness LIVE

Live objects only.

GCED

public static final Liveness GCED

Garbage collected objects only.

ALL

public static final Liveness ALL

Live and garbage collected objects.

Method Details

values

public static Liveness[] 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 Liveness 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

getName

public String getName()

Returns a verbose description of the liveness type.

Returns:

the verbose description

toString

public String toString()

Overrides:

toString in class Enum<Liveness>