Package org.jruby.runtime

Class Binding

java.lang.Object

org.jruby.runtime.Binding

public class Binding
extends Object

Internal live representation of a block ({...} or do ... end).

Field Summary

Fields

Modifier and Type	Field	Description
static final Binding	DUMMY	Deprecated.
private DynamicScope	dummyScope
private final DynamicScope	dynamicScope	A reference to all variable values (and names) that are in-scope for this block.
private DynamicScope	evalScope	Binding-local scope for 1.9 mode.
private Binding	evalScopeBinding	Location of eval scope.
String	filename
private final Frame	frame	frame of method which defined this block
int	line
String	method
private IRubyObject	self	'self' at point when the block is defined
private Visibility	visibility

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Binding(Binding other)
	Binding(IRubyObject self)
	Binding(IRubyObject self, DynamicScope dynamicScope)
	Binding(IRubyObject self, Frame frame, Visibility visibility)
	Binding(IRubyObject self, Frame frame, Visibility visibility, DynamicScope dynamicScope)
	Binding(IRubyObject self, Frame frame, Visibility visibility, DynamicScope dynamicScope, String method, String filename, int line)
private	Binding(IRubyObject self, Frame frame, Visibility visibility, DynamicScope dynamicScope, String method, String filename, int line, DynamicScope dummyScope)
	Binding(IRubyObject self, Frame frame, Visibility visibility, DynamicScope dynamicScope, BacktraceElement backtrace)	Deprecated.
	Binding(Frame frame, DynamicScope dynamicScope, String method, String filename, int line)
	Binding(Frame frame, DynamicScope dynamicScope, BacktraceElement backtrace)	Deprecated.

Method Summary

Modifier and Type	Method	Description
Binding	clone()	Clone the binding.
Binding	cloneForEval()	Clone the binding, but maintain a reference to the original "eval binding" to continue sharing eval context.
boolean	equals(Object other)
BacktraceElement	getBacktrace()	Deprecated.
DynamicScope	getDummyScope(StaticScope staticScope)
DynamicScope	getDynamicScope()	Gets the dynamicVariables that are local to this block.
final DynamicScope	getEvalScope(Ruby runtime)
String	getFile()
Frame	getFrame()	Gets the frame.
int	getLine()
String	getMethod()
IRubyObject	getSelf()
Visibility	getVisibility()
void	setFile(String filename)
void	setLine(int line)
void	setMethod(String method)
void	setSelf(IRubyObject self)
void	setVisibility(Visibility visibility)

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

frame

private final Frame frame

frame of method which defined this block

method

public String method

filename

public String filename

line

public int line

visibility

private Visibility visibility

self

private IRubyObject self

'self' at point when the block is defined

dynamicScope

private final DynamicScope dynamicScope

A reference to all variable values (and names) that are in-scope for this block.

evalScope

private DynamicScope evalScope

Binding-local scope for 1.9 mode.

evalScopeBinding

private Binding evalScopeBinding

Location of eval scope. Because bindings are usually cloned before used for eval, we indirect the reference of the eval scope through another Binding reference, allowing us to share the same eval scope across multiple cloned Binding instances.

dummyScope

private DynamicScope dummyScope

DUMMY

@Deprecated
public static final Binding DUMMY

Deprecated.

Constructor Details

Binding

public Binding(IRubyObject self,
 Frame frame,
 Visibility visibility,
 DynamicScope dynamicScope,
 String method,
 String filename,
 int line)

Binding

private Binding(IRubyObject self,
 Frame frame,
 Visibility visibility,
 DynamicScope dynamicScope,
 String method,
 String filename,
 int line,
 DynamicScope dummyScope)

Binding

public Binding(Frame frame,
 DynamicScope dynamicScope,
 String method,
 String filename,
 int line)

Binding

public Binding(IRubyObject self)

Binding

public Binding(IRubyObject self,
 Frame frame,
 Visibility visibility)

Binding

public Binding(IRubyObject self,
 DynamicScope dynamicScope)

Binding

public Binding(IRubyObject self,
 Frame frame,
 Visibility visibility,
 DynamicScope dynamicScope)

Binding

private Binding(Binding other)

Binding

@Deprecated
public Binding(IRubyObject self,
 Frame frame,
 Visibility visibility,
 DynamicScope dynamicScope,
 BacktraceElement backtrace)

Deprecated.

Binding

@Deprecated
public Binding(Frame frame,
 DynamicScope dynamicScope,
 BacktraceElement backtrace)

Deprecated.

Method Details

cloneForEval

public Binding cloneForEval()

Clone the binding, but maintain a reference to the original "eval binding" to continue sharing eval context.

Returns:

a new Binding with shared eval context

clone

public Binding clone()

Clone the binding. The frame will be duplicated, and eval context will point to the new binding, but other fields will be copied as-is.

Overrides:

clone in class Object

Returns:

a new cloned Binding

getVisibility

public Visibility getVisibility()

setVisibility

public void setVisibility(Visibility visibility)

getSelf

public IRubyObject getSelf()

setSelf

public void setSelf(IRubyObject self)

getDynamicScope

public DynamicScope getDynamicScope()

Gets the dynamicVariables that are local to this block. Parent dynamic scopes are also accessible via the current dynamic scope.

Returns:

Returns all relevant variable scoping information

getDummyScope

public DynamicScope getDummyScope(StaticScope staticScope)

getFrame

public Frame getFrame()

Gets the frame.

Returns:

Returns a RubyFrame

getFile

public String getFile()

setFile

public void setFile(String filename)

getLine

public int getLine()

setLine

public void setLine(int line)

getMethod

public String getMethod()

setMethod

public void setMethod(String method)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getEvalScope

public final DynamicScope getEvalScope(Ruby runtime)

getBacktrace

@Deprecated
public BacktraceElement getBacktrace()

Deprecated.