Package org.jruby

Class RubyRange

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyRange

All Implemented Interfaces:

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

public class RubyRange
extends RubyObject

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RubyRange.BSearch
private static class	RubyRange.InspectRecursive
private static interface	RubyRange.RangeCallBack
private static class	RubyRange.StepBlockCallBack
private static class	RubyRange.SymbolStepBlockCallBack

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
private IRubyObject	begin
private static final byte[]	DOTDOTDOT
private IRubyObject	end
private static final RubyRange.InspectRecursive	INSPECT_RECURSIVE
private boolean	isEndless
private boolean	isExclusive
private boolean	isInited
private static final ObjectMarshal	RANGE_MARSHAL

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	RubyRange(Ruby runtime, RubyClass klass)

Method Summary

Modifier and Type	Method	Description
IRubyObject	begin(ThreadContext context)
(package private) final long[]	begLen(long len, int err)
(package private) final long	begLen0(long len)
(package private) final long	begLen1(long len, long beg)
(package private) final int[]	begLenInt(int len, int err)
(package private) final boolean	checkBegin(long length)
private IRubyObject	checkStepDomain(ThreadContext context, IRubyObject step, String method)
void	copySpecialInstanceVariables(IRubyObject clone)	Lots of MRI objects keep their state in non-lookupable ivars (e:g.
RubyBoolean	cover_p(ThreadContext context, IRubyObject obj)
private boolean	coverRange(ThreadContext context, RubyRange val)
static RubyClass	createRangeClass(Ruby runtime)
private static boolean	discreteObject(ThreadContext context, IRubyObject obj)
IRubyObject	each(ThreadContext context, Block block)
IRubyObject	each19(ThreadContext context, Block block)	Deprecated.
IRubyObject	end(ThreadContext context)
IRubyObject	eql_p(ThreadContext context, IRubyObject other)
IRubyObject	eqq_p(ThreadContext context, IRubyObject obj)
private IRubyObject	equalityInner(ThreadContext context, IRubyObject other, MethodNames equalityCheck)
RubyBoolean	exclude_end_p()
IRubyObject	first(ThreadContext context)
IRubyObject	first(ThreadContext context, IRubyObject arg)
private void	fixnumEach(ThreadContext context, Block block)
private void	fixnumStep(ThreadContext context, Ruby runtime, long step, Block block)
RubyFixnum	hash()	rb_obj_id Will return the hash code of this object.
RubyFixnum	hash(ThreadContext context)
IRubyObject	include_p(ThreadContext context, IRubyObject obj)
IRubyObject	include_p19(ThreadContext context, IRubyObject obj)	Deprecated.
private IRubyObject	includeCommon(ThreadContext context, IRubyObject val, boolean useStringCover)
private void	init(ThreadContext context, IRubyObject begin, IRubyObject end, boolean isExclusive)
IRubyObject	initialize(ThreadContext context, IRubyObject[] args, Block unusedBlock)
IRubyObject	initialize_copy(ThreadContext context, IRubyObject original)
IRubyObject	inspect()	rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj.
RubyString	inspect(ThreadContext context)
private static RubyString	inspectValue(ThreadContext context, IRubyObject value)
final boolean	isExcludeEnd()
static boolean	isRangeLike(ThreadContext context, IRubyObject obj, RespondToCallSite respond_to_begin, RespondToCallSite respond_to_end)	Return true if the given object responds to "begin" and "end" methods.
static boolean	isRangeLike(ThreadContext context, IRubyObject obj, JavaSites.CheckedSites begin_checked, JavaSites.CheckedSites end_checked, JavaSites.CheckedSites exclude_end_checked)	Return true if the given object responds to "begin", "end" and "exclude_end?" methods.
private static boolean	isZero(IRubyObject num)
IRubyObject	last(ThreadContext context)
IRubyObject	last(ThreadContext context, IRubyObject arg)
private static boolean	linearObject(ThreadContext context, IRubyObject obj)
IRubyObject	max(ThreadContext context, Block block)
IRubyObject	max(ThreadContext context, IRubyObject arg, Block block)
IRubyObject	min(ThreadContext context, Block block)
IRubyObject	min(ThreadContext context, IRubyObject arg, Block block)
static RubyRange	newExclusiveRange(ThreadContext context, IRubyObject begin, IRubyObject end)
static RubyRange	newInclusiveRange(ThreadContext context, IRubyObject begin, IRubyObject end)
static RubyRange	newRange(ThreadContext context, IRubyObject begin, IRubyObject end, boolean isExclusive)
private void	numericStep(ThreadContext context, Ruby runtime, IRubyObject step, Block block)
IRubyObject	op_equal(ThreadContext context, IRubyObject other)	rb_obj_equal Will by default use identity equality to compare objects.
IRubyObject	op_mod(ThreadContext context, IRubyObject step)
static IRubyObject	rangeBeginLength(ThreadContext context, IRubyObject range, int len, int[] begLen, int err)
private static IRubyObject	rangeBeginLengthError(ThreadContext context, int beg, int end, boolean excludeEnd, int err)
private void	rangeEach(ThreadContext context, RubyRange.RangeCallBack callback)
static RubyRange	rangeFromRangeLike(ThreadContext context, IRubyObject rangeLike, CallSite beginSite, CallSite endSite, CallSite excludeEndSite)	Given a range-line object that response to "begin", "end", construct a proper range by calling those methods and "exclude_end?" with the given call sites.
private boolean	rangeIncludes(ThreadContext context, IRubyObject val)
private static IRubyObject	rangeLe(ThreadContext context, IRubyObject a, IRubyObject b)
private static int	rangeLess(ThreadContext context, IRubyObject a, IRubyObject b)
private static IRubyObject	rangeLt(ThreadContext context, IRubyObject a, IRubyObject b)
private static JavaSites.RangeSites	sites(ThreadContext context)
IRubyObject	size(ThreadContext context)
private static IRubyObject	size(ThreadContext ctx, RubyRange recv, IRubyObject[] args)	A size method suitable for lambda method reference implementation of RubyEnumerator.SizeFn.size(ThreadContext, IRubyObject, IRubyObject[])
IRubyObject	step(ThreadContext context, Block block)
IRubyObject	step(ThreadContext context, IRubyObject step, Block block)
IRubyObject	step19(ThreadContext context, Block block)	Deprecated.
IRubyObject	step19(ThreadContext context, IRubyObject step, Block block)	Deprecated.
private IRubyObject	stepCommon(ThreadContext context, IRubyObject step, Block block)
private IRubyObject	stepEnumeratorize(ThreadContext context, IRubyObject step, String method)
private static IRubyObject	stepSize(ThreadContext context, RubyRange self, IRubyObject[] args)	A step size method suitable for lambda method reference implementation of RubyEnumerator.SizeFn.size(ThreadContext, IRubyObject, IRubyObject[])
IRubyObject	to_a(ThreadContext context, Block block)
IRubyObject	to_s()	rb_any_to_s call-seq: obj.to_s => string Returns a string representing obj.
private RubyString	to_s(Ruby runtime)
IRubyObject	to_s(ThreadContext context)

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, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, defaultToJava, display, dup, 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, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, infectBy, infectBy, initialize, initialize_copy, initialize19, 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_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, 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

Field Details

begin

private IRubyObject begin

end

private IRubyObject end

isExclusive

private boolean isExclusive

isEndless

private boolean isEndless

isInited

private boolean isInited

INSPECT_RECURSIVE

private static final RubyRange.InspectRecursive INSPECT_RECURSIVE

DOTDOTDOT

private static final byte[] DOTDOTDOT

RANGE_MARSHAL

private static final ObjectMarshal RANGE_MARSHAL

Constructor Details

RubyRange

private RubyRange(Ruby runtime,
 RubyClass klass)

Method Details

createRangeClass

public static RubyClass createRangeClass(Ruby runtime)

newRange

public static RubyRange newRange(ThreadContext context,
 IRubyObject begin,
 IRubyObject end,
 boolean isExclusive)

newInclusiveRange

public static RubyRange newInclusiveRange(ThreadContext context,
 IRubyObject begin,
 IRubyObject end)

newExclusiveRange

public static RubyRange newExclusiveRange(ThreadContext context,
 IRubyObject begin,
 IRubyObject end)

copySpecialInstanceVariables

public void copySpecialInstanceVariables(IRubyObject clone)

Description copied from class: RubyBasicObject

Lots of MRI objects keep their state in non-lookupable ivars (e:g. Range, Struct, etc). This method is responsible for dupping our java field equivalents

Specified by:

copySpecialInstanceVariables in interface IRubyObject

Overrides:

copySpecialInstanceVariables in class RubyBasicObject

checkBegin

final boolean checkBegin(long length)

begLen

final long[] begLen(long len,
 int err)

begLen0

final long begLen0(long len)

begLen1

final long begLen1(long len,
 long beg)

begLenInt

final int[] begLenInt(int len,
 int err)

init

private void init(ThreadContext context,
 IRubyObject begin,
 IRubyObject end,
 boolean isExclusive)

initialize

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

initialize_copy

public IRubyObject initialize_copy(ThreadContext context,
 IRubyObject original)

hash

public RubyFixnum hash()

Description copied from class: RubyBasicObject

rb_obj_id Will return the hash code of this object. In comparison to MRI, this method will use the Java identity hash code instead of using rb_obj_id, since the usage of id in JRuby will incur the cost of some. ObjectSpace maintenance.

Overrides:

hash in class RubyBasicObject

hash

public RubyFixnum hash(ThreadContext context)

inspectValue

private static RubyString inspectValue(ThreadContext context,
 IRubyObject value)

inspect

public IRubyObject inspect()

Description copied from class: RubyBasicObject

rb_obj_inspect call-seq: obj.inspect => string 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

Returns:

String

inspect

public RubyString inspect(ThreadContext context)

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

to_s

public IRubyObject to_s(ThreadContext context)

to_s

private RubyString to_s(Ruby runtime)

exclude_end_p

public RubyBoolean exclude_end_p()

eql_p

public IRubyObject eql_p(ThreadContext context,
 IRubyObject other)

op_equal

public IRubyObject op_equal(ThreadContext context,
 IRubyObject other)

Description copied from class: RubyBasicObject

rb_obj_equal Will by default use identity equality to compare objects. This follows the Ruby semantics. The name of this method doesn't follow the convention because hierarchy problems

Specified by:

op_equal in interface IRubyObject

Overrides:

op_equal in class RubyBasicObject

equalityInner

private IRubyObject equalityInner(ThreadContext context,
 IRubyObject other,
 MethodNames equalityCheck)

isZero

private static boolean isZero(IRubyObject num)

rangeLt

private static IRubyObject rangeLt(ThreadContext context,
 IRubyObject a,
 IRubyObject b)

rangeLess

private static int rangeLess(ThreadContext context,
 IRubyObject a,
 IRubyObject b)

rangeLe

private static IRubyObject rangeLe(ThreadContext context,
 IRubyObject a,
 IRubyObject b)

rangeEach

private void rangeEach(ThreadContext context,
 RubyRange.RangeCallBack callback)

coverRange

private boolean coverRange(ThreadContext context,
 RubyRange val)

to_a

public IRubyObject to_a(ThreadContext context,
 Block block)

each19

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

Deprecated.

each

public IRubyObject each(ThreadContext context,
 Block block)

fixnumEach

private void fixnumEach(ThreadContext context,
 Block block)

step19

@Deprecated
public IRubyObject step19(ThreadContext context,
 IRubyObject step,
 Block block)

Deprecated.

step19

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

Deprecated.

step

public IRubyObject step(ThreadContext context,
 Block block)

step

public IRubyObject step(ThreadContext context,
 IRubyObject step,
 Block block)

checkStepDomain

private IRubyObject checkStepDomain(ThreadContext context,
 IRubyObject step,
 String method)

stepEnumeratorize

private IRubyObject stepEnumeratorize(ThreadContext context,
 IRubyObject step,
 String method)

op_mod

public IRubyObject op_mod(ThreadContext context,
 IRubyObject step)

stepCommon

private IRubyObject stepCommon(ThreadContext context,
 IRubyObject step,
 Block block)

fixnumStep

private void fixnumStep(ThreadContext context,
 Ruby runtime,
 long step,
 Block block)

numericStep

private void numericStep(ThreadContext context,
 Ruby runtime,
 IRubyObject step,
 Block block)

size

private static IRubyObject size(ThreadContext ctx,
 RubyRange 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[])

stepSize

private static IRubyObject stepSize(ThreadContext context,
 RubyRange self,
 IRubyObject[] args)

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

See Also:

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

include_p19

@Deprecated
public IRubyObject include_p19(ThreadContext context,
 IRubyObject obj)

Deprecated.

include_p

public IRubyObject include_p(ThreadContext context,
 IRubyObject obj)

includeCommon

private IRubyObject includeCommon(ThreadContext context,
 IRubyObject val,
 boolean useStringCover)

discreteObject

private static boolean discreteObject(ThreadContext context,
 IRubyObject obj)

linearObject

private static boolean linearObject(ThreadContext context,
 IRubyObject obj)

eqq_p

public IRubyObject eqq_p(ThreadContext context,
 IRubyObject obj)

cover_p

public RubyBoolean cover_p(ThreadContext context,
 IRubyObject obj)

rangeIncludes

private boolean rangeIncludes(ThreadContext context,
 IRubyObject val)

min

public IRubyObject min(ThreadContext context,
 Block block)

max

public IRubyObject max(ThreadContext context,
 Block block)

min

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

max

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

first

public IRubyObject first(ThreadContext context)

begin

public IRubyObject begin(ThreadContext context)

first

public IRubyObject first(ThreadContext context,
 IRubyObject arg)

last

public IRubyObject last(ThreadContext context)

end

public IRubyObject end(ThreadContext context)

last

public IRubyObject last(ThreadContext context,
 IRubyObject arg)

size

public IRubyObject size(ThreadContext context)

isExcludeEnd

public final boolean isExcludeEnd()

rangeFromRangeLike

public static RubyRange rangeFromRangeLike(ThreadContext context,
 IRubyObject rangeLike,
 CallSite beginSite,
 CallSite endSite,
 CallSite excludeEndSite)

Given a range-line object that response to "begin", "end", construct a proper range by calling those methods and "exclude_end?" with the given call sites.

Parameters:

context - current context

rangeLike - range-like object

beginSite - "begin" call site

endSite - "end" call site

excludeEndSite - "exclude_end?" call site

Returns:

a proper Range based on the results of calling those methods

isRangeLike

public static boolean isRangeLike(ThreadContext context,
 IRubyObject obj,
 RespondToCallSite respond_to_begin,
 RespondToCallSite respond_to_end)

Return true if the given object responds to "begin" and "end" methods.

Parameters:

context - current context

obj - possibly range-like object

respond_to_begin - respond_to? site for begin

respond_to_end - respond_to? site for end

Returns:

isRangeLike

public static boolean isRangeLike(ThreadContext context,
 IRubyObject obj,
 JavaSites.CheckedSites begin_checked,
 JavaSites.CheckedSites end_checked,
 JavaSites.CheckedSites exclude_end_checked)

Return true if the given object responds to "begin", "end" and "exclude_end?" methods.

Parameters:

context - current context

obj - possibly range-like object

begin_checked - checked site for begin

end_checked - checked site for end

exclude_end_checked - checked site for exclude_end?

Returns:

rangeBeginLength

public static IRubyObject rangeBeginLength(ThreadContext context,
 IRubyObject range,
 int len,
 int[] begLen,
 int err)

rangeBeginLengthError

private static IRubyObject rangeBeginLengthError(ThreadContext context,
 int beg,
 int end,
 boolean excludeEnd,
 int err)

sites

private static JavaSites.RangeSites sites(ThreadContext context)