https://bytebuddy.net/byte-buddy-dep: Byte Buddy is a Java library for creating Java classes at run time. This artifact is a build of Byte Buddy with a remaining dependency onto ASM. You should never depend on this module without repackaging Byte Buddy and ASM into your own namespace. 
/*
 * Copyright 2014 - 2020 Rafael Winterhalter
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.bytebuddy.implementation;

import net.bytebuddy.build.HashCodeAndEqualsPlugin;
import net.bytebuddy.description.field.FieldDescription;
import net.bytebuddy.description.method.MethodDescription;
import net.bytebuddy.description.method.ParameterDescription;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.dynamic.scaffold.InstrumentedType;
import net.bytebuddy.implementation.bytecode.ByteCodeAppender;
import net.bytebuddy.implementation.bytecode.StackManipulation;
import net.bytebuddy.implementation.bytecode.assign.Assigner;
import net.bytebuddy.implementation.bytecode.constant.*;
import net.bytebuddy.implementation.bytecode.member.FieldAccess;
import net.bytebuddy.implementation.bytecode.member.MethodReturn;
import net.bytebuddy.implementation.bytecode.member.MethodVariableAccess;
import net.bytebuddy.utility.JavaConstant;
import net.bytebuddy.utility.JavaType;
import net.bytebuddy.utility.RandomString;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;

import static net.bytebuddy.matcher.ElementMatchers.named;


This implementation returns a fixed value for a method. Other than the StubMethod implementation, this implementation allows to determine a specific value which must be assignable to the returning value of any instrumented method. Otherwise, an exception will be thrown. 
See Also:
/**
 * This implementation returns a fixed value for a method. Other than the {@link net.bytebuddy.implementation.StubMethod}
 * implementation, this implementation allows to determine a specific value which must be assignable to the returning value
 * of any instrumented method. Otherwise, an exception will be thrown.
 *
 * @see FieldAccessor
 */
@HashCodeAndEqualsPlugin.Enhance
public abstract class FixedValue implements Implementation {

    
The assigner that is used for assigning the fixed value to a method's return type.

/**
     * The assigner that is used for assigning the fixed value to a method's return type.
     */
    protected final Assigner assigner;

    
Indicates if dynamic type castings should be attempted for incompatible assignments.

/**
     * Indicates if dynamic type castings should be attempted for incompatible assignments.
     */
    protected final Assigner.Typing typing;

    
Creates a new fixed value implementation.

Params:
  • assigner – The assigner to use for assigning the fixed value to the return type of the instrumented value.
  • typing –   Indicates if dynamic type castings should be attempted for incompatible assignments.
/**
     * Creates a new fixed value implementation.
     *
     * @param assigner The assigner to use for assigning the fixed value to the return type of the instrumented value.
     * @param typing   Indicates if dynamic type castings should be attempted for incompatible assignments.
     */
    protected FixedValue(Assigner assigner, Assigner.Typing typing) {
        this.assigner = assigner;
        this.typing = typing;
    }

    
 Returns a fixed value from any intercepted method. The fixed value is stored in the constant pool if this is possible. Specifically, an argument that is a JavaConstant, TypeDescription, primitive, String or Class value is stored in the constant pool. Since Java 7, MethodHandle as well as MethodType references are also supported. Alternatively, the fixed value is stored in a static field. 


 When a value is stored in the class's constant pool, its identity is lost. If an object's identity is important, the reference(Object) method should be used instead. 



Important: When supplying a method handle or a method type, all types that are implied must be visible to the instrumented type or an IllegalAccessException will be thrown at runtime. 


Params:
  • fixedValue – The fixed value to return from the method.
See Also:
Returns:An implementation for the given value.
/**
     * <p>
     * Returns a fixed value from any intercepted method. The fixed value is stored in the constant pool if this is possible.
     * Specifically, an argument that is a {@link JavaConstant}, {@link TypeDescription}, primitive, {@link String} or
     * {@link Class} value is stored in the constant pool.  Since Java 7, {@code MethodHandle} as well as {@code MethodType}
     * references are also supported. Alternatively, the fixed value is stored in a static field.
     * </p>
     * <p>
     * When a value is stored in the class's constant pool, its identity is lost. If an object's identity is important, the
     * {@link FixedValue#reference(Object)} method should be used instead.
     * </p>
     * <p>
     * <b>Important</b>: When supplying a method handle or a method type, all types that are implied must be visible to the instrumented
     * type or an {@link IllegalAccessException} will be thrown at runtime.
     * </p>
     *
     * @param fixedValue The fixed value to return from the method.
     * @return An implementation for the given {@code value}.
     *
     * @see #value(JavaConstant)
     * @see #value(TypeDescription)
     * @see #nullValue()
     */
    public static AssignerConfigurable value(Object fixedValue) {
        if (fixedValue instanceof JavaConstant) {
            return value((JavaConstant) fixedValue);
        } else if (fixedValue instanceof TypeDescription) {
            return value((TypeDescription) fixedValue);
        } else {
            Class<?> type = fixedValue.getClass();
            if (type == String.class) {
                return new ForPoolValue(new TextConstant((String) fixedValue), TypeDescription.STRING);
            } else if (type == Class.class) {
                return new ForPoolValue(ClassConstant.of(TypeDescription.ForLoadedType.of((Class<?>) fixedValue)), TypeDescription.CLASS);
            } else if (type == Boolean.class) {
                return new ForPoolValue(IntegerConstant.forValue((Boolean) fixedValue), boolean.class);
            } else if (type == Byte.class) {
                return new ForPoolValue(IntegerConstant.forValue((Byte) fixedValue), byte.class);
            } else if (type == Short.class) {
                return new ForPoolValue(IntegerConstant.forValue((Short) fixedValue), short.class);
            } else if (type == Character.class) {
                return new ForPoolValue(IntegerConstant.forValue((Character) fixedValue), char.class);
            } else if (type == Integer.class) {
                return new ForPoolValue(IntegerConstant.forValue((Integer) fixedValue), int.class);
            } else if (type == Long.class) {
                return new ForPoolValue(LongConstant.forValue((Long) fixedValue), long.class);
            } else if (type == Float.class) {
                return new ForPoolValue(FloatConstant.forValue((Float) fixedValue), float.class);
            } else if (type == Double.class) {
                return new ForPoolValue(DoubleConstant.forValue((Double) fixedValue), double.class);
            } else if (JavaType.METHOD_HANDLE.getTypeStub().isAssignableFrom(type)) {
                return new ForPoolValue(new JavaConstantValue(JavaConstant.MethodHandle.ofLoaded(fixedValue)), type);
            } else if (JavaType.METHOD_TYPE.getTypeStub().represents(type)) {
                return new ForPoolValue(new JavaConstantValue(JavaConstant.MethodType.ofLoaded(fixedValue)), type);
            } else {
                return reference(fixedValue);
            }
        }
    }

    
Other than value(Object), this function will create a fixed value implementation that will always defined a field in the instrumented class. As a result, object identity will be preserved between the given value and the value that is returned by instrumented methods. The field name can be explicitly determined. The field name is generated from the fixed value's hash code. 
Params:
  • fixedValue – The fixed value to be returned by methods that are instrumented by this implementation.
Returns:An implementation for the given value.
/**
     * Other than {@link net.bytebuddy.implementation.FixedValue#value(Object)}, this function
     * will create a fixed value implementation that will always defined a field in the instrumented class. As a result,
     * object identity will be preserved between the given {@code value} and the value that is returned by
     * instrumented methods. The field name can be explicitly determined. The field name is generated from the fixed value's
     * hash code.
     *
     * @param fixedValue The fixed value to be returned by methods that are instrumented by this implementation.
     * @return An implementation for the given {@code value}.
     */
    public static AssignerConfigurable reference(Object fixedValue) {
        return new ForValue(fixedValue);
    }

    
Other than value(Object), this function will create a fixed value implementation that will always defined a field in the instrumented class. As a result, object identity will be preserved between the given value and the value that is returned by instrumented methods. The field name can be explicitly determined. 
Params:
  • fixedValue – The fixed value to be returned by methods that are instrumented by this implementation.
  • fieldName –  The name of the field for storing the fixed value.
Returns:An implementation for the given value.
/**
     * Other than {@link net.bytebuddy.implementation.FixedValue#value(Object)}, this function
     * will create a fixed value implementation that will always defined a field in the instrumented class. As a result,
     * object identity will be preserved between the given {@code value} and the value that is returned by
     * instrumented methods. The field name can be explicitly determined.
     *
     * @param fixedValue The fixed value to be returned by methods that are instrumented by this implementation.
     * @param fieldName  The name of the field for storing the fixed value.
     * @return An implementation for the given {@code value}.
     */
    public static AssignerConfigurable reference(Object fixedValue, String fieldName) {
        return new ForValue(fieldName, fixedValue);
    }

    
Returns the given type in form of a loaded type. The value is loaded from the written class's constant pool.

Params:
  • fixedValue – The type to return from the method.
Returns:An implementation for the given value.
/**
     * Returns the given type in form of a loaded type. The value is loaded from the written class's constant pool.
     *
     * @param fixedValue The type to return from the method.
     * @return An implementation for the given {@code value}.
     */
    public static AssignerConfigurable value(TypeDescription fixedValue) {
        return new ForPoolValue(ClassConstant.of(fixedValue), TypeDescription.CLASS);
    }

    
Returns the loaded version of the given JavaConstant. The value is loaded from the written class's constant pool. 
Params:
  • fixedValue – The type to return from the method.
Returns:An implementation for the given value.
/**
     * Returns the loaded version of the given {@link JavaConstant}. The value is loaded from the written class's constant pool.
     *
     * @param fixedValue The type to return from the method.
     * @return An implementation for the given {@code value}.
     */
    public static AssignerConfigurable value(JavaConstant fixedValue) {
        return new ForPoolValue(new JavaConstantValue(fixedValue), fixedValue.getType());
    }

    
Returns the argument at the specified index.

Params:
  • index – The index of the argument to return.
Returns:An implementation of a method that returns the argument at the specified index.
/**
     * Returns the argument at the specified index.
     *
     * @param index The index of the argument to return.
     * @return An implementation of a method that returns the argument at the specified index.
     */
    public static AssignerConfigurable argument(int index) {
        if (index < 0) {
            throw new IllegalArgumentException("Argument index cannot be negative: " + index);
        }
        return new ForArgument(index);
    }

    
Returns this from an instrumented method. 
Returns:An implementation that returns this from a method.
/**
     * Returns {@code this} from an instrumented method.
     *
     * @return An implementation that returns {@code this} from a method.
     */
    public static AssignerConfigurable self() {
        return new ForThisValue();
    }

    
Returns a null value from an instrumented method. 
Returns:An implementation that returns null from a method.
/**
     * Returns a {@code null} value from an instrumented method.
     *
     * @return An implementation that returns {@code null} from a method.
     */
    public static Implementation nullValue() {
        return ForNullValue.INSTANCE;
    }

    
Returns the origin type from an instrumented method.

Returns:An implementation that returns the origin type of the current instrumented type.
/**
     * Returns the origin type from an instrumented method.
     *
     * @return An implementation that returns the origin type of the current instrumented type.
     */
    public static AssignerConfigurable originType() {
        return new ForOriginType();
    }

    
Blueprint method that for applying the actual implementation.

Params:
  • methodVisitor –           The method visitor to which the implementation is applied to.
  • implementationContext –   The implementation context for the given implementation.
  • instrumentedMethod –      The instrumented method that is target of the implementation.
  • fixedValueType –  A description of the type of the fixed value that is loaded by the valueLoadingInstruction.
  • valueLoadingInstruction – A stack manipulation that represents the loading of the fixed value onto the
                               operand stack.
Returns:A representation of the stack and variable array sized that are required for this implementation.
/**
     * Blueprint method that for applying the actual implementation.
     *
     * @param methodVisitor           The method visitor to which the implementation is applied to.
     * @param implementationContext   The implementation context for the given implementation.
     * @param instrumentedMethod      The instrumented method that is target of the implementation.
     * @param fixedValueType          A description of the type of the fixed value that is loaded by the
     *                                {@code valueLoadingInstruction}.
     * @param valueLoadingInstruction A stack manipulation that represents the loading of the fixed value onto the
     *                                operand stack.
     * @return A representation of the stack and variable array sized that are required for this implementation.
     */
    protected ByteCodeAppender.Size apply(MethodVisitor methodVisitor,
                                          Context implementationContext,
                                          MethodDescription instrumentedMethod,
                                          TypeDescription.Generic fixedValueType,
                                          StackManipulation valueLoadingInstruction) {
        StackManipulation assignment = assigner.assign(fixedValueType, instrumentedMethod.getReturnType(), typing);
        if (!assignment.isValid()) {
            throw new IllegalArgumentException("Cannot return value of type " + fixedValueType + " for " + instrumentedMethod);
        }
        StackManipulation.Size stackSize = new StackManipulation.Compound(
                valueLoadingInstruction,
                assignment,
                MethodReturn.of(instrumentedMethod.getReturnType())
        ).apply(methodVisitor, implementationContext);
        return new ByteCodeAppender.Size(stackSize.getMaximalSize(), instrumentedMethod.getStackSize());
    }

    
Represents a fixed value implementation that is using a default assigner for attempting to assign
the fixed value to the return type of the instrumented method.

/**
     * Represents a fixed value implementation that is using a default assigner for attempting to assign
     * the fixed value to the return type of the instrumented method.
     */
    public interface AssignerConfigurable extends Implementation {

        
Defines an explicit assigner to this fixed value implementation.

Params:
  • assigner – The assigner to use for assigning the fixed value to the return type of the
                instrumented value.
  • typing –   Indicates if dynamic type castings should be attempted for incompatible assignments.
Returns:A fixed value implementation that makes use of the given assigner.
/**
         * Defines an explicit assigner to this fixed value implementation.
         *
         * @param assigner The assigner to use for assigning the fixed value to the return type of the
         *                 instrumented value.
         * @param typing   Indicates if dynamic type castings should be attempted for incompatible assignments.
         * @return A fixed value implementation that makes use of the given assigner.
         */
        Implementation withAssigner(Assigner assigner, Assigner.Typing typing);
    }

    
A fixed value of null. 
/**
     * A fixed value of {@code null}.
     */
    protected enum ForNullValue implements Implementation, ByteCodeAppender {

        
The singleton instance.

/**
         * The singleton instance.
         */
        INSTANCE;

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public ByteCodeAppender appender(Target implementationTarget) {
            return this;
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public InstrumentedType prepare(InstrumentedType instrumentedType) {
            return instrumentedType;
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public Size apply(MethodVisitor methodVisitor, Context implementationContext, MethodDescription instrumentedMethod) {
            if (instrumentedMethod.getReturnType().isPrimitive()) {
                throw new IllegalStateException("Cannot return null from " + instrumentedMethod);
            }
            return new ByteCodeAppender.Simple(
                    NullConstant.INSTANCE,
                    MethodReturn.REFERENCE
            ).apply(methodVisitor, implementationContext, instrumentedMethod);
        }
    }

    
A fixed value that appends the origin type of the instrumented type.

/**
     * A fixed value that appends the origin type of the instrumented type.
     */
    protected static class ForOriginType extends FixedValue implements AssignerConfigurable {

        
Creates a new fixed value appender for the origin type.

/**
         * Creates a new fixed value appender for the origin type.
         */
        protected ForOriginType() {
            this(Assigner.DEFAULT, Assigner.Typing.STATIC);
        }

        
Creates a new fixed value appender for the origin type.

Params:
  • assigner – The assigner to use for assigning the fixed value to the return type of the instrumented value.
  • typing –   Indicates if dynamic type castings should be attempted for incompatible assignments.
/**
         * Creates a new fixed value appender for the origin type.
         *
         * @param assigner The assigner to use for assigning the fixed value to the return type of the instrumented value.
         * @param typing   Indicates if dynamic type castings should be attempted for incompatible assignments.
         */
        private ForOriginType(Assigner assigner, Assigner.Typing typing) {
            super(assigner, typing);
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public Implementation withAssigner(Assigner assigner, Assigner.Typing typing) {
            return new ForOriginType(assigner, typing);
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public ByteCodeAppender appender(Target implementationTarget) {
            return new Appender(implementationTarget.getOriginType().asErasure());
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public InstrumentedType prepare(InstrumentedType instrumentedType) {
            return instrumentedType;
        }

        
An appender for writing the origin type.

/**
         * An appender for writing the origin type.
         */
        @HashCodeAndEqualsPlugin.Enhance(includeSyntheticFields = true)
        protected class Appender implements ByteCodeAppender {

            
The instrumented type.

/**
             * The instrumented type.
             */
            private final TypeDescription originType;

            
Creates a new appender.

Params:
  • originType – The instrumented type.
/**
             * Creates a new appender.
             *
             * @param originType The instrumented type.
             */
            protected Appender(TypeDescription originType) {
                this.originType = originType;
            }

            
{@inheritDoc}

/**
             * {@inheritDoc}
             */
            public Size apply(MethodVisitor methodVisitor, Context implementationContext, MethodDescription instrumentedMethod) {
                return ForOriginType.this.apply(methodVisitor,
                        implementationContext,
                        instrumentedMethod,
                        TypeDescription.CLASS.asGenericType(),
                        ClassConstant.of(originType));
            }
        }
    }

    
A fixed value of this. 
/**
     * A fixed value of {@code this}.
     */
    protected static class ForThisValue extends FixedValue implements AssignerConfigurable {

        
Creates an implementation that returns the instance of the instrumented type.

/**
         * Creates an implementation that returns the instance of the instrumented type.
         */
        protected ForThisValue() {
            super(Assigner.DEFAULT, Assigner.Typing.STATIC);
        }

        
Creates an implementation that returns the instance of the instrumented type.

Params:
  • assigner – The assigner to use for assigning the fixed value to the return type of the instrumented value.
  • typing –   Indicates if dynamic type castings should be attempted for incompatible assignments.
/**
         * Creates an implementation that returns the instance of the instrumented type.
         *
         * @param assigner The assigner to use for assigning the fixed value to the return type of the instrumented value.
         * @param typing   Indicates if dynamic type castings should be attempted for incompatible assignments.
         */
        private ForThisValue(Assigner assigner, Assigner.Typing typing) {
            super(assigner, typing);
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public ByteCodeAppender appender(Target implementationTarget) {
            return new Appender(implementationTarget.getInstrumentedType());
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public InstrumentedType prepare(InstrumentedType instrumentedType) {
            return instrumentedType;
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public Implementation withAssigner(Assigner assigner, Assigner.Typing typing) {
            return new ForThisValue(assigner, typing);
        }

        
A byte code appender for returning this. 
/**
         * A byte code appender for returning {@code this}.
         */
        @HashCodeAndEqualsPlugin.Enhance
        protected static class Appender implements ByteCodeAppender {

            
The instrumented type.

/**
             * The instrumented type.
             */
            private final TypeDescription instrumentedType;

            
Creates a new byte code appender for returning this. 
Params:
  • instrumentedType – The instrumented type.
/**
             * Creates a new byte code appender for returning {@code this}.
             *
             * @param instrumentedType The instrumented type.
             */
            protected Appender(TypeDescription instrumentedType) {
                this.instrumentedType = instrumentedType;
            }

            
{@inheritDoc}

/**
             * {@inheritDoc}
             */
            public Size apply(MethodVisitor methodVisitor, Context implementationContext, MethodDescription instrumentedMethod) {
                if (instrumentedMethod.isStatic() || !instrumentedType.isAssignableTo(instrumentedMethod.getReturnType().asErasure())) {
                    throw new IllegalStateException("Cannot return 'this' from " + instrumentedMethod);
                }
                return new ByteCodeAppender.Simple(
                        MethodVariableAccess.loadThis(),
                        MethodReturn.REFERENCE
                ).apply(methodVisitor, implementationContext, instrumentedMethod);
            }
        }
    }

    
A fixed value implementation that returns a method's argument.

/**
     * A fixed value implementation that returns a method's argument.
     */
    @HashCodeAndEqualsPlugin.Enhance
    protected static class ForArgument extends FixedValue implements AssignerConfigurable, ByteCodeAppender {

        
The argument index.

/**
         * The argument index.
         */
        private final int index;

        
Creates a new fixed value implementation that returns a method's argument.

Params:
  • index – The argument's index.
/**
         * Creates a new fixed value implementation that returns a method's argument.
         *
         * @param index The argument's index.
         */
        protected ForArgument(int index) {
            this(Assigner.DEFAULT, Assigner.Typing.STATIC, index);
        }

        
Creates a new fixed value implementation that returns a method's argument.

Params:
  • assigner – The assigner to use for assigning the fixed value to the return type of the
                instrumented value.
  • typing –   Indicates if dynamic type castings should be attempted for incompatible assignments.
  • index –    The argument's index.
/**
         * Creates a new fixed value implementation that returns a method's argument.
         *
         * @param assigner The assigner to use for assigning the fixed value to the return type of the
         *                 instrumented value.
         * @param typing   Indicates if dynamic type castings should be attempted for incompatible assignments.
         * @param index    The argument's index.
         */
        private ForArgument(Assigner assigner, Assigner.Typing typing, int index) {
            super(assigner, typing);
            this.index = index;
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public Size apply(MethodVisitor methodVisitor, Context implementationContext, MethodDescription instrumentedMethod) {
            if (instrumentedMethod.getParameters().size() <= index) {
                throw new IllegalStateException(instrumentedMethod + " does not define a parameter with index " + index);
            }
            ParameterDescription parameterDescription = instrumentedMethod.getParameters().get(index);
            StackManipulation stackManipulation = new StackManipulation.Compound(
                    MethodVariableAccess.load(parameterDescription),
                    assigner.assign(parameterDescription.getType(), instrumentedMethod.getReturnType(), typing),
                    MethodReturn.of(instrumentedMethod.getReturnType())
            );
            if (!stackManipulation.isValid()) {
                throw new IllegalStateException("Cannot assign " + instrumentedMethod.getReturnType() + " to " + parameterDescription);
            }
            return new Size(stackManipulation.apply(methodVisitor, implementationContext).getMaximalSize(), instrumentedMethod.getStackSize());
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public ByteCodeAppender appender(Target implementationTarget) {
            return this;
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public InstrumentedType prepare(InstrumentedType instrumentedType) {
            return instrumentedType;
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public Implementation withAssigner(Assigner assigner, Assigner.Typing typing) {
            return new ForArgument(assigner, typing, index);
        }
    }

    
A fixed value implementation that represents its fixed value as a value that is written to the instrumented
class's constant pool.

/**
     * A fixed value implementation that represents its fixed value as a value that is written to the instrumented
     * class's constant pool.
     */
    @HashCodeAndEqualsPlugin.Enhance
    protected static class ForPoolValue extends FixedValue implements AssignerConfigurable, ByteCodeAppender {

        
The stack manipulation which is responsible for loading the fixed value onto the operand stack.

/**
         * The stack manipulation which is responsible for loading the fixed value onto the operand stack.
         */
        private final StackManipulation valueLoadInstruction;

        
The type of the fixed value.

/**
         * The type of the fixed value.
         */
        private final TypeDescription loadedType;

        
Creates a new constant pool fixed value implementation.

Params:
  • valueLoadInstruction – The instruction that is responsible for loading the constant pool value onto the
                            operand stack.
  • loadedType –           A type description representing the loaded type.
/**
         * Creates a new constant pool fixed value implementation.
         *
         * @param valueLoadInstruction The instruction that is responsible for loading the constant pool value onto the
         *                             operand stack.
         * @param loadedType           A type description representing the loaded type.
         */
        protected ForPoolValue(StackManipulation valueLoadInstruction, Class<?> loadedType) {
            this(valueLoadInstruction, TypeDescription.ForLoadedType.of(loadedType));
        }

        
Creates a new constant pool fixed value implementation.

Params:
  • valueLoadInstruction – The instruction that is responsible for loading the constant pool value onto the
                            operand stack.
  • loadedType –           A type description representing the loaded type.
/**
         * Creates a new constant pool fixed value implementation.
         *
         * @param valueLoadInstruction The instruction that is responsible for loading the constant pool value onto the
         *                             operand stack.
         * @param loadedType           A type description representing the loaded type.
         */
        protected ForPoolValue(StackManipulation valueLoadInstruction, TypeDescription loadedType) {
            this(Assigner.DEFAULT, Assigner.Typing.STATIC, valueLoadInstruction, loadedType);
        }

        
Creates a new constant pool fixed value implementation.

Params:
  • valueLoadInstruction – The instruction that is responsible for loading the constant pool value onto the
                            operand stack.
  • loadedType –           A type description representing the loaded type.
  • assigner –             The assigner to use for assigning the fixed value to the return type of the
                            instrumented value.
  • typing –               Indicates if dynamic type castings should be attempted for incompatible assignments.
/**
         * Creates a new constant pool fixed value implementation.
         *
         * @param valueLoadInstruction The instruction that is responsible for loading the constant pool value onto the
         *                             operand stack.
         * @param loadedType           A type description representing the loaded type.
         * @param assigner             The assigner to use for assigning the fixed value to the return type of the
         *                             instrumented value.
         * @param typing               Indicates if dynamic type castings should be attempted for incompatible assignments.
         */
        private ForPoolValue(Assigner assigner, Assigner.Typing typing, StackManipulation valueLoadInstruction, TypeDescription loadedType) {
            super(assigner, typing);
            this.valueLoadInstruction = valueLoadInstruction;
            this.loadedType = loadedType;
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public Implementation withAssigner(Assigner assigner, Assigner.Typing typing) {
            return new ForPoolValue(assigner, typing, valueLoadInstruction, loadedType);
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public InstrumentedType prepare(InstrumentedType instrumentedType) {
            return instrumentedType;
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public ByteCodeAppender appender(Target implementationTarget) {
            return this;
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public Size apply(MethodVisitor methodVisitor, Context implementationContext, MethodDescription instrumentedMethod) {
            return apply(methodVisitor, implementationContext, instrumentedMethod, loadedType.asGenericType(), valueLoadInstruction);
        }
    }

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

/**
     * A fixed value implementation that represents its fixed value as a static field of the instrumented class.
     */
    @HashCodeAndEqualsPlugin.Enhance
    protected static class ForValue extends FixedValue implements AssignerConfigurable {

        
The prefix of the static field that is created for storing the fixed value.

/**
         * The prefix of the static field that is created for storing the fixed value.
         */
        private static final String PREFIX = "value";

        
The name of the field in which the fixed value is stored.

/**
         * The name of the field in which the fixed value is stored.
         */
        private final String fieldName;

        
The value that is to be stored in the static field.

/**
         * The value that is to be stored in the static field.
         */
        private final Object value;

        
The type if the field for storing the fixed value.

/**
         * The type if the field for storing the fixed value.
         */
        @HashCodeAndEqualsPlugin.ValueHandling(HashCodeAndEqualsPlugin.ValueHandling.Sort.IGNORE)
        private final TypeDescription.Generic fieldType;

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

Params:
  • value – The fixed value to be returned.
/**
         * Creates a new static field fixed value implementation with a random name for the field containing the fixed
         * value.
         *
         * @param value The fixed value to be returned.
         */
        protected ForValue(Object value) {
            this(PREFIX + "$" + RandomString.hashOf(value.hashCode()), value);
        }

        
Creates a new static field fixed value implementation.

Params:
  • fieldName – The name of the field for storing the fixed value.
  • value –     The fixed value to be returned.
/**
         * Creates a new static field fixed value implementation.
         *
         * @param fieldName The name of the field for storing the fixed value.
         * @param value     The fixed value to be returned.
         */
        protected ForValue(String fieldName, Object value) {
            this(Assigner.DEFAULT, Assigner.Typing.STATIC, fieldName, value);
        }

        
Creates a new static field fixed value implementation.

Params:
  • fieldName – The name of the field for storing the fixed value.
  • value –     The fixed value to be returned.
  • assigner –  The assigner to use for assigning the fixed value to the return type of the
                 instrumented value.
  • typing –    Indicates if dynamic type castings should be attempted for incompatible assignments.
/**
         * Creates a new static field fixed value implementation.
         *
         * @param fieldName The name of the field for storing the fixed value.
         * @param value     The fixed value to be returned.
         * @param assigner  The assigner to use for assigning the fixed value to the return type of the
         *                  instrumented value.
         * @param typing    Indicates if dynamic type castings should be attempted for incompatible assignments.
         */
        private ForValue(Assigner assigner, Assigner.Typing typing, String fieldName, Object value) {
            super(assigner, typing);
            this.fieldName = fieldName;
            this.value = value;
            fieldType = TypeDescription.Generic.OfNonGenericType.ForLoadedType.of(value.getClass());
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public Implementation withAssigner(Assigner assigner, Assigner.Typing typing) {
            return new ForValue(assigner, typing, fieldName, value);
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public InstrumentedType prepare(InstrumentedType instrumentedType) {
            return instrumentedType
                    .withField(new FieldDescription.Token(fieldName,
                            Opcodes.ACC_PUBLIC | Opcodes.ACC_STATIC | Opcodes.ACC_VOLATILE | Opcodes.ACC_SYNTHETIC,
                            fieldType))
                    .withInitializer(new LoadedTypeInitializer.ForStaticField(fieldName, value));
        }

        
{@inheritDoc}

/**
         * {@inheritDoc}
         */
        public ByteCodeAppender appender(Target implementationTarget) {
            return new StaticFieldByteCodeAppender(implementationTarget.getInstrumentedType());
        }

        
A byte code appender for returning the fixed value that was stored in a static field.

/**
         * A byte code appender for returning the fixed value that was stored in a static field.
         */
        @HashCodeAndEqualsPlugin.Enhance
        private class StaticFieldByteCodeAppender implements ByteCodeAppender {

            
The stack manipulation that loads the fixed value onto the operand stack.

/**
             * The stack manipulation that loads the fixed value onto the operand stack.
             */
            private final StackManipulation fieldGetAccess;

            
Creates a new byte code appender for returning a value of a static field from an instrumented method.

Params:
  • instrumentedType – The instrumented type that is subject of the instrumentation.
/**
             * Creates a new byte code appender for returning a value of a static field from an instrumented method.
             *
             * @param instrumentedType The instrumented type that is subject of the instrumentation.
             */
            private StaticFieldByteCodeAppender(TypeDescription instrumentedType) {
                fieldGetAccess = FieldAccess.forField(instrumentedType.getDeclaredFields().filter((named(fieldName))).getOnly()).read();
            }

            
{@inheritDoc}

/**
             * {@inheritDoc}
             */
            public Size apply(MethodVisitor methodVisitor, Context implementationContext, MethodDescription instrumentedMethod) {
                return ForValue.this.apply(methodVisitor, implementationContext, instrumentedMethod, fieldType, fieldGetAccess);
            }
        }
    }
}