Enum IntegerConstant

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<IntegerConstant>, StackManipulation

    public enum IntegerConstant
    extends java.lang.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.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant 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.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int opcode
      The shortcut opcode for loading a common int-compatible JVM value onto the operand stack.
      private static StackManipulation.Size SIZE
      The size impact of loading an int value onto the operand stack.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private IntegerConstant​(int opcode)
      Creates a new JVM-integer constant loading stack manipulation for a given shortcut opcode.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      StackManipulation.Size apply​(org.objectweb.asm.MethodVisitor methodVisitor, Implementation.Context implementationContext)
      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​(java.lang.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.
    • Field Detail

      • SIZE

        private static final StackManipulation.Size SIZE
        The size impact of loading an int value onto the operand stack.
      • opcode

        private final int opcode
        The shortcut opcode for loading a common int-compatible JVM value onto the operand stack.
    • Constructor Detail

      • IntegerConstant

        private IntegerConstant​(int opcode)
        Creates a new JVM-integer constant loading stack manipulation for a given shortcut opcode.
        Parameters:
        opcode - The shortcut opcode for loading a common int-compatible JVM value onto the operand stack.
    • 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​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.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()
        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,
                                            Implementation.Context implementationContext)
        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.
        implementationContext - The context of the current implementation.
        Returns:
        The changes to the size of the operand stack that are implied by this stack manipulation.