org.jruby

Class RubyRange

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyRange

All Implemented Interfaces:

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

public class RubyRange
extends RubyObject

Author:

jpetersen

See Also:

Serialized Form

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method and Description
IRubyObject	begin(ThreadContext context)
void	copySpecialInstanceVariables(IRubyObject clone) Lots of MRI objects keep their state in non-lookupable ivars (e:g.
RubyBoolean	cover_p(ThreadContext context, IRubyObject obj)
static RubyClass	createRangeClass(Ruby runtime)
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)
RubyBoolean	exclude_end_p()
IRubyObject	first(ThreadContext context)
IRubyObject	first(ThreadContext context, IRubyObject arg)
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.
IRubyObject	initialize_copy(ThreadContext context, IRubyObject original)
IRubyObject	initialize(ThreadContext context, IRubyObject[] args, Block unusedBlock)
IRubyObject	inspect() rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj.
RubyString	inspect(ThreadContext context)
boolean	isExcludeEnd()
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.
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.
IRubyObject	last(ThreadContext context)
IRubyObject	last(ThreadContext context, IRubyObject arg)
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)
IRubyObject	op_equal(ThreadContext context, IRubyObject other) rb_obj_equal Will by default use identity equality to compare objects.
static IRubyObject	rangeBeginLength(ThreadContext context, IRubyObject range, int len, int[] begLen, int err)
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.
IRubyObject	size(ThreadContext context)
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.
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.
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, 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, display, dup, 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, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize_copy, initialize, 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_missing, method_missing19, method, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal_19, 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, 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_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_method, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, toJava, trust, type_deprecated, 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

array

Method Detail

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

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)

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)

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

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)

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)

include_p19

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

Deprecated.

include_p

public IRubyObject include_p(ThreadContext context,
                             IRubyObject obj)

eqq_p

public IRubyObject eqq_p(ThreadContext context,
                         IRubyObject obj)

cover_p

public RubyBoolean cover_p(ThreadContext context,
                           IRubyObject obj)

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)