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>, java.util.Iterator<java.lang.Object>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

public class RubyEnumerator
extends RubyObject
implements java.util.Iterator<java.lang.Object>

Implementation of Ruby's Enumerator module.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RubyEnumerator.SizeFn "Function" type for java-created enumerators with size.

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

FIELD_ALLOCATED_CLASSES, FIELD_ALLOCATOR_SET, 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, 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

Method Summary

Modifier and Type	Method and Description
static void	defineEnumerator(Ruby runtime)
IRubyObject	dup() RubyMethod dup.
IRubyObject	each_cons(ThreadContext context, IRubyObject arg, Block block)
IRubyObject	each_cons19(ThreadContext context, IRubyObject arg, Block block) Deprecated.
IRubyObject	each_entry(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	each_slice(ThreadContext context, IRubyObject arg, Block block)
IRubyObject	each_slice19(ThreadContext context, IRubyObject arg, Block block) Deprecated.
IRubyObject	each_with_index(ThreadContext context, 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)
static IRubyObject	enumeratorize(Ruby runtime, IRubyObject object, java.lang.String method)
static IRubyObject	enumeratorize(Ruby runtime, IRubyObject object, java.lang.String method, IRubyObject... args)
static IRubyObject	enumeratorize(Ruby runtime, IRubyObject object, java.lang.String method, IRubyObject arg)
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)
static IRubyObject	enumeratorizeWithSize(ThreadContext context, IRubyObject object, java.lang.String method, IRubyObject[] args, RubyEnumerator.SizeFn sizeFn) Transform object into an Enumerator with the given size
static IRubyObject	enumeratorizeWithSize(ThreadContext context, IRubyObject object, java.lang.String method, IRubyObject arg, IRubyObject size)
static IRubyObject	enumeratorizeWithSize(ThreadContext context, IRubyObject object, java.lang.String method, RubyEnumerator.SizeFn sizeFn)
IRubyObject	feed(ThreadContext context, IRubyObject val)
protected void	finalize()
boolean	hasNext()
IRubyObject	initialize(ThreadContext context)
IRubyObject	initialize(ThreadContext context, Block block)
IRubyObject	initialize(ThreadContext context, IRubyObject[] args)
IRubyObject	initialize(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	initialize(ThreadContext context, IRubyObject object, Block block)
IRubyObject	initialize(ThreadContext context, IRubyObject object, IRubyObject method)
IRubyObject	initialize(ThreadContext context, IRubyObject object, IRubyObject method, Block block)
IRubyObject	initialize(ThreadContext context, IRubyObject object, IRubyObject method, IRubyObject methodArg)
IRubyObject	initialize(ThreadContext context, IRubyObject object, IRubyObject method, IRubyObject methodArg, Block block)
IRubyObject	initialize19(ThreadContext context, Block block) Deprecated.
IRubyObject	initialize19(ThreadContext context, IRubyObject[] args, Block block) Deprecated.
IRubyObject	initialize19(ThreadContext context, IRubyObject object, IRubyObject method, Block block) Deprecated.
IRubyObject	initialize19(ThreadContext context, IRubyObject object, IRubyObject method, IRubyObject methodArg, Block block) Deprecated.
IRubyObject	initialize20(ThreadContext context, Block block) Deprecated.
IRubyObject	initialize20(ThreadContext context, IRubyObject[] args, Block block) Deprecated.
IRubyObject	initialize20(ThreadContext context, IRubyObject object, Block block) Deprecated.
IRubyObject	initialize20(ThreadContext context, IRubyObject object, IRubyObject method, Block block) Deprecated.
IRubyObject	initialize20(ThreadContext context, IRubyObject object, IRubyObject method, IRubyObject methodArg, Block block) Deprecated.
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)
java.lang.Object	next()
IRubyObject	next(ThreadContext context)
IRubyObject	nextValues(ThreadContext context)
IRubyObject	peek(ThreadContext context)
IRubyObject	peekValues(ThreadContext context)
void	remove()
IRubyObject	rewind(ThreadContext context)
long	size()
IRubyObject	size(ThreadContext context)
IRubyObject	with_index(ThreadContext context, Block block)
IRubyObject	with_index(ThreadContext context, IRubyObject arg, Block block)
IRubyObject	with_index19(ThreadContext context, Block block) Deprecated.
IRubyObject	with_index19(ThreadContext context, IRubyObject arg, Block block) Deprecated.
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, dig, eqlInternal, equalInternal, equals, getNativeClassIndex, hashCode, 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, callMethod, callSuper, checkArrayType, checkCallMethod, 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, 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, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, 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_added19, singleton_method_removed19, singleton_method_undefined19, singleton_methods, 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, 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

Methods inherited from interface java.util.Iterator

forEachRemaining

Method Detail

defineEnumerator

public static void defineEnumerator(Ruby runtime)

enumeratorizeWithSize

public static IRubyObject enumeratorizeWithSize(ThreadContext context,
                                                IRubyObject object,
                                                java.lang.String method,
                                                IRubyObject[] args,
                                                RubyEnumerator.SizeFn sizeFn)

Transform object into an Enumerator with the given size

enumeratorizeWithSize

public static IRubyObject enumeratorizeWithSize(ThreadContext context,
                                                IRubyObject object,
                                                java.lang.String method,
                                                RubyEnumerator.SizeFn sizeFn)

enumeratorizeWithSize

public static IRubyObject enumeratorizeWithSize(ThreadContext context,
                                                IRubyObject object,
                                                java.lang.String method,
                                                IRubyObject arg,
                                                IRubyObject size)

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 RubyBasicObject

initialize

public IRubyObject initialize(ThreadContext context,
                              Block block)

initialize19

@Deprecated
public IRubyObject initialize19(ThreadContext context,
                                            Block block)

Deprecated.

initialize20

@Deprecated
public IRubyObject initialize20(ThreadContext context,
                                            Block block)

Deprecated.

initialize

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

initialize20

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

Deprecated.

initialize

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

initialize20

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

Deprecated.

initialize

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

initialize

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

initialize19

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

Deprecated.

initialize20

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

Deprecated.

initialize

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

initialize

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

initialize19

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

Deprecated.

initialize20

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

Deprecated.

initialize

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

initialize19

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

Deprecated.

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)

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

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

Deprecated.

each_slice

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

each_cons19

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

Deprecated.

each_cons

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

size

public final IRubyObject size(ThreadContext context)

size

public long size()

each_with_index

public IRubyObject each_with_index(ThreadContext context,
                                   Block block)

with_index

public IRubyObject with_index(ThreadContext context,
                              Block block)

with_index19

@Deprecated
public IRubyObject with_index19(ThreadContext context,
                                            Block block)

Deprecated.

with_index

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

with_index19

@Deprecated
public IRubyObject with_index19(ThreadContext context,
                                            IRubyObject arg,
                                            Block block)

Deprecated.

next

public IRubyObject next(ThreadContext context)

rewind

public IRubyObject rewind(ThreadContext context)

peek

public IRubyObject peek(ThreadContext context)

peekValues

public IRubyObject peekValues(ThreadContext context)

nextValues

public IRubyObject nextValues(ThreadContext context)

feed

public IRubyObject feed(ThreadContext context,
                        IRubyObject val)

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<java.lang.Object>

next

public java.lang.Object next()

Specified by:

next in interface java.util.Iterator<java.lang.Object>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<java.lang.Object>