net.bytebuddy.instrumentation.method.bytecode.stack.constant

Enum IntegerConstant

java.lang.Object

java.lang.Enum<IntegerConstant>

net.bytebuddy.instrumentation.method.bytecode.stack.constant.IntegerConstant

All Implemented Interfaces:

Serializable, Comparable<IntegerConstant>, StackManipulation

public enum IntegerConstant
extends Enum<IntegerConstant>
implements StackManipulation

This class is responsible for loading any int constant onto the operand stack. Note that within the JVM, boolean, byte, short and char values are represented by integers and can therefore be loaded by using this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	IntegerConstant.ConstantPool A stack manipulation that loads a JVM-integer value from a constant pool value onto the operand stack.
protected static class	IntegerConstant.SingleBytePush A stack manipulation that loads a JVM-integer value by a BIPUSH operation which is legal for single byte integer values.
protected static class	IntegerConstant.TwoBytePush A stack manipulation that loads a JVM-integer value by a SIPUSH operation which is legal for up to two byte integer values.

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

StackManipulation.Compound, StackManipulation.Illegal, StackManipulation.LegalTrivial, StackManipulation.Size

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIVE A JVM-type int constant of value 5.
FOUR A JVM-type int constant of value 4.
MINUS_ONE A JVM-type int constant of value -1.
ONE A JVM-type int constant of value 1.
THREE A JVM-type int constant of value 3.
TWO A JVM-type int constant of value 2.
ZERO A JVM-type int constant of value 0.

Method Summary

Modifier and Type	Method and Description
StackManipulation.Size	apply(org.objectweb.asm.MethodVisitor methodVisitor, Instrumentation.Context instrumentationContext) Applies the stack manipulation that is described by this instance.
static StackManipulation	forValue(boolean value) Creates a stack manipulation for loading a boolean value onto the stack.
static StackManipulation	forValue(int value) Creates a stack manipulation for loading an int value onto the stack.
boolean	isValid() Determines if this stack manipulation is valid.
static IntegerConstant	valueOf(String name) Returns the enum constant of this type with the specified name.
static IntegerConstant[]	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

MINUS_ONE

public static final IntegerConstant MINUS_ONE

A JVM-type int constant of value -1.

ZERO

public static final IntegerConstant ZERO

A JVM-type int constant of value 0.

ONE

public static final IntegerConstant ONE

A JVM-type int constant of value 1.

TWO

public static final IntegerConstant TWO

A JVM-type int constant of value 2.

THREE

public static final IntegerConstant THREE

A JVM-type int constant of value 3.

FOUR

public static final IntegerConstant FOUR

A JVM-type int constant of value 4.

FIVE

public static final IntegerConstant FIVE

A JVM-type int constant of value 5.

Method Detail

values

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

Returns:

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

valueOf

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

forValue

public static StackManipulation forValue(boolean value)

Creates a stack manipulation for loading a boolean value onto the stack.

Parameters:

value - The boolean to load onto the stack.

Returns:

The stack manipulation for loading this boolean.

forValue

public static StackManipulation forValue(int value)

Creates a stack manipulation for loading an int value onto the stack.

This is achieved either by invoking a constant opcode, if any, or by creating a binary push operation.

Parameters:

value - The int (or byte, short, char) value to load onto the stack.

Returns:

A stack manipulation for loading the given value.

isValid

public boolean isValid()

Description copied from interface: StackManipulation

Determines if this stack manipulation is valid.

Specified by:

isValid in interface StackManipulation

Returns:

If false, this manipulation cannot be applied and should throw an exception.

apply

public StackManipulation.Size apply(org.objectweb.asm.MethodVisitor methodVisitor,
                                    Instrumentation.Context instrumentationContext)

Description copied from interface: StackManipulation

Applies the stack manipulation that is described by this instance.

Specified by:

apply in interface StackManipulation

Parameters:

methodVisitor - The method visitor used to write the method implementation to.

instrumentationContext - The context of the current instrumentation.

Returns:

The changes to the size of the operand stack that are implied by this stack manipulation.