java.lang.Object
- com.tonic.analysis.instrumentation.Instrumenter

```
public class Instrumenter
extends Object
```
Fluent entry point for registering instrumentation hooks and applying them to a set of classes.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Instrumenter.ArrayLoadHookBuilder`	Fluent builder for an array load hook.
`static class`	`Instrumenter.ArrayStoreHookBuilder`	Fluent builder for an array store hook.
`static class`	`Instrumenter.ExceptionHookBuilder`	Fluent builder for an exception handler hook.
`static class`	`Instrumenter.FieldReadHookBuilder`	Fluent builder for a field read hook.
`static class`	`Instrumenter.FieldWriteHookBuilder`	Fluent builder for a field write hook.
`static class`	`Instrumenter.InstrumentationReport`	Immutable counts from one instrumentation run.
`static class`	`Instrumenter.MethodCallHookBuilder`	Fluent builder for a method call hook.
`static class`	`Instrumenter.MethodEntryHookBuilder`	Fluent builder for a method entry hook.
`static class`	`Instrumenter.MethodExitHookBuilder`	Fluent builder for a method exit hook.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`apply()`	Applies all registered hooks to the target classes.
`Instrumenter.InstrumentationReport`	`applyWithReport()`	Applies all registered hooks and records the result as the last report.
`Instrumenter`	`failOnError(boolean fail)`	Sets whether a failure to instrument a method is rethrown instead of counted.
`static Instrumenter`	`forClass(ClassFile classFile)`	Creates an instrumenter targeting one class.
`static Instrumenter`	`forClasses(ClassFile... classes)`	Creates an instrumenter targeting the given classes.
`static Instrumenter`	`forClasses(List<ClassFile> classes)`	Creates an instrumenter targeting a list of classes.
`static Instrumenter`	`forClassPool(ClassPool pool)`	Creates an instrumenter targeting every class in a pool.
`Instrumenter.InstrumentationReport`	`getLastReport()`
`Instrumenter.ArrayLoadHookBuilder`	`onArrayLoad()`
`Instrumenter.ArrayStoreHookBuilder`	`onArrayStore()`
`Instrumenter.ExceptionHookBuilder`	`onException()`
`Instrumenter.FieldReadHookBuilder`	`onFieldRead()`
`Instrumenter.FieldWriteHookBuilder`	`onFieldWrite()`
`Instrumenter.MethodCallHookBuilder`	`onMethodCall()`
`Instrumenter.MethodEntryHookBuilder`	`onMethodEntry()`
`Instrumenter.MethodExitHookBuilder`	`onMethodExit()`
`Instrumenter`	`skipAbstract(boolean skip)`	Sets whether abstract methods are left alone.
`Instrumenter`	`skipBridge(boolean skip)`	Sets whether bridge methods are left alone.
`Instrumenter`	`skipConstructors(boolean skip)`	Sets whether constructors are left alone.
`Instrumenter`	`skipNative(boolean skip)`	Sets whether native methods are left alone.
`Instrumenter`	`skipStaticInitializers(boolean skip)`	Sets whether static initializers are left alone.
`Instrumenter`	`skipSynthetic(boolean skip)`	Sets whether synthetic methods are left alone.
`Instrumenter`	`verbose(boolean verbose)`	Sets whether instrumentation failures are printed to stderr.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getLastReport
```
public Instrumenter.InstrumentationReport getLastReport()
```
    Returns:
    
    the last report
  - forClassPool
```
public static Instrumenter forClassPool(ClassPool pool)
```
    Creates an instrumenter targeting every class in a pool.
    
    Parameters:
    
    pool - the class pool
    
    Returns:
    
    a new instrumenter
  - forClass
```
public static Instrumenter forClass(ClassFile classFile)
```
    Creates an instrumenter targeting one class.
    
    Parameters:
    
    classFile - the class file to instrument
    
    Returns:
    
    a new instrumenter
  - forClasses
```
public static Instrumenter forClasses(List<ClassFile> classes)
```
    Creates an instrumenter targeting a list of classes.
    
    Parameters:
    
    classes - the class files to instrument
    
    Returns:
    
    a new instrumenter
  - forClasses
```
public static Instrumenter forClasses(ClassFile... classes)
```
    Creates an instrumenter targeting the given classes.
    
    Parameters:
    
    classes - the class files to instrument
    
    Returns:
    
    a new instrumenter
  - onMethodEntry
```
public Instrumenter.MethodEntryHookBuilder onMethodEntry()
```
    Returns:
    
    a builder for a hook that runs on entry to matching methods
  - onMethodExit
```
public Instrumenter.MethodExitHookBuilder onMethodExit()
```
    Returns:
    
    a builder for a hook that runs at every return of matching methods
  - onFieldWrite
```
public Instrumenter.FieldWriteHookBuilder onFieldWrite()
```
    Returns:
    
    a builder for a hook that runs at matching field writes
  - onFieldRead
```
public Instrumenter.FieldReadHookBuilder onFieldRead()
```
    Returns:
    
    a builder for a hook that runs at matching field reads
  - onArrayStore
```
public Instrumenter.ArrayStoreHookBuilder onArrayStore()
```
    Returns:
    
    a builder for a hook that runs at matching array stores
  - onArrayLoad
```
public Instrumenter.ArrayLoadHookBuilder onArrayLoad()
```
    Returns:
    
    a builder for a hook that runs at matching array loads
  - onMethodCall
```
public Instrumenter.MethodCallHookBuilder onMethodCall()
```
    Returns:
    
    a builder for a hook that runs around matching call sites
  - onException
```
public Instrumenter.ExceptionHookBuilder onException()
```
    Returns:
    
    a builder for a hook that runs in matching exception handlers
  - skipAbstract
```
public Instrumenter skipAbstract(boolean skip)
```
    Sets whether abstract methods are left alone.
    
    Parameters:
    
    skip - true to skip them
    
    Returns:
    
    this instrumenter
  - skipNative
```
public Instrumenter skipNative(boolean skip)
```
    Sets whether native methods are left alone.
    
    Parameters:
    
    skip - true to skip them
    
    Returns:
    
    this instrumenter
  - skipConstructors
```
public Instrumenter skipConstructors(boolean skip)
```
    Sets whether constructors are left alone.
    
    Parameters:
    
    skip - true to skip them
    
    Returns:
    
    this instrumenter
  - skipStaticInitializers
```
public Instrumenter skipStaticInitializers(boolean skip)
```
    Sets whether static initializers are left alone.
    
    Parameters:
    
    skip - true to skip them
    
    Returns:
    
    this instrumenter
  - skipSynthetic
```
public Instrumenter skipSynthetic(boolean skip)
```
    Sets whether synthetic methods are left alone.
    
    Parameters:
    
    skip - true to skip them
    
    Returns:
    
    this instrumenter
  - skipBridge
```
public Instrumenter skipBridge(boolean skip)
```
    Sets whether bridge methods are left alone.
    
    Parameters:
    
    skip - true to skip them
    
    Returns:
    
    this instrumenter
  - failOnError
```
public Instrumenter failOnError(boolean fail)
```
    Sets whether a failure to instrument a method is rethrown instead of counted.
    
    Parameters:
    
    fail - true to rethrow
    
    Returns:
    
    this instrumenter
  - verbose
```
public Instrumenter verbose(boolean verbose)
```
    Sets whether instrumentation failures are printed to stderr.
    
    Parameters:
    
    verbose - true to print
    
    Returns:
    
    this instrumenter
  - apply
```
public int apply()
```
    Applies all registered hooks to the target classes.
    
    Returns:
    
    the total number of instrumentation points applied
    
    Throws:
    
    RuntimeException - if a method fails to instrument and failOnError is set
  - applyWithReport
```
public Instrumenter.InstrumentationReport applyWithReport()
```
    Applies all registered hooks and records the result as the last report.
    
    Returns:
    
    counts of points, classes, methods, and failures
    
    Throws:
    
    RuntimeException - if a method fails to instrument and failOnError is set

Class Instrumenter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getLastReport

forClassPool

forClass

forClasses

forClasses

onMethodEntry

onMethodExit

onFieldWrite

onFieldRead

onArrayStore

onArrayLoad

onMethodCall

onException

skipAbstract

skipNative

skipConstructors

skipStaticInitializers

skipSynthetic

skipBridge

failOnError

verbose

apply

applyWithReport