net.bytebuddy.instrumentation

Enum StubMethod

java.lang.Object

java.lang.Enum<StubMethod>

net.bytebuddy.instrumentation.StubMethod

All Implemented Interfaces:

Serializable, Comparable<StubMethod>, Instrumentation, ByteCodeAppender

public enum StubMethod
extends Enum<StubMethod>
implements Instrumentation, ByteCodeAppender

This instrumentation creates a method stub which does nothing but returning the default value of the return type of the method. These default values are:

1. The value 0 for all numeric type.
2. The null character for the char type.
3. false for the boolean type.
4. Nothing for void types.
5. A null reference for any reference types. Note that this includes primitive wrapper types.

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface net.bytebuddy.instrumentation.method.bytecode.ByteCodeAppender

ByteCodeAppender.Compound, ByteCodeAppender.Simple, ByteCodeAppender.Size

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton instance.

Method Summary

Modifier and Type	Method and Description
ByteCodeAppender	appender(Instrumentation.Target instrumentationTarget) Creates a byte code appender that determines the implementation of the instrumented type's methods.
boolean	appendsCode() Determines if this byte code appender offers an (possibly empty) implementation of a method.
ByteCodeAppender.Size	apply(org.objectweb.asm.MethodVisitor methodVisitor, Instrumentation.Context instrumentationContext, MethodDescription instrumentedMethod) Applies this byte code appender to a type creation process.
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 StubMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static StubMethod[]	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 StubMethod INSTANCE

The singleton instance.

Method Detail

values

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

Returns:

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

valueOf

public static StubMethod 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).

appendsCode

public boolean appendsCode()

Description copied from interface: ByteCodeAppender

Determines if this byte code appender offers an (possibly empty) implementation of a method.

Specified by:

appendsCode in interface ByteCodeAppender

Returns:

true if this byte code appender requires this method to be implemented or false if this appender describes an abstract method.

apply

public ByteCodeAppender.Size apply(org.objectweb.asm.MethodVisitor methodVisitor,
                                   Instrumentation.Context instrumentationContext,
                                   MethodDescription instrumentedMethod)

Description copied from interface: ByteCodeAppender

Applies this byte code appender to a type creation process.

Specified by:

apply in interface ByteCodeAppender

Parameters:

methodVisitor - The method visitor to which the byte code appender writes its code to.

instrumentationContext - The instrumentation context of the current type creation process.

instrumentedMethod - The method that is the target of the instrumentation.

Returns:

The required size for the applied byte code to run.