Package com.tonic.analysis.instrumentation.hook

Class MethodEntryHook

java.lang.Object

com.tonic.analysis.instrumentation.hook.MethodEntryHook

All Implemented Interfaces:

Hook

public class MethodEntryHook
extends Object
implements Hook

Configuration for method entry instrumentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MethodEntryHook.Builder	Fluent builder for a method entry hook; every setting has a default except the hook descriptor.

Method Summary

Modifier and Type	Method	Description
static MethodEntryHook.Builder	builder()
List<InstrumentationFilter>	getFilters()
HookDescriptor	getHookDescriptor()
List<Integer>	getParameterIndices()
int	getPriority()	Gets the priority for ordering multiple hooks at the same point.
InstrumentationTarget	getTarget()
boolean	isEnabled()
boolean	isPassAllParameters()
boolean	isPassClassName()
boolean	isPassMethodName()
boolean	isPassThis()
static MethodEntryHook	simple(String hookOwner, String hookName, String hookDescriptor)	Creates a hook that calls a static method with no filters and no extra arguments.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getHookDescriptor

public HookDescriptor getHookDescriptor()

Specified by:

getHookDescriptor in interface Hook

Returns:

the hook descriptor

getFilters

public List<InstrumentationFilter> getFilters()

Specified by:

getFilters in interface Hook

Returns:

the filters

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Hook

Returns:

whether enabled

getPriority

public int getPriority()

Description copied from interface: Hook

Gets the priority for ordering multiple hooks at the same point.

Specified by:

getPriority in interface Hook

Returns:

the priority

isPassThis

public boolean isPassThis()

Returns:

true if the receiver, null for static methods, is passed to the hook

isPassMethodName

public boolean isPassMethodName()

Returns:

true if the instrumented method's name is passed to the hook

isPassClassName

public boolean isPassClassName()

Returns:

true if the instrumented class's name is passed to the hook

isPassAllParameters

public boolean isPassAllParameters()

Returns:

true if every parameter is passed to the hook as one Object array

getParameterIndices

public List<Integer> getParameterIndices()

Returns:

the individual parameter positions to pass, boxed when primitive

getTarget

public InstrumentationTarget getTarget()

Specified by:

getTarget in interface Hook

Returns:

the target type of this hook

simple

public static MethodEntryHook simple(String hookOwner,
                                     String hookName,
                                     String hookDescriptor)

Creates a hook that calls a static method with no filters and no extra arguments.

Parameters:

hookOwner - the internal name of the class declaring the hook method

hookName - the hook method name

hookDescriptor - the hook method descriptor

Returns:

the configured hook

builder

public static MethodEntryHook.Builder builder()

Returns:

a new builder with default settings