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

public Class Frame

extends Object
Class Inheritance

This class represents a JVM execution frame; that means, a local variable array and an operand stack.

Field Summary

Modifier and TypeField and Description
protected static UninitializedObjectType
_this

For instance initialization methods, it is important to remember which instance it is that is not initialized yet.

private final LocalVariables
private final OperandStack

Constructor Summary

AccessConstructor and Description
public
Frame(final int maxLocals, final int maxStack)

public
Frame(final LocalVariables locals, final OperandStack stack)

Method Summary

Modifier and TypeMethod and Description
protected Object
clone()

Overrides java.lang.Object.clone.

Creates and returns a copy of this object.
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 Frame
public LocalVariables
public OperandStack
public static UninitializedObjectType

Returns:

the _this
getThis
()

Deprecated as a consequence of UninitializedObjectType being deprecated.
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 static void
setThis(final UninitializedObjectType
the _this to set
_this
)

Deprecated as a consequence of UninitializedObjectType being deprecated.
public String
toString()

Overrides java.lang.Object.toString.

Returns a String representation of the Frame instance.
Inherited from java.lang.Object:
finalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

_thisback to summary
protected static UninitializedObjectType _this

Deprecated

Use the getter/setter to access the field as it may be made private in a later release

For instance initialization methods, it is important to remember which instance it is that is not initialized yet. It will be initialized invoking another constructor later. NULL means the instance already *is* initialized.

Annotations
@Deprecated
localsback to summary
private final LocalVariables locals
stackback to summary
private final OperandStack stack

Constructor Detail

Frameback to summary
public Frame(final int maxLocals, final int maxStack)
Frameback to summary
public Frame(final LocalVariables locals, final OperandStack stack)

Method Detail

cloneback to summary
protected Object clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x
will be true, and that the expression:
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

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
getCloneback to summary
public Frame getClone()
getLocalsback to summary
public LocalVariables getLocals()
getStackback to summary
public OperandStack getStack()
getThisback to summary
public static UninitializedObjectType getThis()

Deprecated

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

Returns:UninitializedObjectType

the _this

Since
6.0
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
setThisback to summary
public static void setThis(final UninitializedObjectType _this)

Deprecated

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

Parameters
_this:UninitializedObjectType

the _this to set

Since
6.0
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns a String representation of the Frame instance.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations
@Override