net.bytebuddy.instrumentation

Class FixedValue.ForStaticField

java.lang.Object

net.bytebuddy.instrumentation.FixedValue

net.bytebuddy.instrumentation.FixedValue.ForStaticField

All Implemented Interfaces:

FixedValue.AssignerConfigurable, Instrumentation, TypeInitializer

Enclosing class:

FixedValue

protected static class FixedValue.ForStaticField
extends FixedValue
implements FixedValue.AssignerConfigurable, TypeInitializer

A fixed value instrumentation that represents its fixed value as a static field of the instrumented class.

Nested Class Summary

Nested classes/interfaces inherited from class net.bytebuddy.instrumentation.FixedValue

FixedValue.AssignerConfigurable, FixedValue.ForPoolValue, FixedValue.ForStaticField

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

Instrumentation.Compound, Instrumentation.Context, Instrumentation.ForAbstractMethod

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

TypeInitializer.Compound, TypeInitializer.NoOp

Field Summary

Fields inherited from class net.bytebuddy.instrumentation.FixedValue

assigner, considerRuntimeType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ForStaticField(Object fixedValue, Assigner assigner, boolean considerRuntimeType) Creates a new static field fixed value instrumentation with a random name for the field containing the fixed value.
protected	ForStaticField(String fieldName, Object fixedValue, Assigner assigner, boolean considerRuntimeType) Creates a new static field fixed value instrumentation.

Method Summary

Modifier and Type	Method and Description
ByteCodeAppender	appender(TypeDescription instrumentedType) Creates a byte code appender that determines the implementation of the instrumented type's methods.
boolean	equals(Object other)
int	hashCode()
boolean	isAlive() Indicates if this initializer is alive and needs to be invoked.
void	onLoad(Class<?> type) Callback that is invoked on the creation of an instrumented type.
InstrumentedType	prepare(InstrumentedType instrumentedType) During the preparation phase of an instrumentation, implementations are eligible to adding fields or methods to the currently instrumented type.
String	toString()
Instrumentation	withAssigner(Assigner assigner, boolean considerRuntimeType) Defines an explicit assigner to this fixed value instrumentation.

Methods inherited from class net.bytebuddy.instrumentation.FixedValue

apply, reference, reference, value

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ForStaticField

protected ForStaticField(Object fixedValue,
                         Assigner assigner,
                         boolean considerRuntimeType)

Creates a new static field fixed value instrumentation with a random name for the field containing the fixed value.

Parameters:

fixedValue - The fixed value to be returned.

assigner - The assigner to use for assigning the fixed value to the return type of the instrumented value.

considerRuntimeType - If true, the runtime type of the given value will be considered for assigning the return type.

ForStaticField

protected ForStaticField(String fieldName,
                         Object fixedValue,
                         Assigner assigner,
                         boolean considerRuntimeType)

Creates a new static field fixed value instrumentation.

Parameters:

fieldName - The name of the field for storing the fixed value.

fixedValue - The fixed value to be returned.

assigner - The assigner to use for assigning the fixed value to the return type of the instrumented value.

considerRuntimeType - If true, the runtime type of the given value will be considered for assigning the return type.

Method Detail

withAssigner

public Instrumentation withAssigner(Assigner assigner,
                                    boolean considerRuntimeType)

Description copied from interface: FixedValue.AssignerConfigurable

Defines an explicit assigner to this fixed value instrumentation.

Specified by:

withAssigner in interface FixedValue.AssignerConfigurable

Parameters:

assigner - The assigner to use for assigning the fixed value to the return type of the instrumented value.

considerRuntimeType - If true, the runtime type of the given value will be considered for assigning the return type.

Returns:

A fixed value instrumentation that makes use of the given assigner.

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.type.TypeDescription) call. On this method call, 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(TypeDescription instrumentedType)

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:

instrumentedType - The instrumented type that is to be created.

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).

onLoad

public void onLoad(Class<?> type)

Description copied from interface: TypeInitializer

Callback that is invoked on the creation of an instrumented type. If the type initializer is alive, this method should be implemented empty instead of throwing an exception.

Specified by:

onLoad in interface TypeInitializer

Parameters:

type - The manifestation of the instrumented type.

isAlive

public boolean isAlive()

Description copied from interface: TypeInitializer

Indicates if this initializer is alive and needs to be invoked.

Specified by:

isAlive in interface TypeInitializer

Returns:

true if this initializer is alive.

equals

public boolean equals(Object other)

Overrides:

equals in class FixedValue

hashCode

public int hashCode()

Overrides:

hashCode in class FixedValue

toString

public String toString()

Overrides:

toString in class Object