Package com.tonic.analysis.instrumentation

Class Instrumenter.FieldWriteHookBuilder

java.lang.Object

com.tonic.analysis.instrumentation.Instrumenter.FieldWriteHookBuilder

Enclosing class:

Instrumenter

public static class Instrumenter.FieldWriteHookBuilder
extends Object

Fluent builder for a field write hook.

Method Summary

Modifier and Type	Method	Description
Instrumenter.FieldWriteHookBuilder	allowModification()	Lets the hook replace the value written.
Instrumenter.FieldWriteHookBuilder	callStatic(String owner, String name, String descriptor)	Sets the static method the hook dispatches to.
Instrumenter.FieldWriteHookBuilder	forField(String fieldName)	Restricts this hook to one field name.
Instrumenter.FieldWriteHookBuilder	forFieldsMatching(String pattern)	Restricts this hook to fields whose name matches a pattern.
Instrumenter.FieldWriteHookBuilder	inClass(String className)	Restricts this hook to a single class.
Instrumenter.FieldWriteHookBuilder	inPackage(String packagePrefix)	Restricts this hook to classes under a package.
Instrumenter.FieldWriteHookBuilder	instanceOnly()	Instruments instance field writes only.
Instrumenter.FieldWriteHookBuilder	ofType(String descriptor)	Restricts this hook to fields of one type.
Instrumenter.FieldWriteHookBuilder	priority(int priority)	Sets the ordering priority of this hook against others at the same site.
Instrumenter	register()	Attaches the collected filters and registers the hook.
Instrumenter.FieldWriteHookBuilder	staticOnly()	Instruments static field writes only.
Instrumenter.FieldWriteHookBuilder	withFieldName()	Passes the field name as a hook argument.
Instrumenter.FieldWriteHookBuilder	withNewValue()	Passes the value being written as a hook argument.
Instrumenter.FieldWriteHookBuilder	withOldValue()	Passes the field's prior value as a hook argument.
Instrumenter.FieldWriteHookBuilder	withOwner()	Passes the field owner as a hook argument.

Methods inherited from class java.lang.Object

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

Method Detail

inClass

public Instrumenter.FieldWriteHookBuilder inClass(String className)

Restricts this hook to a single class.

Parameters:

className - the internal class name

Returns:

this builder

inPackage

public Instrumenter.FieldWriteHookBuilder inPackage(String packagePrefix)

Restricts this hook to classes under a package.

Parameters:

packagePrefix - the internal package name prefix

Returns:

this builder

forField

public Instrumenter.FieldWriteHookBuilder forField(String fieldName)

Restricts this hook to one field name.

Parameters:

fieldName - the field name

Returns:

this builder

forFieldsMatching

public Instrumenter.FieldWriteHookBuilder forFieldsMatching(String pattern)

Restricts this hook to fields whose name matches a pattern.

Parameters:

pattern - the field name pattern

Returns:

this builder

ofType

public Instrumenter.FieldWriteHookBuilder ofType(String descriptor)

Restricts this hook to fields of one type.

Parameters:

descriptor - the field descriptor

Returns:

this builder

staticOnly

public Instrumenter.FieldWriteHookBuilder staticOnly()

Instruments static field writes only.

Returns:

this builder

instanceOnly

public Instrumenter.FieldWriteHookBuilder instanceOnly()

Instruments instance field writes only.

Returns:

this builder

callStatic

public Instrumenter.FieldWriteHookBuilder callStatic(String owner,
                                                     String name,
                                                     String descriptor)

Sets the static method the hook dispatches to.

Parameters:

owner - internal name of the class declaring the hook method

name - the hook method name

descriptor - the hook method descriptor

Returns:

this builder

withOwner

public Instrumenter.FieldWriteHookBuilder withOwner()

Passes the field owner as a hook argument.

Returns:

this builder

withFieldName

public Instrumenter.FieldWriteHookBuilder withFieldName()

Passes the field name as a hook argument.

Returns:

this builder

withNewValue

public Instrumenter.FieldWriteHookBuilder withNewValue()

Passes the value being written as a hook argument.

Returns:

this builder

withOldValue

public Instrumenter.FieldWriteHookBuilder withOldValue()

Passes the field's prior value as a hook argument.

Returns:

this builder

allowModification

public Instrumenter.FieldWriteHookBuilder allowModification()

Lets the hook replace the value written.

Returns:

this builder

priority

public Instrumenter.FieldWriteHookBuilder priority(int priority)

Sets the ordering priority of this hook against others at the same site.

Parameters:

priority - the priority value

Returns:

this builder

register

public Instrumenter register()

Attaches the collected filters and registers the hook.

Returns:

the instrumenter this builder came from