Module org.jruby.base

Package org.jruby

Class RubyProc

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyProc

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType, DataType

public class RubyProc
extends RubyObject
implements DataType

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jruby.RubyObject

RubyObject.Data

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

RubyBasicObject.Finalizer

Field Summary

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Constructor Summary

Constructors

Constructor	Description
RubyProc(Ruby runtime, RubyClass rubyClass, Block block, String file, int line)	Construct a new RubyProc with the given parameters.
RubyProc(Ruby runtime, RubyClass rubyClass, Block block, Block.Type type, boolean fromMethod)	Construct a new RubyProc with the given parameters.

Method Summary

Modifier and Type	Method	Description
RubyFixnum	arity()	Deprecated.
RubyFixnum	arity(ThreadContext context)
IRubyObject	binding()
final IRubyObject	call(ThreadContext context, Block blockCallArg)
final IRubyObject	call(ThreadContext context, IRubyObject arg)
final IRubyObject	call(ThreadContext context, IRubyObject... args)
final IRubyObject	call(ThreadContext context, IRubyObject[] args, Block blockCallArg)
final IRubyObject	call(ThreadContext context, IRubyObject[] args, IRubyObject self, RubyModule sourceModule, Block passedBlock)
final IRubyObject	call(ThreadContext context, IRubyObject[] args, IRubyObject self, Block passedBlock)	Deprecated.
final IRubyObject	call(ThreadContext context, IRubyObject arg0, Block blockCallArg)
final IRubyObject	call(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block blockCallArg)
final IRubyObject	call(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block blockCallArg)
static RubyClass	createProcClass(ThreadContext context, RubyClass Object)
IRubyObject	dup()	Deprecated.
IRubyObject	dup(ThreadContext context)	RubyMethod dup.
Block	getBlock()
IRubyObject	lambda_p(ThreadContext context)
static IRubyObject	newInstance(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)	Create a new instance of a Proc object.
static RubyProc	newMethodProc(Ruby runtime, Block block)
static RubyProc	newProc(Ruby runtime, RubyClass clazz, Block block, Block.Type type, String file, int line)
static RubyProc	newProc(Ruby runtime, Block.Type type)	Deprecated.
static RubyProc	newProc(Ruby runtime, Block block, Block.Type type)
static RubyProc	newProc(Ruby runtime, Block block, Block.Type type, String file, int line)
IRubyObject	op_equal(ThreadContext context, IRubyObject obj)	rb_obj_equal Will by default use identity equality to compare objects.
IRubyObject	parameters(ThreadContext context)
IRubyObject	parameters(ThreadContext context, IRubyObject opts)
static IRubyObject[]	prepareArgs(ThreadContext context, Block.Type type, BlockBody blockBody, IRubyObject[] args)	Deprecated.
IRubyObject	rbClone()	Deprecated.
IRubyObject	rbClone(ThreadContext context)
IRubyObject	ruby2_keywords(ThreadContext context)
void	setFromMethod()	Deprecated. fromMethod is now final
IRubyObject	source_location(ThreadContext context)
RubyProc	to_proc()
IRubyObject	to_s(ThreadContext context)
<T> T	toJava(Class<T> target)	Convert the object to the specified Java class, if possible.

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, dig, dig1, dig2, eqlInternal, equalInternal, equals, finishObjectClass, getNativeClassIndex, hashCode, inspect, op_eqq, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

__id__, addFinalizer, addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql, eql_p, eql_p, equal_p, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, freeze, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMarshalVariableList, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize_copy, initialize_copy, inspect, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval, instance_exec, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, methods, nil_p, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_match, op_not, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, singletonClass, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, trust, type, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jruby.runtime.builtin.IRubyObject

checkStringType19, marshalLiveVariables

Constructor Details

RubyProc

public RubyProc(Ruby runtime,
 RubyClass rubyClass,
 Block block,
 String file,
 int line)

Construct a new RubyProc with the given parameters. The Block's proc object will be set to this RubyProc.

Parameters:

runtime -

rubyClass -

block -

file -

line -

RubyProc

public RubyProc(Ruby runtime,
 RubyClass rubyClass,
 Block block,
 Block.Type type,
 boolean fromMethod)

Construct a new RubyProc with the given parameters. The Block's proc object will be set to this RubyProc.

Parameters:

runtime -

rubyClass -

block -

fromMethod -

Method Details

createProcClass

public static RubyClass createProcClass(ThreadContext context,
 RubyClass Object)

getBlock

public Block getBlock()

newProc

@Deprecated(since="1.6.0")
public static RubyProc newProc(Ruby runtime,
 Block.Type type)

Deprecated.

newProc

public static RubyProc newProc(Ruby runtime,
 Block block,
 Block.Type type)

newMethodProc

public static RubyProc newMethodProc(Ruby runtime,
 Block block)

newProc

public static RubyProc newProc(Ruby runtime,
 Block block,
 Block.Type type,
 String file,
 int line)

newProc

public static RubyProc newProc(Ruby runtime,
 RubyClass clazz,
 Block block,
 Block.Type type,
 String file,
 int line)

newInstance

public static IRubyObject newInstance(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args,
 Block block)

Create a new instance of a Proc object. We override this method (from RubyClass) since we need to deal with special case of Proc.new with no arguments or block arg. In this case, we need to check previous frame for a block to consume.

rbClone

public IRubyObject rbClone(ThreadContext context)

dup

public IRubyObject dup(ThreadContext context)

Description copied from interface: IRubyObject

RubyMethod dup.

Specified by:

dup in interface IRubyObject

Parameters:

context - the thread context

Returns:

a dup-ed object

to_s

public IRubyObject to_s(ThreadContext context)

Overrides:

to_s in class RubyBasicObject

ruby2_keywords

public IRubyObject ruby2_keywords(ThreadContext context)

binding

public IRubyObject binding()

op_equal

public IRubyObject op_equal(ThreadContext context,
 IRubyObject obj)

Description copied from class: RubyBasicObject

rb_obj_equal Will by default use identity equality to compare objects. This follows the Ruby semantics. The name of this method doesn't follow the convention because hierarchy problems

Specified by:

op_equal in interface IRubyObject

Overrides:

op_equal in class RubyBasicObject

prepareArgs

@Deprecated(since="9.3.0.0")
public static IRubyObject[] prepareArgs(ThreadContext context,
 Block.Type type,
 BlockBody blockBody,
 IRubyObject[] args)

Deprecated.

For non-lambdas transforms the given arguments appropriately for the given arity (i.e. trimming to one arg for fixed arity of one, etc.) Note: nothing should be calling this any more.

call

public final IRubyObject call(ThreadContext context,
 IRubyObject[] args,
 Block blockCallArg)

call

public final IRubyObject call(ThreadContext context,
 Block blockCallArg)

call

public final IRubyObject call(ThreadContext context,
 IRubyObject arg0,
 Block blockCallArg)

call

public final IRubyObject call(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 Block blockCallArg)

call

public final IRubyObject call(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2,
 Block blockCallArg)

call

public final IRubyObject call(ThreadContext context,
 IRubyObject arg)

call

public final IRubyObject call(ThreadContext context,
 IRubyObject... args)

call

public final IRubyObject call(ThreadContext context,
 IRubyObject[] args,
 IRubyObject self,
 RubyModule sourceModule,
 Block passedBlock)

arity

@Deprecated(since="10.0.0.0")
public RubyFixnum arity()

Deprecated.

arity

public RubyFixnum arity(ThreadContext context)

to_proc

public RubyProc to_proc()

source_location

public IRubyObject source_location(ThreadContext context)

parameters

public IRubyObject parameters(ThreadContext context)

parameters

public IRubyObject parameters(ThreadContext context,
 IRubyObject opts)

lambda_p

public IRubyObject lambda_p(ThreadContext context)

toJava

public <T> T toJava(Class<T> target)

Description copied from interface: IRubyObject

Convert the object to the specified Java class, if possible.

Specified by:

toJava in interface IRubyObject

Overrides:

toJava in class RubyBasicObject

Type Parameters:

T - type

Parameters:

target - The target type to which the object should be converted.

Returns:

java type

See Also:

• IRubyObject.toJava(java.lang.Class<T>)

call

@Deprecated(since="9.2.10.0")
public final IRubyObject call(ThreadContext context,
 IRubyObject[] args,
 IRubyObject self,
 Block passedBlock)

Deprecated.

rbClone

@Deprecated(since="10.0.0.0")
public IRubyObject rbClone()

Deprecated.

Description copied from interface: IRubyObject

RubyMethod clone.

Specified by:

rbClone in interface IRubyObject

Overrides:

rbClone in class RubyBasicObject

Returns:

a cloned object

dup

@Deprecated(since="10.0.0.0")
public IRubyObject dup()

Deprecated.

Description copied from interface: IRubyObject

RubyMethod dup.

Specified by:

dup in interface IRubyObject

Overrides:

dup in class RubyBasicObject

Returns:

a dup-ed object

setFromMethod

@Deprecated(since="10.0.3.0")
public void setFromMethod()

Deprecated.

fromMethod is now final