Package com.tonic.analysis.instrumentation.hook

Class FieldWriteHook

java.lang.Object

com.tonic.analysis.instrumentation.hook.FieldWriteHook

All Implemented Interfaces:

Hook

public class FieldWriteHook
extends Object
implements Hook

Configuration for field write instrumentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldWriteHook.Builder	Builder for FieldWriteHook, defaulting to enabled, priority 100, no values passed, and both static and instance writes instrumented.

Method Summary

Modifier and Type	Method	Description
static FieldWriteHook.Builder	builder()
List<InstrumentationFilter>	getFilters()
HookDescriptor	getHookDescriptor()
int	getPriority()	Gets the priority for ordering multiple hooks at the same point.
InstrumentationTarget	getTarget()
boolean	isCanModifyValue()
boolean	isEnabled()
boolean	isInstrumentInstance()
boolean	isInstrumentStatic()
boolean	isPassFieldName()
boolean	isPassNewValue()
boolean	isPassOldValue()
boolean	isPassOwner()
static FieldWriteHook	simple(String hookOwner, String hookName, String hookDescriptor)	Creates a hook with default settings that calls a static method.

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

isPassOwner

public boolean isPassOwner()

Returns:

whether the field's owning object (null for static fields) is passed to the hook

isPassFieldName

public boolean isPassFieldName()

Returns:

whether the field name is passed to the hook

isPassNewValue

public boolean isPassNewValue()

Returns:

whether the new value being written (boxed if primitive) is passed to the hook

isPassOldValue

public boolean isPassOldValue()

Returns:

whether the old value (requires an additional load) is passed to the hook

isCanModifyValue

public boolean isCanModifyValue()

Returns:

whether the hook can replace the value being written (by returning a new one)

isInstrumentStatic

public boolean isInstrumentStatic()

Returns:

whether static field writes are instrumented

isInstrumentInstance

public boolean isInstrumentInstance()

Returns:

whether instance field writes are instrumented

getTarget

public InstrumentationTarget getTarget()

Specified by:

getTarget in interface Hook

Returns:

the target type of this hook

simple

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

Creates a hook with default settings that calls a static method.

Parameters:

hookOwner - 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 FieldWriteHook.Builder builder()

Returns:

a new builder