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
static final String	FEEDVALUE
static final String	GENERATOR
static final String	LOOKAHEAD
static final String	METHOD
static final String	OBJECT

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

Method Summary

Modifier and Type	Method	Description
static IRubyObject	__from(ThreadContext context, IRubyObject klass, IRubyObject[] args)
static RubyClass	defineEnumerator(ThreadContext context, RubyClass Object, 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_entry(ThreadContext context, Block block)
IRubyObject	each_entry(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	each_entry(ThreadContext context, IRubyObject arg0, Block block)
IRubyObject	each_slice(ThreadContext context, IRubyObject arg, Block block)
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> IRubyObject	enumeratorizeWithSize(ThreadContext context, T object, String method, IRubyObject[] args, RubyEnumerator.SizeFn<T> sizeFn, boolean keywords)
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
boolean	hasNext()
IRubyObject	initialize(ThreadContext context)
IRubyObject	initialize(ThreadContext context, Block block)
IRubyObject	initialize(ThreadContext context, IRubyObject[] args)	Deprecated.
IRubyObject	initialize(ThreadContext context, IRubyObject[] args, Block block)	Deprecated.
IRubyObject	initialize(ThreadContext context, IRubyObject size, Block block)
IRubyObject	inspect(ThreadContext context)	Returns a string containing a human-readable representation of obj.
Object	next()
static IRubyObject	produce(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)	MRI: enumerator_s_produce
void	remove()
long	size()
final IRubyObject	size(ThreadContext context)
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)
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, dig, dig1, dig2, eqlInternal, equalInternal, equals, finishObjectClass, getNativeClassIndex, hashCode, inspect, op_eqq, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

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_copy, initialize_copy, 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_equal, op_match, op_not, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, rbClone, 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, to_s, toJava, 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, dup, marshalLiveVariables

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

Method Details

defineEnumerator

public static RubyClass defineEnumerator(ThreadContext context,
 RubyClass Object,
 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,
 boolean keywords)

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

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

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

inspect

public IRubyObject inspect(ThreadContext context)

Description copied from class: RubyBasicObject

Returns a string containing a human-readable representation of obj. If not overridden, uses the to_s method to generate the string. [ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]" Time.new.inspect #=> "Wed Apr 09 08:54:39 CDT 2003"

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

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

each_entry

public IRubyObject each_entry(ThreadContext context,
 IRubyObject arg0,
 Block block)

each_entry

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

each_slice

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

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_index

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

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Object>

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)

produce

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

MRI: enumerator_s_produce

initialize

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

Deprecated.

initialize

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

Deprecated.