net.bytebuddy.asm

Enum Advice.OffsetMapping.ForThrowable.Factory

java.lang.Object

java.lang.Enum<Advice.OffsetMapping.ForThrowable.Factory>

net.bytebuddy.asm.Advice.OffsetMapping.ForThrowable.Factory

All Implemented Interfaces:

Serializable, Comparable<Advice.OffsetMapping.ForThrowable.Factory>, Advice.OffsetMapping.Factory<Advice.Thrown>

Enclosing class:

Advice.OffsetMapping.ForThrowable

protected static enum Advice.OffsetMapping.ForThrowable.Factory
extends Enum<Advice.OffsetMapping.ForThrowable.Factory>
implements Advice.OffsetMapping.Factory<Advice.Thrown>

A factory for accessing an exception that was thrown by the instrumented method.

Nested Class Summary

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

Advice.OffsetMapping.Factory.AdviceType, Advice.OffsetMapping.Factory.Illegal<T extends Annotation>, Advice.OffsetMapping.Factory.Simple<T extends Annotation>

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton instance.

Method Summary

Modifier and Type	Method and Description
Class<Advice.Thrown>	getAnnotationType() Returns the annotation type of this factory.
Advice.OffsetMapping	make(ParameterDescription.InDefinedShape target, AnnotationDescription.Loadable<Advice.Thrown> annotation, Advice.OffsetMapping.Factory.AdviceType adviceType) Creates a new offset mapping for the supplied parameter if possible.
protected static Advice.OffsetMapping.Factory<?>	of(MethodDescription.InDefinedShape adviceMethod) Resolves an appropriate offset mapping factory for the Advice.Thrown parameter annotation.
static Advice.OffsetMapping.ForThrowable.Factory	valueOf(String name) Returns the enum constant of this type with the specified name.
static Advice.OffsetMapping.ForThrowable.Factory[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final Advice.OffsetMapping.ForThrowable.Factory INSTANCE

The singleton instance.

Method Detail

values

public static Advice.OffsetMapping.ForThrowable.Factory[] 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.OffsetMapping.ForThrowable.Factory c : Advice.OffsetMapping.ForThrowable.Factory.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.OffsetMapping.ForThrowable.Factory 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

of

protected static Advice.OffsetMapping.Factory<?> of(MethodDescription.InDefinedShape adviceMethod)

Resolves an appropriate offset mapping factory for the Advice.Thrown parameter annotation.

Parameters:

adviceMethod - The exit advice method, annotated with Advice.OnMethodExit.

Returns:

An appropriate offset mapping factory.

getAnnotationType

public Class<Advice.Thrown> getAnnotationType()

Returns the annotation type of this factory.

Specified by:

getAnnotationType in interface Advice.OffsetMapping.Factory<Advice.Thrown>

Returns:

The factory's annotation type.

make

public Advice.OffsetMapping make(ParameterDescription.InDefinedShape target,
                                 AnnotationDescription.Loadable<Advice.Thrown> annotation,
                                 Advice.OffsetMapping.Factory.AdviceType adviceType)

Creates a new offset mapping for the supplied parameter if possible.

Specified by:

make in interface Advice.OffsetMapping.Factory<Advice.Thrown>

Parameters:

target - The parameter description for which to resolve an offset mapping.

annotation - The annotation that triggered this factory.

adviceType - true if the binding is applied using advice method delegation.

Returns:

A resolved offset mapping or null if no mapping can be resolved for this parameter.