org.jruby

Class RubyProc

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyProc

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType, DataType

public class RubyProc
extends RubyObject
implements DataType

Author:

jpetersen

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, UNTRUST_F, 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

Modifier	Constructor and Description
protected	RubyProc(Ruby runtime, RubyClass rubyClass, Block.Type type)
protected	RubyProc(Ruby runtime, RubyClass rubyClass, Block.Type type, ISourcePosition sourcePosition) Deprecated.
protected	RubyProc(Ruby runtime, RubyClass rubyClass, Block.Type type, java.lang.String file, int line)
	RubyProc(Ruby runtime, RubyClass rubyClass, Block block, java.lang.String file, int line)

Method Summary

Modifier and Type	Method and Description
RubyFixnum	arity()
IRubyObject	binding()
IRubyObject	call(ThreadContext context, Block blockCallArg)
IRubyObject	call(ThreadContext context, IRubyObject... args)
IRubyObject	call(ThreadContext context, IRubyObject arg)
IRubyObject	call(ThreadContext context, IRubyObject[] args, Block blockCallArg)
IRubyObject	call(ThreadContext context, IRubyObject[] args, IRubyObject self, Block passedBlock) Deprecated.
IRubyObject	call(ThreadContext context, IRubyObject[] args, IRubyObject self, RubyModule sourceModule, Block passedBlock)
IRubyObject	call(ThreadContext context, IRubyObject arg0, Block blockCallArg)
IRubyObject	call(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block blockCallArg)
IRubyObject	call(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block blockCallArg)
IRubyObject	call19(ThreadContext context, IRubyObject[] args, Block block) Deprecated.
static RubyClass	createProcClass(Ruby runtime)
IRubyObject	dup() 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	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, ISourcePosition sourcePosition) Deprecated.
static RubyProc	newProc(Ruby runtime, Block block, Block.Type type, java.lang.String file, int line)
IRubyObject	parameters(ThreadContext context)
static IRubyObject[]	prepareArgs(ThreadContext context, Block.Type type, BlockBody blockBody, IRubyObject[] args) For Type.LAMBDA, ensures that the args have the correct arity.
IRubyObject	rbClone() RubyMethod clone.
IRubyObject	source_location(ThreadContext context)
RubyProc	to_proc()
IRubyObject	to_s() rb_any_to_s call-seq: obj.to_s => string Returns a string representing obj.
IRubyObject	to_s19() Deprecated.

Methods inherited from class org.jruby.RubyObject

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

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, ensureInstanceVariablesSettable, eql_p, eql, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize_copy, initialize, initialize19, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing, method_missing19, method, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal_19, op_equal, op_match, op_match19, op_not_equal, op_not_match, op_not, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_method, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, toJava, trust, type_deprecated, 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

array

Constructor Detail

RubyProc

protected RubyProc(Ruby runtime,
                   RubyClass rubyClass,
                   Block.Type type)

RubyProc

@Deprecated
protected RubyProc(Ruby runtime,
                               RubyClass rubyClass,
                               Block.Type type,
                               ISourcePosition sourcePosition)

Deprecated.

RubyProc

protected RubyProc(Ruby runtime,
                   RubyClass rubyClass,
                   Block.Type type,
                   java.lang.String file,
                   int line)

RubyProc

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

Method Detail

createProcClass

public static RubyClass createProcClass(Ruby runtime)

getBlock

public Block getBlock()

newProc

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

Deprecated.

newProc

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

newProc

@Deprecated
public static RubyProc newProc(Ruby runtime,
                                           Block block,
                                           Block.Type type,
                                           ISourcePosition sourcePosition)

Deprecated.

newProc

public static RubyProc newProc(Ruby runtime,
                               Block block,
                               Block.Type type,
                               java.lang.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()

Description copied from interface: IRubyObject

RubyMethod clone.

Specified by:

rbClone in interface IRubyObject

Overrides:

rbClone in class RubyBasicObject

Returns:

a cloned object

dup

public IRubyObject dup()

Description copied from interface: IRubyObject

RubyMethod dup.

Specified by:

dup in interface IRubyObject

Overrides:

dup in class RubyBasicObject

Returns:

a dup-ed object

to_s

public IRubyObject to_s()

Description copied from class: RubyBasicObject

rb_any_to_s call-seq: obj.to_s => string Returns a string representing obj. The default to_s prints the object's class and an encoding of the object id. As a special case, the top-level object that is the initial execution context of Ruby programs returns ``main.''

Overrides:

to_s in class RubyBasicObject

binding

public IRubyObject binding()

prepareArgs

public static IRubyObject[] prepareArgs(ThreadContext context,
                                        Block.Type type,
                                        BlockBody blockBody,
                                        IRubyObject[] args)

For Type.LAMBDA, ensures that the args have the correct arity. For others, transforms the given arguments appropriately for the given arity (i.e. trimming to one arg for fixed arity of one, etc.)

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

public RubyFixnum arity()

to_proc

public RubyProc to_proc()

source_location

public IRubyObject source_location(ThreadContext context)

parameters

public IRubyObject parameters(ThreadContext context)

lambda_p

public IRubyObject lambda_p(ThreadContext context)

call19

@Deprecated
public final IRubyObject call19(ThreadContext context,
                                            IRubyObject[] args,
                                            Block block)

Deprecated.

to_s19

@Deprecated
public IRubyObject to_s19()

Deprecated.

call

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

Deprecated.