Top Fields Constructors Methods
org.jruby.ir.operands

public Class LocalVariable

extends Variable
implements DepthCloneable
Class Inheritance
All Implemented Interfaces
org.jruby.ir.operands.DepthCloneable
Known Direct Subclasses
org.jruby.ir.operands.ClosureLocalVariable
Imports
org.jruby.RubySymbol, org.jruby.ir.IRVisitor, org.jruby.ir.persistence.IRReaderDecoder, .IRWriterEncoder, org.jruby.ir.transformations.inlining.SimpleCloneInfo, org.jruby.parser.StaticScope, org.jruby.runtime.DynamicScope, .ThreadContext, org.jruby.runtime.builtin.IRubyObject

Field Summary

Modifier and TypeField and Description
protected final int
protected final boolean
protected final RubySymbol
protected final int
protected final int

Constructor Summary

AccessConstructor and Description
public
LocalVariable(RubySymbol name, int scopeDepth, int location)

public
LocalVariable(RubySymbol name, int scopeDepth, int location, boolean isOuterScopeVar)

Method Summary

Modifier and TypeMethod and Description
public Variable
public LocalVariable
cloneForDepth(int n)

Implements org.jruby.ir.operands.DepthCloneable.cloneForDepth.

How deep is this operand from where it is defined?

public static LocalVariable
public void
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

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

public String
public int
public RubySymbol
public int
public OperandType
public int
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
public boolean
public Object
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public void
Inherited from org.jruby.ir.operands.Variable:
addUsedVariablescanCopyPropagatecloneForInlininggetSimplifiedOperandgetValueisSelf

Field Detail

hcodeback to summary
protected final int hcode
isOuterScopeVarback to summary
protected final boolean isOuterScopeVar
nameback to summary
protected final RubySymbol name
offsetback to summary
protected final int offset
scopeDepthback to summary
protected final int scopeDepth

Constructor Detail

LocalVariableback to summary
public LocalVariable(RubySymbol name, int scopeDepth, int location)
LocalVariableback to summary
public LocalVariable(RubySymbol name, int scopeDepth, int location, boolean isOuterScopeVar)

Method Detail

cloneback to summary
public Variable clone(SimpleCloneInfo ii)

Implements abstract org.jruby.ir.operands.Variable.clone.

Annotations
@Override
cloneForDepthback to summary
public LocalVariable cloneForDepth(int n)

Implements org.jruby.ir.operands.DepthCloneable.cloneForDepth.

Doc from org.jruby.ir.operands.DepthCloneable.cloneForDepth.

How deep is this operand from where it is defined?

decodeback to summary
public static LocalVariable decode(IRReaderDecoder d)
encodeback to summary
public void encode(IRWriterEncoder e)

Overrides org.jruby.ir.operands.Operand.encode.

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

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
obj: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
getIdback to summary
public String getId()

Implements abstract org.jruby.ir.operands.Variable.getId.

Annotations
@Override
getLocationback to summary
public int getLocation()
getNameback to summary
public RubySymbol getName()
getOffsetback to summary
public int getOffset()
getOperandTypeback to summary
public OperandType getOperandType()

Implements abstract org.jruby.ir.operands.Operand.getOperandType.

Annotations
@Override
getScopeDepthback to summary
public int getScopeDepth()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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 this object

Annotations
@Override
isOuterScopeVarback to summary
public boolean isOuterScopeVar()
isSameDepthback to summary
public boolean isSameDepth(LocalVariable other)
retrieveback to summary
public Object retrieve(ThreadContext context, IRubyObject self, StaticScope currScope, DynamicScope currDynScope, Object[] temp)

Overrides org.jruby.ir.operands.Operand.retrieve.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
visitback to summary
public void visit(IRVisitor visitor)

Overrides org.jruby.ir.operands.Operand.visit.

Annotations
@Override