Package com.tonic.analysis.instrumentation

Class Instrumenter.MethodExitHookBuilder

java.lang.Object

com.tonic.analysis.instrumentation.Instrumenter.MethodExitHookBuilder

Enclosing class:

Instrumenter

public static class Instrumenter.MethodExitHookBuilder
extends Object

Fluent builder for a method exit hook.

Method Summary

Modifier and Type	Method	Description
Instrumenter.MethodExitHookBuilder	allowModification()	Lets the hook replace the returned value.
Instrumenter.MethodExitHookBuilder	callStatic(String owner, String name, String descriptor)	Sets the static method the hook dispatches to.
Instrumenter.MethodExitHookBuilder	inClass(String className)	Restricts this hook to a single class.
Instrumenter.MethodExitHookBuilder	inPackage(String packagePrefix)	Restricts this hook to classes under a package.
Instrumenter.MethodExitHookBuilder	matchingMethod(String pattern)	Restricts this hook to methods whose name matches a pattern.
Instrumenter.MethodExitHookBuilder	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.MethodExitHookBuilder	withClassName()	Passes the enclosing class name as a hook argument.
Instrumenter.MethodExitHookBuilder	withMethodName()	Passes the instrumented method name as a hook argument.
Instrumenter.MethodExitHookBuilder	withReturnValue()	Passes the value being returned as a hook argument.
Instrumenter.MethodExitHookBuilder	withThis()	Passes the receiver 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.MethodExitHookBuilder inClass(String className)

Restricts this hook to a single class.

Parameters:

className - the internal class name

Returns:

this builder

inPackage

public Instrumenter.MethodExitHookBuilder inPackage(String packagePrefix)

Restricts this hook to classes under a package.

Parameters:

packagePrefix - the internal package name prefix

Returns:

this builder

matchingMethod

public Instrumenter.MethodExitHookBuilder matchingMethod(String pattern)

Restricts this hook to methods whose name matches a pattern.

Parameters:

pattern - the method name pattern

Returns:

this builder

callStatic

public Instrumenter.MethodExitHookBuilder 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

withThis

public Instrumenter.MethodExitHookBuilder withThis()

Passes the receiver as a hook argument.

Returns:

this builder

withClassName

public Instrumenter.MethodExitHookBuilder withClassName()

Passes the enclosing class name as a hook argument.

Returns:

this builder

withMethodName

public Instrumenter.MethodExitHookBuilder withMethodName()

Passes the instrumented method name as a hook argument.

Returns:

this builder

withReturnValue

public Instrumenter.MethodExitHookBuilder withReturnValue()

Passes the value being returned as a hook argument.

Returns:

this builder

allowModification

public Instrumenter.MethodExitHookBuilder allowModification()

Lets the hook replace the returned value.

Returns:

this builder

priority

public Instrumenter.MethodExitHookBuilder 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