HookDescriptor (YABR)

tonic@yabr:~$ Source Portfolio tonicbox.dev

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

```
public class HookDescriptor
extends Object
```
Describes a hook method to be called at instrumentation points.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`HookDescriptor.Builder`	Builder for HookDescriptor instances.
`static class`	`HookDescriptor.HookParameter`	Types of parameters that can be passed to hooks.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static HookDescriptor.Builder`	`builder()`	Creates a new builder.
`String`	`getDescriptor()`
`InvokeType`	`getInvokeType()`
`String`	`getName()`
`String`	`getOwner()`
`List<HookDescriptor.HookParameter>`	`getParameters()`
`boolean`	`isReplacesValue()`
`static HookDescriptor`	`staticHook(String owner, String name, String descriptor)`	Creates a descriptor for a static hook method.

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

- Method Detail
  - getOwner
```
public String getOwner()
```
    Returns:
    
    the owner class of the hook method (internal name, e.g. "com/example/Hooks")
  - getName
```
public String getName()
```
    Returns:
    
    the name of the hook method
  - getDescriptor
```
public String getDescriptor()
```
    Returns:
    
    the hook method descriptor
  - getInvokeType
```
public InvokeType getInvokeType()
```
    Returns:
    
    the invocation type (typically STATIC)
  - getParameters
```
public List<HookDescriptor.HookParameter> getParameters()
```
    Returns:
    
    the parameters to pass to the hook method
  - isReplacesValue
```
public boolean isReplacesValue()
```
    Returns:
    
    whether the hook's return value should replace the original value
  - staticHook
```
public static HookDescriptor staticHook(String owner,
                                        String name,
                                        String descriptor)
```
    Creates a descriptor for a static hook method.
    
    Parameters:
    
    owner - the hook class internal name
    
    name - the hook method name
    
    descriptor - the hook method descriptor
    
    Returns:
    
    the descriptor
  - builder
```
public static HookDescriptor.Builder builder()
```
    Creates a new builder.
    
    Returns:
    
    a new Builder