Top Description Fields Constructors Methods
org.apache.bcel.verifier.structurals

public Class LocalVariables

extends Object
implements Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable
Imports
java.util.Arrays, org.apache.bcel.generic.ReferenceType, .Type, org.apache.bcel.verifier.exc.AssertionViolatedException, .StructuralCodeConstraintException

This class implements an array of local variables used for symbolic JVM simulation.

Field Summary

Modifier and TypeField and Description
private final Type[]
locals

The Type[] containing the local variable slots.

Constructor Summary

AccessConstructor and Description
public
LocalVariables(final int
local variable count.
localVariableCount
)

Creates a new LocalVariables object.

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides java.lang.Object.clone.

Returns a deep copy of this object; i.e. the clone operates on a new local variable array.
public boolean
equals(final Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public Type

Returns:

the type of the local variable slot index.
get
(final int
Slot to look up.
slotIndex
)

Returns the type of the local variable slot index.

public LocalVariables

Returns:

a (correctly typed) clone of this object.
getClone
()

Returns a (correctly typed) clone of this object.

public int

Returns:

a hash code value for the object.
hashCode
()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
initializeObject(final UninitializedObjectType
the object to match.
uninitializedObjectType
)

Deprecated as a consequence of UninitializedObjectType being deprecated.
Replaces all occurrences of uninitializedObjectType in this local variables set with an "initialized" ObjectType.
public int

Returns:

the number of local variable slots.
maxLocals
()

Returns the number of local variable slots.

public void
merge(final LocalVariables
other local variable.
localVariable
)

Merges two local variables sets as described in the Java Virtual Machine Specification, Second Edition, section 4.9.2, page 146.

private void
merge(final LocalVariables lv, final int i)

Merges a single local variable.

public void
set(final int
Target slot index.
slotIndex
,
final Type
Type to save at the given slot index.
type
)

Sets a new Type for the given local variable slot.

public String
toString()

Overrides java.lang.Object.toString.

Returns a String representation of this object.
Inherited from java.lang.Object:
finalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

localsback to summary
private final Type[] locals

The Type[] containing the local variable slots.

Constructor Detail

LocalVariablesback to summary
public LocalVariables(final int localVariableCount)

Creates a new LocalVariables object.

Parameters
localVariableCount:int

local variable count.

Method Detail

cloneback to summary
public Object clone()

Overrides java.lang.Object.clone.

Returns a deep copy of this object; i.e. the clone operates on a new local variable array. However, the Type objects in the array are shared.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations
@Override
equalsback to summary
public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getback to summary
public Type get(final int slotIndex)

Returns the type of the local variable slot index.

Parameters
slotIndex:int

Slot to look up.

Returns:Type

the type of the local variable slot index.

getCloneback to summary
public LocalVariables getClone()

Returns a (correctly typed) clone of this object. This is equivalent to ((LocalVariables) this.clone()).

Returns:LocalVariables

a (correctly typed) clone of this object.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for the object.

Annotations
@Override
initializeObjectback to summary
public void initializeObject(final UninitializedObjectType uninitializedObjectType)

Deprecated

as a consequence of UninitializedObjectType being deprecated. See corresponding docs for further information.

Replaces all occurrences of uninitializedObjectType in this local variables set with an "initialized" ObjectType.

Parameters
uninitializedObjectType:UninitializedObjectType

the object to match.

maxLocalsback to summary
public int maxLocals()

Returns the number of local variable slots.

Returns:int

the number of local variable slots.

mergeback to summary
public void merge(final LocalVariables localVariable)

Merges two local variables sets as described in the Java Virtual Machine Specification, Second Edition, section 4.9.2, page 146.

Parameters
localVariable:LocalVariables

other local variable.

mergeback to summary
private void merge(final LocalVariables lv, final int i)

Merges a single local variable.

See Also
merge(LocalVariables)
setback to summary
public void set(final int slotIndex, final Type type)

Sets a new Type for the given local variable slot.

Parameters
slotIndex:int

Target slot index.

type:Type

Type to save at the given slot index.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns a String representation of this object.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations
@Override