Top Description Fields Constructors Methods
org.jruby.ir.operands

public Class ClosureLocalVariable

extends LocalVariable
Class Inheritance
Imports
org.jruby.RubySymbol, org.jruby.ir.IRVisitor, org.jruby.ir.persistence.IRWriterEncoder, org.jruby.ir.transformations.inlining.SimpleCloneInfo
This represents a non-temporary variable used in a closure and defined in this or a parent closure.

Field Summary

Inherited from org.jruby.ir.operands.LocalVariable:
hcodeisOuterScopeVarnameoffsetscopeDepth

Constructor Summary

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

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

Method Summary

Modifier and TypeMethod and Description
public Variable
clone(SimpleCloneInfo ii)

Overrides org.jruby.ir.operands.LocalVariable.clone.

public LocalVariable
cloneForDepth(int n)

Overrides org.jruby.ir.operands.LocalVariable.cloneForDepth.

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

How deep is this operand from where it is defined?

public void
encode(IRWriterEncoder e)

Overrides org.jruby.ir.operands.LocalVariable.encode.

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

Overrides org.jruby.ir.operands.LocalVariable.equals.

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

public String
toString()

Overrides org.jruby.ir.operands.LocalVariable.toString.

Returns a string representation of the object.

public void
visit(IRVisitor visitor)

Overrides org.jruby.ir.operands.LocalVariable.visit.

Inherited from org.jruby.ir.operands.LocalVariable:
decodegetIdgetLocationgetNamegetOffsetgetOperandTypegetScopeDepthhashCodeisOuterScopeVarisSameDepthretrieve

Constructor Detail

ClosureLocalVariableback to summary
public ClosureLocalVariable(RubySymbol name, int scopeDepth, int location)
ClosureLocalVariableback to summary
public ClosureLocalVariable(RubySymbol name, int scopeDepth, int location, boolean isOuterScopeVar)

Method Detail

cloneback to summary
public Variable clone(SimpleCloneInfo ii)

Overrides org.jruby.ir.operands.LocalVariable.clone.

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

Overrides org.jruby.ir.operands.LocalVariable.cloneForDepth.

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?

encodeback to summary
public void encode(IRWriterEncoder e)

Overrides org.jruby.ir.operands.LocalVariable.encode.

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

Overrides org.jruby.ir.operands.LocalVariable.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
toStringback to summary
public String toString()

Overrides org.jruby.ir.operands.LocalVariable.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.LocalVariable.visit.

Annotations
@Override