Enum MethodReturn

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DOUBLE
      The method return handler for returning a double.
      FLOAT
      The method return handler for returning a float.
      INTEGER
      The method return handler for returning a JVM-integer.
      LONG
      The method return handler for returning a long.
      REFERENCE
      The method return handler for returning a reference type.
      VOID
      The method return handler for returning void.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int returnOpcode
      The opcode of this operation.
      private StackManipulation.Size size
      The operand stack size change that is implied by this operation.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private MethodReturn​(int returnOpcode, StackSize stackSize)
      Creates a new method return manipulation.
    • 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.
      boolean isValid()
      Determines if this stack manipulation is valid.
      static StackManipulation of​(TypeDefinition typeDefinition)
      Returns a method return corresponding to a given type.
      static MethodReturn valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static MethodReturn[] 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

      • INTEGER

        public static final MethodReturn INTEGER
        The method return handler for returning a JVM-integer.
      • DOUBLE

        public static final MethodReturn DOUBLE
        The method return handler for returning a double.
      • FLOAT

        public static final MethodReturn FLOAT
        The method return handler for returning a float.
      • LONG

        public static final MethodReturn LONG
        The method return handler for returning a long.
      • VOID

        public static final MethodReturn VOID
        The method return handler for returning void.
      • REFERENCE

        public static final MethodReturn REFERENCE
        The method return handler for returning a reference type.
    • Field Detail

      • returnOpcode

        private final int returnOpcode
        The opcode of this operation.
      • size

        private final StackManipulation.Size size
        The operand stack size change that is implied by this operation.
    • Constructor Detail

      • MethodReturn

        private MethodReturn​(int returnOpcode,
                             StackSize stackSize)
        Creates a new method return manipulation.
        Parameters:
        returnOpcode - The opcode of this operation.
        stackSize - The operand stack size change that is implied by this operation.
    • Method Detail

      • values

        public static MethodReturn[] 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 (MethodReturn c : MethodReturn.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static MethodReturn 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
      • of

        public static StackManipulation of​(TypeDefinition typeDefinition)
        Returns a method return corresponding to a given type.
        Parameters:
        typeDefinition - The type to be returned.
        Returns:
        The stack manipulation representing the method return.
      • 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.