org.apache.bcel.generic

Class LocalVariableGen

java.lang.Object

org.apache.bcel.generic.LocalVariableGen

All Implemented Interfaces:

java.lang.Cloneable, InstructionTargeter, NamedAndTyped

public class LocalVariableGen
extends java.lang.Object
implements InstructionTargeter, NamedAndTyped, java.lang.Cloneable

This class represents a local variable within a method. It contains its scope, name and type. The generated LocalVariable object can be obtained with getLocalVariable which needs the instruction list and the constant pool as parameters.

Version:

$Id$

See Also:

LocalVariable, MethodGen

Field Summary

Fields

Modifier and Type	Field and Description
private InstructionHandle	end
private int	index
private boolean	live_to_end
private java.lang.String	name
private int	orig_index
private InstructionHandle	start
private Type	type

Constructor Summary

Constructors

Constructor and Description
LocalVariableGen(int index, java.lang.String name, Type type, InstructionHandle start, InstructionHandle end) Generate a local variable that with index `index'.
LocalVariableGen(int index, java.lang.String name, Type type, InstructionHandle start, InstructionHandle end, int orig_index) Generate a local variable that with index `index'.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
boolean	containsTarget(InstructionHandle ih) Checks whether this targeter targets the specified instruction handle.
(package private) void	dispose() Clear the references from and to this variable when it's removed.
boolean	equals(java.lang.Object o) We consider to local variables to be equal, if the use the same index and are valid in the same range.
InstructionHandle	getEnd()
int	getIndex()
boolean	getLiveToEnd()
LocalVariable	getLocalVariable(ConstantPoolGen cp) Get LocalVariable object.
java.lang.String	getName()
int	getOrigIndex()
InstructionHandle	getStart()
Type	getType()
int	hashCode()
void	setEnd(InstructionHandle end)
void	setIndex(int index)
void	setLiveToEnd(boolean live_to_end)
void	setName(java.lang.String name)
void	setStart(InstructionHandle start)
void	setType(Type type)
java.lang.String	toString()
void	updateTarget(InstructionHandle old_ih, InstructionHandle new_ih) Replaces the target of this targeter from this old handle to the new handle.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

index

private int index

name

private java.lang.String name

type

private Type type

start

private InstructionHandle start

end

private InstructionHandle end

orig_index

private int orig_index

live_to_end

private boolean live_to_end

Constructor Detail

LocalVariableGen

public LocalVariableGen(int index,
                        java.lang.String name,
                        Type type,
                        InstructionHandle start,
                        InstructionHandle end)

Generate a local variable that with index `index'. Note that double and long variables need two indexs. Index indices have to be provided by the user.

Parameters:

index - index of local variable

name - its name

type - its type

start - from where the instruction is valid (null means from the start)

end - until where the instruction is valid (null means to the end)

LocalVariableGen

public LocalVariableGen(int index,
                        java.lang.String name,
                        Type type,
                        InstructionHandle start,
                        InstructionHandle end,
                        int orig_index)

Generate a local variable that with index `index'. Note that double and long variables need two indexs. Index indices have to be provided by the user.

Parameters:

index - index of local variable

name - its name

type - its type

start - from where the instruction is valid (null means from the start)

end - until where the instruction is valid (null means to the end)

orig_index - index of local variable prior to any changes to index

Method Detail

getLocalVariable

public LocalVariable getLocalVariable(ConstantPoolGen cp)

Get LocalVariable object. This relies on that the instruction list has already been dumped to byte code or or that the `setPositions' methods has been called for the instruction list. Note that due to the conversion from byte code offset to InstructionHandle, it is impossible to tell the difference between a live range that ends BEFORE the last insturction of the method or a live range that ends AFTER the last instruction of the method. Hence the live_to_end flag to differentiate between these two cases.

Parameters:

cp - constant pool

setIndex

public void setIndex(int index)

getIndex

public int getIndex()

getOrigIndex

public int getOrigIndex()

setLiveToEnd

public void setLiveToEnd(boolean live_to_end)

getLiveToEnd

public boolean getLiveToEnd()

setName

public void setName(java.lang.String name)

Specified by:

setName in interface NamedAndTyped

getName

public java.lang.String getName()

Specified by:

getName in interface NamedAndTyped

setType

public void setType(Type type)

Specified by:

setType in interface NamedAndTyped

getType

public Type getType()

Specified by:

getType in interface NamedAndTyped

getStart

public InstructionHandle getStart()

getEnd

public InstructionHandle getEnd()

setStart

public void setStart(InstructionHandle start)

setEnd

public void setEnd(InstructionHandle end)

updateTarget

public void updateTarget(InstructionHandle old_ih,
                         InstructionHandle new_ih)

Description copied from interface: InstructionTargeter

Replaces the target of this targeter from this old handle to the new handle.

Specified by:

updateTarget in interface InstructionTargeter

Parameters:

old_ih - old target, either start or end

new_ih - new target

dispose

void dispose()

Clear the references from and to this variable when it's removed.

containsTarget

public boolean containsTarget(InstructionHandle ih)

Description copied from interface: InstructionTargeter

Checks whether this targeter targets the specified instruction handle.

Specified by:

containsTarget in interface InstructionTargeter

Returns:

true, if ih is target of this variable

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

We consider to local variables to be equal, if the use the same index and are valid in the same range.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object