Class LocalVariable

  • All Implemented Interfaces:
    Cloneable, Node, Constants

    public final class LocalVariable
    extends Object
    implements Cloneable, Node, Constants
    This class represents a local variable within a method. It contains its scope, name, signature and index on the method's frame. It is used both to represent an element of the LocalVariableTable as well as an element of the LocalVariableTypeTable. The nomenclature used here may be a bit confusing; while the two items have the same layout in a class file, a LocalVariableTable attribute contains a descriptor_index, not a signatureIndex. The LocalVariableTypeTable attribute does have a signatureIndex.
    See Also:
    for more details on the difference., LocalVariableTable, LocalVariableTypeTable
    • Constructor Detail

      • LocalVariable

        public LocalVariable​(LocalVariable localVariable)
        Initializes from another LocalVariable. Note that both objects use the same references (shallow copy). Use copy() for a physical copy.
        Parameters:
        localVariable - Another LocalVariable.
      • LocalVariable

        public LocalVariable​(int startPc,
                             int length,
                             int nameIndex,
                             int signatureIndex,
                             int index,
                             ConstantPool constantPool)
        Parameters:
        startPc - Range in which the variable
        length - ... is valid
        nameIndex - Index in constant pool of variable name
        signatureIndex - Index of variable's signature
        index - Variable is `index'th local variable on the method's frame
        constantPool - Array of constants
      • LocalVariable

        public LocalVariable​(int startPc,
                             int length,
                             int nameIndex,
                             int signatureIndex,
                             int index,
                             ConstantPool constantPool,
                             int origIndex)
        Parameters:
        startPc - Range in which the variable
        length - ... is valid
        nameIndex - Index in constant pool of variable name
        signatureIndex - Index of variable's signature
        index - Variable is `index'th local variable on the method's frame
        constantPool - Array of constants
        origIndex - Variable is `index'th local variable on the method's frame prior to any changes
    • Method Detail

      • accept

        public void accept​(Visitor v)
        Called by objects that are traversing the nodes of the tree implicitely defined by the contents of a Java class. I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree of objects.
        Specified by:
        accept in interface Node
        Parameters:
        v - Visitor object
      • getConstantPool

        public ConstantPool getConstantPool()
        Returns:
        Constant pool used by this object.
      • getLength

        public int getLength()
        Returns:
        Variable is valid within getStartPC() .. getStartPC()+getLength()
      • getName

        public String getName()
        Returns:
        Variable name.
      • getNameIndex

        public int getNameIndex()
        Returns:
        Index in constant pool of variable name.
      • getSignature

        public String getSignature()
        Returns:
        Signature.
      • getSignatureIndex

        public int getSignatureIndex()
        Returns:
        Index in constant pool of variable signature.
      • getIndex

        public int getIndex()
        Returns:
        index of register where variable is stored
      • getOrigIndex

        public int getOrigIndex()
        Returns:
        index of register where variable was originally stored
      • getStartPC

        public int getStartPC()
        Returns:
        Start of range where the variable is valid
      • setConstantPool

        public void setConstantPool​(ConstantPool constantPool)
        Parameters:
        constantPool - Constant pool to be used for this object.
      • setLength

        public void setLength​(int length)
        Parameters:
        length - the length of this local variable
      • setNameIndex

        public void setNameIndex​(int nameIndex)
        Parameters:
        nameIndex - the index into the constant pool for the name of this variable
      • setSignatureIndex

        public void setSignatureIndex​(int signatureIndex)
        Parameters:
        signatureIndex - the index into the constant pool for the signature of this variable
      • setIndex

        public void setIndex​(int index)
        Parameters:
        index - the index in the local variable table of this variable
      • setStartPC

        public void setStartPC​(int startPc)
        Parameters:
        startPc - Specify range where the local variable is valid.
      • toString

        public String toString()
        Overrides:
        toString in class Object
        Returns:
        string representation.
      • copy

        public LocalVariable copy()
        Returns:
        deep copy of this object