Package org.jruby

Class RubyEnumerator

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyEnumerator

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, Iterator<Object>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

public class RubyEnumerator
extends RubyObject
implements Iterator<Object>

Implementation of Ruby's Enumerator module.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RubyEnumerator.FeedValue	Internal Enumerator::FeedValue class to be shared between enumerator and its next-er Fiber.
static interface	RubyEnumerator.SizeFn<T extends IRubyObject>	"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

Modifier and Type	Field	Description
static final String	ARGS
private RubyEnumerator.FeedValue	feedValue
static final String	FEEDVALUE
static final String	GENERATOR
static final String	LOOKAHEAD
private String	method	method to invoke for each operation
static final String	METHOD
private IRubyObject[]	methodArgs	args to each method
private IRubyObject	object	target for each operation
static final String	OBJECT
private IRubyObject	size	A value or proc to provide the size of the Enumerator contents
private RubyEnumerator.SizeFn	sizeFn	Function object for lazily computing size (used for internally created enumerators)

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	Description
private	RubyEnumerator(Ruby runtime, RubyClass type)
private	RubyEnumerator(Ruby runtime, RubyClass type, IRubyObject object, RubySymbol method, IRubyObject[] args, IRubyObject size, RubyEnumerator.SizeFn sizeFn)
private	RubyEnumerator(Ruby runtime, RubyClass type, IRubyObject object, IRubyObject method, IRubyObject[] args)

Method Summary

Modifier and Type	Method	Description
private IRubyObject	__each__(ThreadContext context, Block block)
static IRubyObject	__from(ThreadContext context, IRubyObject klass, IRubyObject[] args)
static RubyClass	defineEnumerator(Ruby runtime, RubyModule Enumerable)
IRubyObject	dup()	RubyMethod dup.
IRubyObject	each(ThreadContext context, Block block)	Send current block and supplied args to method on target.
IRubyObject	each(ThreadContext context, IRubyObject[] args, Block block)
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)
static IRubyObject	enumeratorize(Ruby runtime, RubyClass type, IRubyObject object, String method)
static IRubyObject	enumeratorize(Ruby runtime, RubyClass type, IRubyObject object, String method, IRubyObject arg)
static IRubyObject	enumeratorize(Ruby runtime, RubyClass type, IRubyObject object, String method, IRubyObject[] args)
static IRubyObject	enumeratorize(Ruby runtime, IRubyObject object, String method)
static IRubyObject	enumeratorize(Ruby runtime, IRubyObject object, String method, IRubyObject arg)
static IRubyObject	enumeratorize(Ruby runtime, IRubyObject object, String method, IRubyObject... args)
static IRubyObject	enumeratorizeWithSize(ThreadContext context, IRubyObject object, String method, IRubyObject arg, IRubyObject size)
static <T extends IRubyObject> IRubyObject	enumeratorizeWithSize(ThreadContext context, T object, String method, RubyEnumerator.SizeFn<T> sizeFn)
static <T extends IRubyObject> IRubyObject	enumeratorizeWithSize(ThreadContext context, T object, String method, IRubyObject[] args, RubyEnumerator.SizeFn<T> sizeFn)
static <T extends IRubyObject> RubyEnumerator	enumWithSize(ThreadContext context, T object, String method, RubyEnumerator.SizeFn<T> sizeFn)
static <T extends IRubyObject> RubyEnumerator	enumWithSize(ThreadContext context, T object, String method, IRubyObject[] args, RubyEnumerator.SizeFn<T> sizeFn)	Transform object into an Enumerator with the given size
private IRubyObject	getGenerator()
boolean	hasNext()
private IRubyObject	initialize(Ruby runtime, IRubyObject object, IRubyObject method, IRubyObject[] methodArgs)
private IRubyObject	initialize(Ruby runtime, IRubyObject object, IRubyObject method, IRubyObject[] methodArgs, IRubyObject size, RubyEnumerator.SizeFn sizeFn)
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.
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)
Object	next()
IRubyObject	op_plus(ThreadContext context, IRubyObject obj)
void	remove()
private static JavaSites.FiberSites	sites(ThreadContext context)
long	size()
final IRubyObject	size(ThreadContext context)
private static IRubyObject	size(ThreadContext context, RubyEnumerator recv, IRubyObject[] args)	A size method suitable for lambda method reference implementation of RubyEnumerator.SizeFn.size(ThreadContext, IRubyObject, IRubyObject[])
Spliterator<Object>	spliterator()
Spliterator<Object>	spliterator(int mod)
Stream<Object>	stream()
Stream<Object>	stream(boolean parallel)
IRubyObject	with_index(ThreadContext context, Block block)
IRubyObject	with_index(ThreadContext context, IRubyObject arg, Block block)
private IRubyObject	with_index_common(ThreadContext context, Block block, String rubyMethodName, IRubyObject arg)
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, dig1, dig2, 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, defaultToJava, display, ensureInstanceVariablesSettable, eql, eql_p, 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, hasInstanceVariables, hasInternalVariable, hasVariables, 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, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method, method_missing, method_missing19, method19, methods, methods, methods19, methodsImpl, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal, op_equal_19, op_match, op_match19, op_not, op_not_equal, op_not_match, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbClone, rbInspect, recacheBuiltinMethods, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, 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, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, toJava, trust, type, type_deprecated, 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 java.util.Iterator

forEachRemaining

Field Details

GENERATOR

public static final String GENERATOR

See Also:

• Constant Field Values

LOOKAHEAD

public static final String LOOKAHEAD

See Also:

• Constant Field Values

FEEDVALUE

public static final String FEEDVALUE

See Also:

• Constant Field Values

OBJECT

public static final String OBJECT

See Also:

• Constant Field Values

METHOD

public static final String METHOD

See Also:

• Constant Field Values

ARGS

public static final String ARGS

See Also:

• Constant Field Values

object

private IRubyObject object

target for each operation

method

private 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

sizeFn

private RubyEnumerator.SizeFn sizeFn

Function object for lazily computing size (used for internally created enumerators)

feedValue

private RubyEnumerator.FeedValue feedValue

Constructor Details

RubyEnumerator

private RubyEnumerator(Ruby runtime,
 RubyClass type)

RubyEnumerator

private RubyEnumerator(Ruby runtime,
 RubyClass type,
 IRubyObject object,
 RubySymbol method,
 IRubyObject[] args,
 IRubyObject size,
 RubyEnumerator.SizeFn sizeFn)

RubyEnumerator

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

Method Details

defineEnumerator

public static RubyClass defineEnumerator(Ruby runtime,
 RubyModule Enumerable)

enumWithSize

public static <T extends IRubyObject>
RubyEnumerator enumWithSize(ThreadContext context,
 T object,
 String method,
 IRubyObject[] args,
 RubyEnumerator.SizeFn<T> sizeFn)

Transform object into an Enumerator with the given size

enumeratorizeWithSize

public static <T extends IRubyObject> IRubyObject enumeratorizeWithSize(ThreadContext context,
 T object,
 String method,
 IRubyObject[] args,
 RubyEnumerator.SizeFn<T> sizeFn)

enumeratorizeWithSize

public static <T extends IRubyObject> IRubyObject enumeratorizeWithSize(ThreadContext context,
 T object,
 String method,
 RubyEnumerator.SizeFn<T> sizeFn)

enumWithSize

public static <T extends IRubyObject>
RubyEnumerator enumWithSize(ThreadContext context,
 T object,
 String method,
 RubyEnumerator.SizeFn<T> sizeFn)

enumeratorizeWithSize

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

enumeratorize

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

enumeratorize

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

enumeratorize

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

enumeratorize

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

enumeratorize

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

enumeratorize

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

__from

public static IRubyObject __from(ThreadContext context,
 IRubyObject klass,
 IRubyObject[] args)

initialize

public IRubyObject initialize(ThreadContext context)

Overrides:

initialize in class RubyBasicObject

initialize

public IRubyObject initialize(ThreadContext context,
 Block block)

initialize

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

initialize

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

initialize

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

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)

initialize

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

initialize

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

initialize19

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

Deprecated.

initialize20

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

Deprecated.

initialize20

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

Deprecated.

initialize20

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

Deprecated.

initialize19

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

Deprecated.

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,
 Block block)

Deprecated.

initialize20

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

Deprecated.

initialize19

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

Deprecated.

initialize

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

initialize

private IRubyObject initialize(Ruby runtime,
 IRubyObject object,
 IRubyObject method,
 IRubyObject[] methodArgs,
 IRubyObject size,
 RubyEnumerator.SizeFn sizeFn)

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

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__

private IRubyObject __each__(ThreadContext context,
 Block block)

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

@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()

size

private static IRubyObject size(ThreadContext context,
 RubyEnumerator recv,
 IRubyObject[] args)

A size method suitable for lambda method reference implementation of RubyEnumerator.SizeFn.size(ThreadContext, IRubyObject, IRubyObject[])

See Also:

• RubyEnumerator.SizeFn.size(ThreadContext, IRubyObject, IRubyObject[])

with_index_common

private IRubyObject with_index_common(ThreadContext context,
 Block block,
 String rubyMethodName,
 IRubyObject arg)

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.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Object>

getGenerator

private IRubyObject getGenerator()

next

public Object next()

Specified by:

next in interface Iterator<Object>

remove

public void remove()

Specified by:

remove in interface Iterator<Object>

stream

public Stream<Object> stream()

stream

public Stream<Object> stream(boolean parallel)

spliterator

public Spliterator<Object> spliterator()

spliterator

public Spliterator<Object> spliterator(int mod)

sites

private static JavaSites.FiberSites sites(ThreadContext context)

op_plus

public IRubyObject op_plus(ThreadContext context,
 IRubyObject obj)