net.bytebuddy.asm

Enum Advice.Dispatcher.Inactive

java.lang.Object

java.lang.Enum<Advice.Dispatcher.Inactive>

net.bytebuddy.asm.Advice.Dispatcher.Inactive

All Implemented Interfaces:

Serializable, Comparable<Advice.Dispatcher.Inactive>, Advice.Dispatcher, Advice.Dispatcher.Bound, Advice.Dispatcher.Resolved, Advice.Dispatcher.Resolved.ForMethodEnter, Advice.Dispatcher.Resolved.ForMethodExit, Advice.Dispatcher.Unresolved

Enclosing interface:

Advice.Dispatcher

public static enum Advice.Dispatcher.Inactive
extends Enum<Advice.Dispatcher.Inactive>
implements Advice.Dispatcher.Unresolved, Advice.Dispatcher.Resolved.ForMethodEnter, Advice.Dispatcher.Resolved.ForMethodExit, Advice.Dispatcher.Bound

An implementation for inactive devise that does not write any byte code.

Nested Class Summary

Nested classes/interfaces inherited from interface net.bytebuddy.asm.Advice.Dispatcher.Resolved

Advice.Dispatcher.Resolved.ForMethodEnter, Advice.Dispatcher.Resolved.ForMethodExit

Nested classes/interfaces inherited from interface net.bytebuddy.asm.Advice.Dispatcher

Advice.Dispatcher.Active, Advice.Dispatcher.Bound, Advice.Dispatcher.Inactive, Advice.Dispatcher.OffsetMapping, Advice.Dispatcher.Resolved, Advice.Dispatcher.Unresolved

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton instance.

Field Summary

Fields inherited from interface net.bytebuddy.asm.Advice.Dispatcher

IGNORE_ANNOTATION, IGNORE_METHOD

Method Summary

Modifier and Type	Method and Description
void	apply() Writes the advice method's code.
Advice.Dispatcher.Resolved.ForMethodEnter	asMethodEnter(List<? extends Advice.Dispatcher.OffsetMapping.Factory> userFactories) Resolves this dispatcher as a dispatcher for entering a method.
Advice.Dispatcher.Resolved.ForMethodExit	asMethodExitTo(List<? extends Advice.Dispatcher.OffsetMapping.Factory> userFactories, Advice.Dispatcher.Resolved.ForMethodEnter dispatcher) Resolves this dispatcher as a dispatcher for exiting a method.
Advice.Dispatcher.Bound	bind(MethodDescription.InDefinedShape instrumentedMethod, MethodVisitor methodVisitor, Advice.MetaDataHandler.ForInstrumentedMethod metaDataHandler, ClassReader classReader) Binds this dispatcher for resolution to a specific method.
TypeDescription	getEnterType() Returns the type that this dispatcher supplies as a result of its advice or a description of void if no type is supplied as a result of the enter advice.
boolean	isAlive() Returns true if this dispatcher is alive.
boolean	isSkipThrowable() Indicates if this advice requires to be called when the instrumented method terminates exceptionally.
void	prepare() Prepares the advice method's exception handlers.
String	toString()
static Advice.Dispatcher.Inactive	valueOf(String name) Returns the enum constant of this type with the specified name.
static Advice.Dispatcher.Inactive[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final Advice.Dispatcher.Inactive INSTANCE

The singleton instance.

Method Detail

values

public static Advice.Dispatcher.Inactive[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Advice.Dispatcher.Inactive c : Advice.Dispatcher.Inactive.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Advice.Dispatcher.Inactive valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isAlive

public boolean isAlive()

Description copied from interface: Advice.Dispatcher

Returns true if this dispatcher is alive.

Specified by:

isAlive in interface Advice.Dispatcher

Returns:

true if this dispatcher is alive.

isSkipThrowable

public boolean isSkipThrowable()

Description copied from interface: Advice.Dispatcher.Resolved.ForMethodExit

Indicates if this advice requires to be called when the instrumented method terminates exceptionally.

Specified by:

isSkipThrowable in interface Advice.Dispatcher.Resolved.ForMethodExit

Returns:

true if this advice requires to be called when the instrumented method terminates exceptionally.

getEnterType

public TypeDescription getEnterType()

Description copied from interface: Advice.Dispatcher.Resolved.ForMethodEnter

Returns the type that this dispatcher supplies as a result of its advice or a description of void if no type is supplied as a result of the enter advice.

Specified by:

getEnterType in interface Advice.Dispatcher.Resolved.ForMethodEnter

Returns:

The type that this dispatcher supplies as a result of its advice or a description of void.

asMethodEnter

public Advice.Dispatcher.Resolved.ForMethodEnter asMethodEnter(List<? extends Advice.Dispatcher.OffsetMapping.Factory> userFactories)

Description copied from interface: Advice.Dispatcher.Unresolved

Resolves this dispatcher as a dispatcher for entering a method.

Specified by:

asMethodEnter in interface Advice.Dispatcher.Unresolved

Parameters:

userFactories - A list of custom factories for binding parameters of an advice method.

Returns:

This dispatcher as a dispatcher for entering a method.

asMethodExitTo

public Advice.Dispatcher.Resolved.ForMethodExit asMethodExitTo(List<? extends Advice.Dispatcher.OffsetMapping.Factory> userFactories,
                                                               Advice.Dispatcher.Resolved.ForMethodEnter dispatcher)

Description copied from interface: Advice.Dispatcher.Unresolved

Resolves this dispatcher as a dispatcher for exiting a method.

Specified by:

asMethodExitTo in interface Advice.Dispatcher.Unresolved

Parameters:

userFactories - A list of custom factories for binding parameters of an advice method.

dispatcher - The dispatcher for entering a method.

Returns:

This dispatcher as a dispatcher for exiting a method.

prepare

public void prepare()

Description copied from interface: Advice.Dispatcher.Bound

Prepares the advice method's exception handlers.

Specified by:

prepare in interface Advice.Dispatcher.Bound

apply

public void apply()

Description copied from interface: Advice.Dispatcher.Bound

Writes the advice method's code.

Specified by:

apply in interface Advice.Dispatcher.Bound

bind

public Advice.Dispatcher.Bound bind(MethodDescription.InDefinedShape instrumentedMethod,
                                    MethodVisitor methodVisitor,
                                    Advice.MetaDataHandler.ForInstrumentedMethod metaDataHandler,
                                    ClassReader classReader)

Description copied from interface: Advice.Dispatcher.Resolved

Binds this dispatcher for resolution to a specific method.

Specified by:

bind in interface Advice.Dispatcher.Resolved

Parameters:

instrumentedMethod - The instrumented method.

methodVisitor - The method visitor for writing the instrumented method.

metaDataHandler - A meta data handler for writing to the instrumented method.

classReader - A class reader for parsing the class file containing the represented advice method.

Returns:

A dispatcher that is bound to the instrumented method.

toString

public String toString()

Overrides:

toString in class Enum<Advice.Dispatcher.Inactive>