org.jruby

Class RubyEnumerator

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyEnumerator

All Implemented Interfaces:

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

public class RubyEnumerator
extends RubyObject

Implementation of Ruby's Enumerator module.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	RubyEnumerator.ArrayNexter
private static class	RubyEnumerator.Nexter
private static class	RubyEnumerator.ThreadedNexter

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

Modifier and Type	Field and Description
private static ObjectAllocator	ENUMERATOR_ALLOCATOR
private java.lang.String	method method to invoke for each operation
private IRubyObject[]	methodArgs args to each method
private RubyEnumerator.Nexter	nexter
private IRubyObject	object target for each operation
private IRubyObject	size A value or proc to provide the size of the Enumerator contents

Fields inherited from class org.jruby.RubyObject

FIELD_ALLOCATED_CLASSES, FIELD_ALLOCATORS, IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, OBJECT_VAR0_ALLOCATOR, OBJECT_VAR1_ALLOCATOR, OBJECT_VAR2_ALLOCATOR, OBJECT_VAR3_ALLOCATOR, OBJECT_VAR4_ALLOCATOR, OBJECT_VAR5_ALLOCATOR, OBJECT_VAR6_ALLOCATOR, OBJECT_VAR7_ALLOCATOR, OBJECT_VAR8_ALLOCATOR, OBJECT_VAR9_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, metaClass, NEVER, NIL_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUSTED_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, VAR_TABLE_OFFSET, varTable, varTableStamp

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

NULL_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
private	RubyEnumerator(Ruby runtime, RubyClass type)
private	RubyEnumerator(Ruby runtime, RubyClass type, IRubyObject object, IRubyObject method, IRubyObject[] args)

Method Summary

Modifier and Type	Method and Description
static void	defineEnumerator(Ruby runtime)
IRubyObject	dup() RubyMethod dup.
IRubyObject	each_cons19(ThreadContext context, IRubyObject arg, Block block)
IRubyObject	each_entry(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	each_slice19(ThreadContext context, IRubyObject arg, Block block)
static IRubyObject	each_with_index(ThreadContext context, IRubyObject self, Block block)
IRubyObject	each_with_object(ThreadContext context, IRubyObject arg, Block block)
IRubyObject	each(ThreadContext context, Block block) Send current block and supplied args to method on target.
IRubyObject	each(ThreadContext context, IRubyObject[] args, Block block)
private void	ensureNexter(ThreadContext context)
IRubyObject	enum_cons(ThreadContext context, IRubyObject arg, Block block)
IRubyObject	enum_slice(ThreadContext context, IRubyObject arg, Block block)
static IRubyObject	enumeratorize(Ruby runtime, IRubyObject object, java.lang.String method)
static IRubyObject	enumeratorize(Ruby runtime, IRubyObject object, java.lang.String method, IRubyObject arg)
static IRubyObject	enumeratorize(Ruby runtime, IRubyObject object, java.lang.String method, IRubyObject[] args)
static IRubyObject	enumeratorize(Ruby runtime, RubyClass type, IRubyObject object, java.lang.String method)
static IRubyObject	enumeratorize(Ruby runtime, RubyClass type, IRubyObject object, java.lang.String method, IRubyObject arg)
static IRubyObject	enumeratorize(Ruby runtime, RubyClass type, IRubyObject object, java.lang.String method, IRubyObject[] args)
protected void	finalize()
private IRubyObject	initialize(IRubyObject object, IRubyObject method, IRubyObject[] methodArgs)
IRubyObject	initialize(ThreadContext context)
IRubyObject	initialize(ThreadContext context, IRubyObject object)
IRubyObject	initialize(ThreadContext context, IRubyObject[] args)
IRubyObject	initialize(ThreadContext context, IRubyObject object, IRubyObject method)
IRubyObject	initialize(ThreadContext context, IRubyObject object, IRubyObject method, IRubyObject methodArg)
IRubyObject	initialize19(ThreadContext context, Block block)
IRubyObject	initialize19(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	initialize19(ThreadContext context, IRubyObject object, Block block)
IRubyObject	initialize19(ThreadContext context, IRubyObject object, IRubyObject method, Block block)
IRubyObject	initialize19(ThreadContext context, IRubyObject object, IRubyObject method, IRubyObject methodArg, Block block)
private IRubyObject	initialize20(IRubyObject object, IRubyObject method, IRubyObject[] methodArgs, IRubyObject size)
IRubyObject	initialize20(ThreadContext context, Block block)
IRubyObject	initialize20(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	initialize20(ThreadContext context, IRubyObject object, Block block)
IRubyObject	initialize20(ThreadContext context, IRubyObject object, IRubyObject method, Block block)
IRubyObject	initialize20(ThreadContext context, IRubyObject object, IRubyObject method, IRubyObject methodArg, Block block)
private IRubyObject	inspect(ThreadContext context, boolean recurse)
IRubyObject	inspect19(ThreadContext context)
protected static IRubyObject	newEnumerator(ThreadContext context, IRubyObject arg)
protected static IRubyObject	newEnumerator(ThreadContext context, IRubyObject arg1, IRubyObject arg2)
protected static IRubyObject	newEnumerator(ThreadContext context, IRubyObject arg1, IRubyObject arg2, IRubyObject arg3)
IRubyObject	next(ThreadContext context)
IRubyObject	peek(ThreadContext context)
IRubyObject	rewind(ThreadContext context)
IRubyObject	size(ThreadContext context)
private static IRubyObject	with_index_common(ThreadContext context, IRubyObject self, Block block, java.lang.String rubyMethodName, IRubyObject arg)
static IRubyObject	with_index(ThreadContext context, IRubyObject self, Block block)
static IRubyObject	with_index19(ThreadContext context, IRubyObject self, Block block)
static IRubyObject	with_index19(ThreadContext context, IRubyObject self, IRubyObject arg, Block block)
IRubyObject	with_object(ThreadContext context, IRubyObject arg, Block block)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, eqlInternal, equalInternal, equals, getNativeTypeIndex, hashCode, initialize, inspect, op_eqq, puts, specificEval, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, 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, getNativeHandle, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id_deprecated, id, infectBy, infectBy, infectBy, initialize_copy, 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, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing19, method, method19, methods, methods, methods19, nil_p, 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, recacheBuiltinMethods, 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_added19, singleton_method_removed19, singleton_method_undefined19, singleton_methods, singleton_methods19, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_s, toJava, trust, type_deprecated, type, untaint, untrust, untrusted_p, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

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

Field Detail

object

private IRubyObject object

target for each operation

method

private java.lang.String method

method to invoke for each operation

methodArgs

private IRubyObject[] methodArgs

args to each method

size

private IRubyObject size

A value or proc to provide the size of the Enumerator contents

ENUMERATOR_ALLOCATOR

private static ObjectAllocator ENUMERATOR_ALLOCATOR

nexter

private volatile RubyEnumerator.Nexter nexter

Constructor Detail

RubyEnumerator

private RubyEnumerator(Ruby runtime,
                       RubyClass type)

RubyEnumerator

private RubyEnumerator(Ruby runtime,
                       RubyClass type,
                       IRubyObject object,
                       IRubyObject method,
                       IRubyObject[] args)

Method Detail

defineEnumerator

public static void defineEnumerator(Ruby runtime)

enumeratorize

public static IRubyObject enumeratorize(Ruby runtime,
                                        IRubyObject object,
                                        java.lang.String method)

enumeratorize

public static IRubyObject enumeratorize(Ruby runtime,
                                        IRubyObject object,
                                        java.lang.String method,
                                        IRubyObject arg)

enumeratorize

public static IRubyObject enumeratorize(Ruby runtime,
                                        IRubyObject object,
                                        java.lang.String method,
                                        IRubyObject[] args)

enumeratorize

public static IRubyObject enumeratorize(Ruby runtime,
                                        RubyClass type,
                                        IRubyObject object,
                                        java.lang.String method)

enumeratorize

public static IRubyObject enumeratorize(Ruby runtime,
                                        RubyClass type,
                                        IRubyObject object,
                                        java.lang.String method,
                                        IRubyObject arg)

enumeratorize

public static IRubyObject enumeratorize(Ruby runtime,
                                        RubyClass type,
                                        IRubyObject object,
                                        java.lang.String method,
                                        IRubyObject[] args)

initialize

public IRubyObject initialize(ThreadContext context)

Overrides:

initialize in class RubyObject

initialize19

public IRubyObject initialize19(ThreadContext context,
                                Block block)

initialize20

public IRubyObject initialize20(ThreadContext context,
                                Block block)

initialize

public IRubyObject initialize(ThreadContext context,
                              IRubyObject object)

initialize19

public IRubyObject initialize19(ThreadContext context,
                                IRubyObject object,
                                Block block)

initialize20

public IRubyObject initialize20(ThreadContext context,
                                IRubyObject object,
                                Block block)

initialize

public IRubyObject initialize(ThreadContext context,
                              IRubyObject object,
                              IRubyObject method)

initialize19

public IRubyObject initialize19(ThreadContext context,
                                IRubyObject object,
                                IRubyObject method,
                                Block block)

initialize20

public IRubyObject initialize20(ThreadContext context,
                                IRubyObject object,
                                IRubyObject method,
                                Block block)

initialize

public IRubyObject initialize(ThreadContext context,
                              IRubyObject object,
                              IRubyObject method,
                              IRubyObject methodArg)

initialize19

public IRubyObject initialize19(ThreadContext context,
                                IRubyObject object,
                                IRubyObject method,
                                IRubyObject methodArg,
                                Block block)

initialize20

public IRubyObject initialize20(ThreadContext context,
                                IRubyObject object,
                                IRubyObject method,
                                IRubyObject methodArg,
                                Block block)

initialize

public IRubyObject initialize(ThreadContext context,
                              IRubyObject[] args)

initialize19

public IRubyObject initialize19(ThreadContext context,
                                IRubyObject[] args,
                                Block block)

initialize20

public IRubyObject initialize20(ThreadContext context,
                                IRubyObject[] args,
                                Block block)

initialize

private IRubyObject initialize(IRubyObject object,
                               IRubyObject method,
                               IRubyObject[] methodArgs)

initialize20

private IRubyObject initialize20(IRubyObject object,
                                 IRubyObject method,
                                 IRubyObject[] methodArgs,
                                 IRubyObject size)

dup

public IRubyObject dup()

Description copied from interface: IRubyObject

RubyMethod dup.

Specified by:

dup in interface IRubyObject

Overrides:

dup in class RubyBasicObject

Returns:

each

public IRubyObject each(ThreadContext context,
                        Block block)

Send current block and supplied args to method on target. According to MRI Block may not be given and "each" should just ignore it and call on through to underlying method.

each

public IRubyObject each(ThreadContext context,
                        IRubyObject[] args,
                        Block block)

inspect19

public IRubyObject inspect19(ThreadContext context)

inspect

private IRubyObject inspect(ThreadContext context,
                            boolean recurse)

newEnumerator

protected static IRubyObject newEnumerator(ThreadContext context,
                                           IRubyObject arg)

newEnumerator

protected static IRubyObject newEnumerator(ThreadContext context,
                                           IRubyObject arg1,
                                           IRubyObject arg2)

newEnumerator

protected static IRubyObject newEnumerator(ThreadContext context,
                                           IRubyObject arg1,
                                           IRubyObject arg2,
                                           IRubyObject arg3)

each_with_object

public IRubyObject each_with_object(ThreadContext context,
                                    IRubyObject arg,
                                    Block block)

with_object

public IRubyObject with_object(ThreadContext context,
                               IRubyObject arg,
                               Block block)

each_entry

public IRubyObject each_entry(ThreadContext context,
                              IRubyObject[] args,
                              Block block)

each_slice19

public IRubyObject each_slice19(ThreadContext context,
                                IRubyObject arg,
                                Block block)

enum_slice

public IRubyObject enum_slice(ThreadContext context,
                              IRubyObject arg,
                              Block block)

each_cons19

public IRubyObject each_cons19(ThreadContext context,
                               IRubyObject arg,
                               Block block)

enum_cons

public IRubyObject enum_cons(ThreadContext context,
                             IRubyObject arg,
                             Block block)

size

public IRubyObject size(ThreadContext context)

with_index_common

private static IRubyObject with_index_common(ThreadContext context,
                                             IRubyObject self,
                                             Block block,
                                             java.lang.String rubyMethodName,
                                             IRubyObject arg)

each_with_index

public static IRubyObject each_with_index(ThreadContext context,
                                          IRubyObject self,
                                          Block block)

with_index

public static IRubyObject with_index(ThreadContext context,
                                     IRubyObject self,
                                     Block block)

with_index19

public static IRubyObject with_index19(ThreadContext context,
                                       IRubyObject self,
                                       Block block)

with_index19

public static IRubyObject with_index19(ThreadContext context,
                                       IRubyObject self,
                                       IRubyObject arg,
                                       Block block)

next

public IRubyObject next(ThreadContext context)

rewind

public IRubyObject rewind(ThreadContext context)

peek

public IRubyObject peek(ThreadContext context)

ensureNexter

private void ensureNexter(ThreadContext context)

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable