net.bytebuddy.asm

Enum Advice.Dispatcher.OffsetMapping.ForEnterValue

java.lang.Object

java.lang.Enum<Advice.Dispatcher.OffsetMapping.ForEnterValue>

net.bytebuddy.asm.Advice.Dispatcher.OffsetMapping.ForEnterValue

All Implemented Interfaces:

Serializable, Comparable<Advice.Dispatcher.OffsetMapping.ForEnterValue>, Advice.Dispatcher.OffsetMapping

Enclosing interface:

Advice.Dispatcher.OffsetMapping

public static enum Advice.Dispatcher.OffsetMapping.ForEnterValue
extends Enum<Advice.Dispatcher.OffsetMapping.ForEnterValue>
implements Advice.Dispatcher.OffsetMapping

An offset mapping that provides access to the value that is returned by the enter advice.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Advice.Dispatcher.OffsetMapping.ForEnterValue.Factory A factory for creating a Advice.Dispatcher.OffsetMapping.ForEnterValue offset mapping.

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

Advice.Dispatcher.OffsetMapping.Context, Advice.Dispatcher.OffsetMapping.ForBoxedArguments, Advice.Dispatcher.OffsetMapping.ForBoxedReturnValue, Advice.Dispatcher.OffsetMapping.ForEnterValue, Advice.Dispatcher.OffsetMapping.ForField, Advice.Dispatcher.OffsetMapping.ForIgnored, Advice.Dispatcher.OffsetMapping.ForInstrumentedType, Advice.Dispatcher.OffsetMapping.ForOrigin, Advice.Dispatcher.OffsetMapping.ForParameter, Advice.Dispatcher.OffsetMapping.ForReturnValue, Advice.Dispatcher.OffsetMapping.ForThisReference, Advice.Dispatcher.OffsetMapping.ForThrowable, Advice.Dispatcher.OffsetMapping.ForUserValue<T extends Annotation>, Advice.Dispatcher.OffsetMapping.Illegal, Advice.Dispatcher.OffsetMapping.Target

Enum Constant Summary

Enum Constants

Enum Constant and Description
READ_ONLY Only allows for reading the mapped offset.
WRITABLE Enables writing to the mapped offset.

Method Summary

Modifier and Type	Method and Description
static Advice.Dispatcher.OffsetMapping	of(boolean readOnly) Resolves an offset mapping for an enter value.
Advice.Dispatcher.OffsetMapping.Target	resolve(MethodDescription.InDefinedShape instrumentedMethod, Advice.Dispatcher.OffsetMapping.Context context) Resolves an offset mapping to a given target offset.
String	toString()
static Advice.Dispatcher.OffsetMapping.ForEnterValue	valueOf(String name) Returns the enum constant of this type with the specified name.
static Advice.Dispatcher.OffsetMapping.ForEnterValue[]	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

WRITABLE

public static final Advice.Dispatcher.OffsetMapping.ForEnterValue WRITABLE

Enables writing to the mapped offset.

READ_ONLY

public static final Advice.Dispatcher.OffsetMapping.ForEnterValue READ_ONLY

Only allows for reading the mapped offset.

Method Detail

values

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

public static Advice.Dispatcher.OffsetMapping of(boolean readOnly)

Resolves an offset mapping for an enter value.

Parameters:

readOnly - true if the value is to be treated as read-only.

Returns:

An appropriate offset mapping.

resolve

public Advice.Dispatcher.OffsetMapping.Target resolve(MethodDescription.InDefinedShape instrumentedMethod,
                                                      Advice.Dispatcher.OffsetMapping.Context context)

Description copied from interface: Advice.Dispatcher.OffsetMapping

Resolves an offset mapping to a given target offset.

Specified by:

resolve in interface Advice.Dispatcher.OffsetMapping

Parameters:

instrumentedMethod - The instrumented method for which the mapping is to be resolved.

context - The context in which the offset mapping is applied.

Returns:

A suitable target mapping.

toString

public String toString()

Overrides:

toString in class Enum<Advice.Dispatcher.OffsetMapping.ForEnterValue>