/*
 * reserved comment block
 * DO NOT REMOVE OR ALTER!
 */
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 com.sun.org.apache.bcel.internal.classfile;


import  com.sun.org.apache.bcel.internal.Constants;
import  java.io.*;

This class represents a local variable within a method. It contains its scope, name, signature and index on the method's frame.
Author: M. Dahm
See Also:
/** * This class represents a local variable within a method. It contains its * scope, name, signature and index on the method's frame. * * @author <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A> * @see LocalVariableTable */
public final class LocalVariable implements Constants, Cloneable, Node, Serializable { private int start_pc; // Range in which the variable is valid private int length; private int name_index; // Index in constant pool of variable name private int signature_index; // Index of variable signature private int index; /* Variable is `index'th local variable on * this method's frame. */ private ConstantPool constant_pool;
Initialize from another object. Note that both objects use the same references (shallow copy). Use copy() for a physical copy.
/** * Initialize from another object. Note that both objects use the same * references (shallow copy). Use copy() for a physical copy. */
public LocalVariable(LocalVariable c) { this(c.getStartPC(), c.getLength(), c.getNameIndex(), c.getSignatureIndex(), c.getIndex(), c.getConstantPool()); }
Construct object from file stream.
Params:
  • file – Input stream
Throws:
/** * Construct object from file stream. * @param file Input stream * @throws IOException */
LocalVariable(DataInputStream file, ConstantPool constant_pool) throws IOException { this(file.readUnsignedShort(), file.readUnsignedShort(), file.readUnsignedShort(), file.readUnsignedShort(), file.readUnsignedShort(), constant_pool); }
Params:
  • start_pc – Range in which the variable
  • length – ... is valid
  • name_index – Index in constant pool of variable name
  • signature_index – Index of variable's signature
  • index – Variable is `index'th local variable on the method's frame
  • constant_pool – Array of constants
/** * @param start_pc Range in which the variable * @param length ... is valid * @param name_index Index in constant pool of variable name * @param signature_index Index of variable's signature * @param index Variable is `index'th local variable on the method's frame * @param constant_pool Array of constants */
public LocalVariable(int start_pc, int length, int name_index, int signature_index, int index, ConstantPool constant_pool) { this.start_pc = start_pc; this.length = length; this.name_index = name_index; this.signature_index = signature_index; this.index = index; this.constant_pool = constant_pool; }
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.
Params:
  • v – Visitor object
/** * 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. * * @param v Visitor object */
public void accept(Visitor v) { v.visitLocalVariable(this); }
Dump local variable to file stream in binary format.
Params:
  • file – Output file stream
Throws:
/** * Dump local variable to file stream in binary format. * * @param file Output file stream * @throws IOException */
public final void dump(DataOutputStream file) throws IOException { file.writeShort(start_pc); file.writeShort(length); file.writeShort(name_index); file.writeShort(signature_index); file.writeShort(index); }
Returns:Constant pool used by this object.
/** * @return Constant pool used by this object. */
public final ConstantPool getConstantPool() { return constant_pool; }
Returns:Variable is valid within getStartPC() .. getStartPC()+getLength()
/** * @return Variable is valid within getStartPC() .. getStartPC()+getLength() */
public final int getLength() { return length; }
Returns:Variable name.
/** * @return Variable name. */
public final String getName() { ConstantUtf8 c; c = (ConstantUtf8)constant_pool.getConstant(name_index, CONSTANT_Utf8); return c.getBytes(); }
Returns:Index in constant pool of variable name.
/** * @return Index in constant pool of variable name. */
public final int getNameIndex() { return name_index; }
Returns:Signature.
/** * @return Signature. */
public final String getSignature() { ConstantUtf8 c; c = (ConstantUtf8)constant_pool.getConstant(signature_index, CONSTANT_Utf8); return c.getBytes(); }
Returns:Index in constant pool of variable signature.
/** * @return Index in constant pool of variable signature. */
public final int getSignatureIndex() { return signature_index; }
Returns:index of register where variable is stored
/** * @return index of register where variable is stored */
public final int getIndex() { return index; }
Returns:Start of range where he variable is valid
/** * @return Start of range where he variable is valid */
public final int getStartPC() { return start_pc; }
Params:
  • constant_pool – Constant pool to be used for this object.
/** * @param constant_pool Constant pool to be used for this object. */
public final void setConstantPool(ConstantPool constant_pool) { this.constant_pool = constant_pool; }
@paramlength.
/** * @param length. */
public final void setLength(int length) { this.length = length; }
@paramname_index.
/** * @param name_index. */
public final void setNameIndex(int name_index) { this.name_index = name_index; }
@paramsignature_index.
/** * @param signature_index. */
public final void setSignatureIndex(int signature_index) { this.signature_index = signature_index; }
@paramindex.
/** * @param index. */
public final void setIndex(int index) { this.index = index; }
Params:
  • start_pc – Specify range where the local variable is valid.
/** * @param start_pc Specify range where the local variable is valid. */
public final void setStartPC(int start_pc) { this.start_pc = start_pc; }
Returns:string representation.
/** * @return string representation. */
public final String toString() { String name = getName(), signature = Utility.signatureToString(getSignature()); return "LocalVariable(start_pc = " + start_pc + ", length = " + length + ", index = " + index + ":" + signature + " " + name + ")"; }
Returns:deep copy of this object
/** * @return deep copy of this object */
public LocalVariable copy() { try { return (LocalVariable)clone(); } catch(CloneNotSupportedException e) {} return null; } }