net.bytebuddy.instrumentation

Enum SuperMethodCall

java.lang.Object

java.lang.Enum<SuperMethodCall>

net.bytebuddy.instrumentation.SuperMethodCall

All Implemented Interfaces:

Serializable, Comparable<SuperMethodCall>, Instrumentation

public enum SuperMethodCall
extends Enum<SuperMethodCall>
implements Instrumentation

This instrumentation will create a new method which simply calls its super method. If no such method is defined, an exception will be thrown. Constructors are considered to have a super method if the direct super class defines a constructor with an identical signature. Default methods are invoked as such if they are non-ambiguous. Static methods can have a (pseudo) super method if a type that defines such a method is rebased. Rebased types can also shadow constructors or methods of an actual super class. Besides implementing constructors, this instrumentation is useful when a method of a super type is not supposed to be altered but should be equipped with additional annotations. Furthermore, this instrumentation allows to hard code a super method call to be performed after performing another Instrumentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SuperMethodCall.Appender An appender for implementing a SuperMethodCall.
protected static class	SuperMethodCall.WithoutReturn A super method invocation where the return value is dropped instead of returning from the method.

Nested classes/interfaces inherited from interface net.bytebuddy.instrumentation.Instrumentation

Instrumentation.Compound, Instrumentation.Context, Instrumentation.ForAbstractMethod, Instrumentation.Simple, Instrumentation.SpecialMethodInvocation, Instrumentation.Target

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton instance.

Method Summary

Modifier and Type	Method and Description
Instrumentation	andThen(Instrumentation instrumentation) Appends another instrumentation to a super method call.
ByteCodeAppender	appender(Instrumentation.Target instrumentationTarget) Creates a byte code appender that determines the implementation of the instrumented type's methods.
InstrumentedType	prepare(InstrumentedType instrumentedType) During the preparation phase of an instrumentation, implementations are eligible to adding fields or methods to the currently instrumented type.
static SuperMethodCall	valueOf(String name) Returns the enum constant of this type with the specified name.
static SuperMethodCall[]	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 SuperMethodCall INSTANCE

The singleton instance.

Method Detail

values

public static SuperMethodCall[] 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 (SuperMethodCall c : SuperMethodCall.values())
    System.out.println(c);

Returns:

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

valueOf

public static SuperMethodCall 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

prepare

public InstrumentedType prepare(InstrumentedType instrumentedType)

Description copied from interface: Instrumentation

During the preparation phase of an instrumentation, implementations are eligible to adding fields or methods to the currently instrumented type. All methods that are added by this instrumentation are required to be implemented by the ByteCodeAppender that is emitted on the call to Instrumentation.appender(net.bytebuddy.instrumentation.Instrumentation.Target) call. On this method call, loaded type initializers can also be added to the instrumented type.

Specified by:

prepare in interface Instrumentation

Parameters:

instrumentedType - The instrumented type that is the basis of the ongoing instrumentation.

Returns:

The instrumented type with any applied changes, if any.

appender

public ByteCodeAppender appender(Instrumentation.Target instrumentationTarget)

Description copied from interface: Instrumentation

Creates a byte code appender that determines the implementation of the instrumented type's methods.

Specified by:

appender in interface Instrumentation

Parameters:

instrumentationTarget - The target of the current instrumentation.

Returns:

A byte code appender for implementing methods delegated to this instrumentation. This byte code appender is also responsible for handling methods that were added by this instrumentation on the call to Instrumentation.prepare(net.bytebuddy.instrumentation.type.InstrumentedType).

andThen

public Instrumentation andThen(Instrumentation instrumentation)

Appends another instrumentation to a super method call.

Parameters:

instrumentation - The instrumentation to append.

Returns:

An instrumentation that first invokes the instrumented method's super method and then applies the given instrumentation.