Package org.forgerock.opendj.server.config.meta

Enum ProfilerPluginCfgDefn.ProfileAction

java.lang.Object

java.lang.Enum<ProfilerPluginCfgDefn.ProfileAction>

org.forgerock.opendj.server.config.meta.ProfilerPluginCfgDefn.ProfileAction

All Implemented Interfaces:

Serializable, Comparable<ProfilerPluginCfgDefn.ProfileAction>

Enclosing class:

ProfilerPluginCfgDefn

public static enum ProfilerPluginCfgDefn.ProfileAction
extends Enum<ProfilerPluginCfgDefn.ProfileAction>

Defines the set of permissable values for the "profile-action" property.

Specifies the action that should be taken by the profiler.

A value of "start" causes the profiler thread to start collecting data if it is not already active. A value of "stop" causes the profiler thread to stop collecting data and write it to disk, and a value of "cancel" causes the profiler thread to stop collecting data and discard anything that has been captured. These operations occur immediately.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCEL	Stop collecting profile data and discard what has been captured.
NONE	Do not take any action.
START	Start collecting profile data.
STOP	Stop collecting profile data and write what has been captured to a file in the profile directory.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CANCEL

public static final ProfilerPluginCfgDefn.ProfileAction CANCEL

Stop collecting profile data and discard what has been captured.

NONE

public static final ProfilerPluginCfgDefn.ProfileAction NONE

Do not take any action.

START

public static final ProfilerPluginCfgDefn.ProfileAction START

Start collecting profile data.

STOP

public static final ProfilerPluginCfgDefn.ProfileAction STOP

Stop collecting profile data and write what has been captured to a file in the profile directory.

Method Detail

values

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

Returns:

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

valueOf

public static ProfilerPluginCfgDefn.ProfileAction 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

toString

public String toString()

Overrides:

toString in class Enum<ProfilerPluginCfgDefn.ProfileAction>