Package com.tonic.analysis.instrumentation

Enum HookDescriptor.HookParameter

java.lang.Object

java.lang.Enum<HookDescriptor.HookParameter>

com.tonic.analysis.instrumentation.HookDescriptor.HookParameter

All Implemented Interfaces:

Serializable, Comparable<HookDescriptor.HookParameter>

Enclosing class:

HookDescriptor

public static enum HookDescriptor.HookParameter
extends Enum<HookDescriptor.HookParameter>

Types of parameters that can be passed to hooks.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL_PARAMETERS	All method parameters as Object[]
ARRAY_INDEX	The array index
ARRAY_REF	The array reference
CALL_ARGUMENTS	Arguments of a method call
CALL_RECEIVER	The receiver of a method call
CALL_RESULT	Result of a method call
CLASS_NAME	The class name as a String
EXCEPTION	The exception object (for exception hooks)
FIELD_NAME	The field name as a String
FIELD_OWNER	The field owner object
METHOD_DESCRIPTOR	The method descriptor as a String
METHOD_NAME	The method name as a String
NEW_VALUE	The new value being assigned (for write hooks)
PARAMETER	A specific parameter by index
READ_VALUE	The old/read value (for read hooks)
RETURN_VALUE	The return value (for exit hooks)
THIS	The 'this' reference (null for static methods)

Method Summary

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

THIS

public static final HookDescriptor.HookParameter THIS

The 'this' reference (null for static methods)

METHOD_NAME

public static final HookDescriptor.HookParameter METHOD_NAME

The method name as a String

METHOD_DESCRIPTOR

public static final HookDescriptor.HookParameter METHOD_DESCRIPTOR

The method descriptor as a String

CLASS_NAME

public static final HookDescriptor.HookParameter CLASS_NAME

The class name as a String

ALL_PARAMETERS

public static final HookDescriptor.HookParameter ALL_PARAMETERS

All method parameters as Object[]

PARAMETER

public static final HookDescriptor.HookParameter PARAMETER

A specific parameter by index

RETURN_VALUE

public static final HookDescriptor.HookParameter RETURN_VALUE

The return value (for exit hooks)

FIELD_OWNER

public static final HookDescriptor.HookParameter FIELD_OWNER

The field owner object

FIELD_NAME

public static final HookDescriptor.HookParameter FIELD_NAME

The field name as a String

NEW_VALUE

public static final HookDescriptor.HookParameter NEW_VALUE

The new value being assigned (for write hooks)

READ_VALUE

public static final HookDescriptor.HookParameter READ_VALUE

The old/read value (for read hooks)

ARRAY_REF

public static final HookDescriptor.HookParameter ARRAY_REF

The array reference

ARRAY_INDEX

public static final HookDescriptor.HookParameter ARRAY_INDEX

The array index

EXCEPTION

public static final HookDescriptor.HookParameter EXCEPTION

The exception object (for exception hooks)

CALL_RECEIVER

public static final HookDescriptor.HookParameter CALL_RECEIVER

The receiver of a method call

CALL_ARGUMENTS

public static final HookDescriptor.HookParameter CALL_ARGUMENTS

Arguments of a method call

CALL_RESULT

public static final HookDescriptor.HookParameter CALL_RESULT

Result of a method call

Method Detail

values

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

Returns:

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

valueOf

public static HookDescriptor.HookParameter 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