Module org.jruby.base

Package org.jruby

Class RubyArray<T extends IRubyObject>

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyArray<T>

Type Parameters:

T - What array holds

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, Iterable, Collection, List, RandomAccess, SequencedCollection, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

Direct Known Subclasses:

RubyArrayNative

public abstract class RubyArray<T extends IRubyObject>
extends RubyObject
implements List, RandomAccess

The implementation of the built-in class Array in Ruby. Concurrency: no synchronization is required among readers, but all users must synchronize externally with writers. Note: elt(long) is based on notion if we exceed precision by passing in a long larger than int (actually Integer.MAX - 8) then it will just return nil. Anything using eltOk must know this already to avoid an AIOOBE. We do catch that in eltOk but only as an attempt at detecting concurrent modifications to the length. So if you improperly use eltOk you will get a conc error and not AIOOBE. Guidance for elt(long) is that if the Ruby method should raise if it is too large then you need to do that before you call this (toLong vs getValue/asLong).

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RubyArray.ArgumentVisitor
static class	RubyArray.DefaultComparator

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 int	DEFAULT_INSPECT_STR_SIZE

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, ERR_INSECURE_SET_INST_VAR, FALSE_F, flags, FROZEN_F, metaClass, NEVER, NIL_F, STAMP_OFFSET, TAINTED_F, UNDEF, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RubyArray(RubyClass klass)
protected	RubyArray(Ruby runtime, RubyClass klass)
protected	RubyArray(Ruby runtime, RubyClass klass, boolean objectSpace)

Method Summary

Modifier and Type	Method	Description
abstract IRubyObject	all_p(ThreadContext context, Block block)
abstract IRubyObject	all_p(ThreadContext context, IRubyObject arg, Block block)
abstract IRubyObject	any_p(ThreadContext context, Block block)
abstract IRubyObject	any_p(ThreadContext context, IRubyObject arg, Block block)
RubyArray<?>	append(IRubyObject item)	Deprecated.
abstract RubyArray	append(ThreadContext context, IRubyObject item)
IRubyObject	aref(IRubyObject[] args)	Deprecated. Use the versions with zero, one, or two args.
IRubyObject	aref(IRubyObject arg0, IRubyObject arg1)	Deprecated.
abstract IRubyObject	aref(ThreadContext context, IRubyObject arg0)
abstract IRubyObject	aref(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
RubyArray	aryAppend(RubyArray y)	Deprecated.
abstract RubyArray	aryAppend(ThreadContext context, RubyArray<?> y)
abstract RubyArray	aryDup()
static RubyArray	aryToAry(ThreadContext context, IRubyObject obj)
IRubyObject	aset(IRubyObject[] args)	Deprecated. Use the versions with zero, one, or two args.
IRubyObject	aset(IRubyObject arg0, IRubyObject arg1)	Deprecated.
IRubyObject	aset(IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)	Deprecated. Use aset(ThreadContext, IRubyObject, IRubyObject, IRubyObject) instead.
abstract IRubyObject	aset(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
abstract IRubyObject	aset(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
abstract IRubyObject	assoc(ThreadContext context, IRubyObject key)
IRubyObject	at(IRubyObject pos)	Deprecated. Use at(ThreadContext, IRubyObject) instead.
abstract IRubyObject	at(ThreadContext context, IRubyObject pos)
abstract IRubyObject	bsearch(ThreadContext context, Block block)
abstract IRubyObject	bsearch_index(ThreadContext context, Block block)
final IRubyObject	checkArrayType()	rb_check_array_type Returns the result of trying to convert this object to an Array with "to_ary".
protected static final void	checkLength(Ruby runtime, long length)	Deprecated.
static final int	checkLength(ThreadContext context, long length)
abstract IRubyObject	collect_bang(ThreadContext context, Block block)
abstract IRubyObject	combination(ThreadContext context, IRubyObject num, Block block)
IRubyObject	compact()	Deprecated.
abstract IRubyObject	compact(ThreadContext context)
IRubyObject	compact_bang()	Deprecated. Use compact_bang(ThreadContext)
abstract IRubyObject	compact_bang(ThreadContext context)
abstract RubyBoolean	compare(ThreadContext context, CallSite site, IRubyObject other)
abstract RubyArray	concat(IRubyObject obj)
abstract RubyArray	concat(ThreadContext context, IRubyObject obj)
abstract RubyArray	concat(ThreadContext context, IRubyObject[] objs)
final RubyArray	convertToArray()	Tries to convert this object to a Ruby Array using the "to_ary" method.
void	copyInto(IRubyObject[] target, int start)	Deprecated.
void	copyInto(IRubyObject[] target, int start, int len)	Deprecated.
abstract void	copyInto(ThreadContext context, IRubyObject[] target, int start)	Copy the values contained in this array into the target array at the specified offset.
abstract void	copyInto(ThreadContext context, IRubyObject[] target, int start, int len)	Copy the specified number of values contained in this array into the target array at the specified offset.
abstract IRubyObject	count(ThreadContext context, Block block)
abstract IRubyObject	count(ThreadContext context, IRubyObject obj, Block block)
static IRubyObject	create(IRubyObject klass, IRubyObject[] args, Block block)	Deprecated.
static IRubyObject	create(ThreadContext context, IRubyObject klass, IRubyObject[] args, Block block)
static RubyClass	createArrayClass(ThreadContext context, RubyClass Object, RubyModule Enumerable)
abstract IRubyObject	cycle(ThreadContext context, Block block)
abstract IRubyObject	cycle(ThreadContext context, IRubyObject arg, Block block)
final IRubyObject	deconstruct(ThreadContext context)
abstract IRubyObject	delete(ThreadContext context, IRubyObject item, Block block)
IRubyObject	delete_at(int pos)	Deprecated.
IRubyObject	delete_at(IRubyObject obj)	Deprecated.
abstract IRubyObject	delete_at(ThreadContext context, int pos)
abstract IRubyObject	delete_at(ThreadContext context, IRubyObject obj)
abstract IRubyObject	delete_if(ThreadContext context, Block block)
abstract IRubyObject	difference(ThreadContext context, IRubyObject[] args)
abstract IRubyObject	dig(ThreadContext context, IRubyObject arg0)
abstract IRubyObject	dig(ThreadContext context, IRubyObject[] args)
abstract IRubyObject	dig(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
abstract IRubyObject	dig(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
abstract IRubyObject	drop(ThreadContext context, IRubyObject n)
abstract IRubyObject	drop_while(ThreadContext context, Block block)
abstract IRubyObject	each(ThreadContext context, Block block)
abstract IRubyObject	each_index(ThreadContext context, Block block)
abstract IRubyObject	each_slice(ThreadContext context, IRubyObject arg, Block block)
abstract IRubyObject	eachSlice(ThreadContext context, int size, Block block)
protected abstract IRubyObject	elt(long offset)
abstract T	eltInternal(int offset)
abstract T	eltInternalSet(int offset, T item)
abstract T	eltOk(long offset)
abstract T	eltSetOk(int offset, T value)
abstract T	eltSetOk(long offset, T value)
IRubyObject	empty_p()	Deprecated.
abstract IRubyObject	empty_p(ThreadContext context)
abstract IRubyObject	entry(int offset)
abstract IRubyObject	entry(long offset)
abstract IRubyObject	eql(ThreadContext context, IRubyObject obj)
abstract boolean	equals(Object other)	This override does not do a "checked" dispatch.
IRubyObject	fetch(ThreadContext context, IRubyObject[] args, Block block)	Deprecated. Use the versions with zero, one, or two args.
abstract IRubyObject	fetch(ThreadContext context, IRubyObject arg0, Block block)
abstract IRubyObject	fetch(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
abstract IRubyObject	fetch_values(ThreadContext context, IRubyObject[] args, Block block)
abstract IRubyObject	fill(ThreadContext context, Block block)
abstract IRubyObject	fill(ThreadContext context, IRubyObject arg, Block block)
abstract IRubyObject	fill(ThreadContext context, IRubyObject arg1, IRubyObject arg2, Block block)
abstract IRubyObject	fill(ThreadContext context, IRubyObject arg1, IRubyObject arg2, IRubyObject arg3, Block block)
abstract IRubyObject	find(ThreadContext context, IRubyObject ifnone, Block block)
abstract IRubyObject	find_index(ThreadContext context, Block block)
abstract IRubyObject	find_index(ThreadContext context, IRubyObject cond)
IRubyObject	first()	Deprecated.
IRubyObject	first(IRubyObject arg0)	Deprecated.
IRubyObject	first(IRubyObject[] args)	Deprecated.
abstract IRubyObject	first(ThreadContext context)
abstract IRubyObject	first(ThreadContext context, IRubyObject arg0)
abstract IRubyObject	flatten(ThreadContext context)
abstract IRubyObject	flatten(ThreadContext context, IRubyObject arg)
abstract IRubyObject	flatten_bang(ThreadContext context)
abstract IRubyObject	flatten_bang(ThreadContext context, IRubyObject arg)
Class	getJavaClass()	Will return the Java interface that most closely can represent this object, when working through Java integration translations.
abstract int	getLength()
final List<IRubyObject>	getList()	Deprecated. RubyArray implements List, use it directly
ClassIndex	getNativeClassIndex()	This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
abstract RubyFixnum	hash(ThreadContext context)	Will return the hash code of this object.
abstract RubyBoolean	include_p(ThreadContext context, IRubyObject item)
abstract boolean	includes(ThreadContext context, IRubyObject item)
protected abstract boolean	includesByEql(ThreadContext context, IRubyObject item)
abstract IRubyObject	index(ThreadContext context, Block block)
abstract IRubyObject	index(ThreadContext context, IRubyObject obj)
abstract IRubyObject	index(ThreadContext context, IRubyObject obj, Block unused)
IRubyObject	indexes(IRubyObject[] args)	Deprecated.
IRubyObject	indexes(ThreadContext context, IRubyObject[] args)	Deprecated.
abstract IRubyObject	initialize(ThreadContext context, Block block)
abstract IRubyObject	initialize(ThreadContext context, IRubyObject arg0, Block block)
abstract IRubyObject	initialize(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
abstract IRubyObject	initialize_copy(ThreadContext context, IRubyObject orig)	Initializes this object as a copy of the original, that is the parameter to this object.
IRubyObject	insert(IRubyObject arg)	Deprecated.
IRubyObject	insert(IRubyObject[] args)	Deprecated.
IRubyObject	insert(IRubyObject arg1, IRubyObject arg2)	Deprecated.
abstract IRubyObject	insert(ThreadContext context, IRubyObject arg)
abstract IRubyObject	insert(ThreadContext context, IRubyObject[] args)
abstract IRubyObject	insert(ThreadContext context, IRubyObject arg1, IRubyObject arg2)
abstract RubyString	inspect(ThreadContext context)	Returns a string containing a human-readable representation of obj.
abstract IRubyObject	intersect_p(ThreadContext context, IRubyObject other)
abstract IRubyObject	intersection(ThreadContext context, IRubyObject[] args)
abstract boolean	isSharedJavaArray(RubyArray other)
abstract IRubyObject	join(ThreadContext context)
abstract IRubyObject	join(ThreadContext context, IRubyObject sep)
IRubyObject	join19(ThreadContext context)	Deprecated.
IRubyObject	join19(ThreadContext context, IRubyObject sep)	Deprecated.
abstract IRubyObject	keep_if(ThreadContext context, Block block)
IRubyObject	last()	Deprecated.
IRubyObject	last(IRubyObject arg0)	Deprecated.
IRubyObject	last(IRubyObject[] args)	Deprecated. Use the versions with zero, one, or two args.
abstract IRubyObject	last(ThreadContext context)
abstract IRubyObject	last(ThreadContext context, IRubyObject arg0)
RubyFixnum	length()	Deprecated.
abstract RubyFixnum	length(ThreadContext context)
protected abstract RubyHash	makeHash(Ruby runtime)
protected abstract RubyHash	makeHash(RubyHash hash)
abstract IRubyObject	map(ThreadContext context, Block block)
abstract IRubyObject	map_bang(ThreadContext context, Block block)
static void	marshalTo(RubyArray array, MarshalStream output)	Deprecated, for removal: This API element is subject to removal in a future version.
static void	marshalTo(ThreadContext context, RubyArray array, MarshalStream output)	Deprecated, for removal: This API element is subject to removal in a future version.
static void	marshalTo(ThreadContext context, RubyOutputStream out, RubyArray array, MarshalDumper output)
abstract IRubyObject	max(ThreadContext context, Block block)
abstract IRubyObject	max(ThreadContext context, IRubyObject num, Block block)
abstract IRubyObject	min(ThreadContext context, Block block)
abstract IRubyObject	min(ThreadContext context, IRubyObject num, Block block)
abstract IRubyObject	minmax(ThreadContext context, Block block)
static final RubyArray<?>	newArray(Ruby runtime)	Deprecated.
static RubyArray<?>	newArray(Ruby runtime, int len)
static RubyArray<?>	newArray(Ruby runtime, Collection<? extends IRubyObject> collection)
static RubyArray<?>	newArray(Ruby runtime, List<? extends IRubyObject> list)
static RubyArray<?>	newArray(Ruby runtime, IRubyObject obj)
static RubyArray<?>	newArray(Ruby runtime, IRubyObject[] args)
static RubyArray<?>	newArray(Ruby runtime, IRubyObject car, IRubyObject cdr)
static RubyArray<?>	newArray(Ruby runtime, IRubyObject first, IRubyObject second, IRubyObject third)
static RubyArray<?>	newArray(Ruby runtime, IRubyObject first, IRubyObject second, IRubyObject third, IRubyObject fourth)
static RubyArray<?>	newArray(ThreadContext context)
static RubyArray<?>	newArray(ThreadContext context, int len)
static RubyArray<?>	newArrayLight(Ruby runtime)
static RubyArray<?>	newArrayLight(RubyClass arrayClass, IRubyObject obj)
static RubyArray<?>	newArrayLight(RubyClass arrayClass, IRubyObject car, IRubyObject cdr)
static RubyArray<?>	newArrayLight(Ruby runtime, int len)
static RubyArray<?>	newArrayLight(Ruby runtime, IRubyObject obj)
static RubyArray<?>	newArrayLight(Ruby runtime, IRubyObject... objs)
static RubyArray<?>	newArrayLight(Ruby runtime, IRubyObject car, IRubyObject cdr)
static RubyArray	newArrayMayCopy(Ruby runtime, IRubyObject... args)
static RubyArray	newArrayMayCopy(Ruby runtime, IRubyObject[] args, int start)
static RubyArray	newArrayMayCopy(Ruby runtime, IRubyObject[] args, int start, int length)	Construct a new RubyArray given the specified range of elements in the source array.
static RubyArray	newArrayNoCopy(Ruby runtime, IRubyObject... args)
static RubyArray	newArrayNoCopy(Ruby runtime, IRubyObject[] args, int begin)
static RubyArray	newArrayNoCopy(Ruby runtime, IRubyObject[] args, int begin, int length)
static RubyArray	newArrayNoCopyLight(Ruby runtime, IRubyObject[] args)
static RubyArray	newBlankArray(Ruby runtime, int size)	Deprecated.
static RubyArray	newBlankArray(ThreadContext context, int size)	Construct the most efficient array shape for the given size.
static RubyArray<?>	newEmptyArray(Ruby runtime)
static RubyArray<?>	newEmptyArray(Ruby runtime, RubyClass klass)
static RubyArray<?>	newSharedArray(RubyClass arrayClass, IRubyObject[] shared)
IRubyObject	nitems()	Deprecated.
abstract IRubyObject	nitems(ThreadContext context)
abstract IRubyObject	none_p(ThreadContext context, Block block)
abstract IRubyObject	none_p(ThreadContext context, IRubyObject arg, Block block)
abstract IRubyObject	one_p(ThreadContext context, Block block)
abstract IRubyObject	one_p(ThreadContext context, IRubyObject arg, Block block)
IRubyObject	op_and(IRubyObject other)	Deprecated.
abstract IRubyObject	op_and(ThreadContext context, IRubyObject other)
abstract IRubyObject	op_cmp(ThreadContext context, IRubyObject obj)
IRubyObject	op_diff(IRubyObject other)	Deprecated.
abstract IRubyObject	op_diff(ThreadContext context, IRubyObject other)
abstract IRubyObject	op_equal(ThreadContext context, IRubyObject obj)	rb_obj_equal Will by default use identity equality to compare objects.
IRubyObject	op_or(IRubyObject other)	Deprecated.
abstract IRubyObject	op_or(ThreadContext context, IRubyObject other)
IRubyObject	op_plus(IRubyObject obj)	Deprecated.
abstract IRubyObject	op_plus(ThreadContext context, IRubyObject obj)
abstract IRubyObject	op_times(ThreadContext context, IRubyObject times)
abstract RubyString	pack(ThreadContext context, IRubyObject obj)
abstract RubyString	pack(ThreadContext context, IRubyObject obj, IRubyObject maybeOpts)
abstract IRubyObject	permutation(ThreadContext context, Block block)
abstract IRubyObject	permutation(ThreadContext context, IRubyObject num, Block block)
abstract IRubyObject	pop(ThreadContext context)
abstract IRubyObject	pop(ThreadContext context, IRubyObject num)
abstract IRubyObject	product(ThreadContext context, IRubyObject[] args, Block block)
RubyArray	push(IRubyObject item)	Deprecated.
RubyArray<?>	push(IRubyObject[] items)	Deprecated.
abstract RubyArray	push(ThreadContext context, IRubyObject item)
abstract RubyArray	push(ThreadContext context, IRubyObject[] items)
RubyArray<?>	push_m(IRubyObject[] items)	Deprecated.
abstract IRubyObject	rassoc(ThreadContext context, IRubyObject value)
IRubyObject	rb_clear()	Deprecated.
abstract IRubyObject	rb_clear(ThreadContext context)
abstract IRubyObject	rbCollect(ThreadContext context, Block block)
abstract IRubyObject	reject(ThreadContext context, Block block)
abstract IRubyObject	reject_bang(ThreadContext context, Block block)
abstract IRubyObject	repeated_permutation(ThreadContext context, IRubyObject num, Block block)
abstract IRubyObject	repeatedCombination(ThreadContext context, IRubyObject num, Block block)
IRubyObject	replace(IRubyObject orig)	Deprecated.
abstract IRubyObject	replace(ThreadContext context, IRubyObject orig)
IRubyObject	reverse()	Deprecated.
abstract IRubyObject	reverse(ThreadContext context)
IRubyObject	reverse_bang()	Deprecated.
abstract IRubyObject	reverse_bang(ThreadContext context)
abstract IRubyObject	reverse_each(ThreadContext context, Block block)
abstract IRubyObject	rfind(ThreadContext context, Block block)
abstract IRubyObject	rfind(ThreadContext context, IRubyObject ifnone, Block block)
abstract IRubyObject	rindex(ThreadContext context, Block block)
abstract IRubyObject	rindex(ThreadContext context, IRubyObject obj, Block unused)
abstract IRubyObject	rotate(ThreadContext context)
abstract IRubyObject	rotate(ThreadContext context, IRubyObject cnt)
abstract IRubyObject	rotate_bang(ThreadContext context)
abstract IRubyObject	rotate_bang(ThreadContext context, IRubyObject cnt)
abstract Stream<IRubyObject>	rubyStream()	Returns a stream of each IRubyObject
abstract IRubyObject	sample(ThreadContext context)
abstract IRubyObject	sample(ThreadContext context, IRubyObject sampleOrOpts)
abstract IRubyObject	sample(ThreadContext context, IRubyObject sample, IRubyObject opts)
abstract IRubyObject	select(ThreadContext context, Block block)
abstract IRubyObject	select_bang(ThreadContext context, Block block)
abstract IRubyObject	shift(ThreadContext context)
abstract IRubyObject	shift(ThreadContext context, IRubyObject num)
abstract IRubyObject	shuffle(ThreadContext context)
abstract IRubyObject	shuffle(ThreadContext context, IRubyObject opts)
abstract IRubyObject	shuffle_bang(ThreadContext context)
abstract IRubyObject	shuffle_bang(ThreadContext context, IRubyObject opts)
protected static IRubyObject	size(ThreadContext context, RubyArray self, IRubyObject[] args)	A size method suitable for lambda method reference implementation of RubyEnumerator.SizeFn.size(ThreadContext, IRubyObject, IRubyObject[])
IRubyObject	slice_bang(IRubyObject arg0)	Deprecated.
IRubyObject	slice_bang(IRubyObject[] args)	Deprecated. Use the versions with zero, one, or two args.
IRubyObject	slice_bang(IRubyObject arg0, IRubyObject arg1)	Deprecated.
abstract IRubyObject	slice_bang(ThreadContext context, IRubyObject arg0)
abstract IRubyObject	slice_bang(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
abstract RubyArray	sort(ThreadContext context, Block block)
abstract IRubyObject	sort_bang(ThreadContext context, Block block)
abstract IRubyObject	sort_by_bang(ThreadContext context, Block block)
abstract IRubyObject	store(long index, IRubyObject value)
abstract IRubyObject	store(ThreadContext context, long index, IRubyObject value)	Store an element at the specified index or throw if the index is invalid.
protected abstract void	storeInternal(ThreadContext context, int index, IRubyObject value)
abstract IRubyObject	subseq(RubyClass metaClass, long beg, long len, boolean light)
abstract IRubyObject	subseqLight(long beg, long len)
abstract IRubyObject	sum(ThreadContext context, Block block)
abstract IRubyObject	sum(ThreadContext context, IRubyObject init, Block block)
abstract IRubyObject	take(ThreadContext context, IRubyObject n)
abstract IRubyObject	take_while(ThreadContext context, Block block)
abstract RubyArray	to_a(ThreadContext context)
IRubyObject	to_ary()	Deprecated.
final IRubyObject	to_ary(ThreadContext context)
abstract IRubyObject	to_h(ThreadContext context, Block block)
abstract RubyString	to_s(ThreadContext context)
IRubyObject[]	toJavaArray()	Deprecated. Use toJavaArray(ThreadContext) instead.
abstract IRubyObject[]	toJavaArray(ThreadContext context)	Return a Java array copy of the elements contained in this Array.
abstract IRubyObject[]	toJavaArrayMaybeUnsafe()	Return a Java array of the elements contained in this array, possibly a new array object.
abstract IRubyObject[]	toJavaArrayUnsafe()	Return a reference to this RubyArray's underlying Java array, if it is not shared with another RubyArray, or an exact copy of the relevant range otherwise.
RubyArray	transpose()	Deprecated.
abstract RubyArray	transpose(ThreadContext context)
static IRubyObject	try_convert(ThreadContext context, IRubyObject self, IRubyObject arg)
abstract IRubyObject	union(ThreadContext context, IRubyObject[] args)
protected abstract void	unionInternal(ThreadContext context, RubyArray... args)
abstract IRubyObject	uniq(ThreadContext context, Block block)
abstract IRubyObject	uniq_bang(ThreadContext context, Block block)
static RubyArray	unmarshalFrom(UnmarshalStream input)	Deprecated, for removal: This API element is subject to removal in a future version.
static RubyArray	unmarshalFrom(ThreadContext context, RubyInputStream in, MarshalLoader input)
IRubyObject	unshift()	Deprecated.
IRubyObject	unshift(IRubyObject item)	Deprecated.
IRubyObject	unshift(IRubyObject[] items)	Deprecated.
abstract IRubyObject	unshift(ThreadContext context)
abstract IRubyObject	unshift(ThreadContext context, IRubyObject item)
abstract IRubyObject	unshift(ThreadContext context, IRubyObject[] items)
IRubyObject	values_at(IRubyObject[] args)	Deprecated.
abstract IRubyObject	values_at(ThreadContext context, IRubyObject[] args)
abstract IRubyObject	zip(ThreadContext context, IRubyObject[] args, Block block)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, dig, dig1, dig2, eqlInternal, equalInternal, finishObjectClass, hashCode, inspect, op_eqq, puts, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

__id__, addFinalizer, addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, compareTo, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataWrapStruct, decode, display, dup, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql, eql_p, eql_p, equal_p, evalUnder, extend, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, freeze, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getMarshalVariableList, getMetaClass, getMetaClass, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableList, getVariableNameList, hash, hashyInspect, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, 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, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, nil_p, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, 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, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setTaint, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, singletonClass, specificEval, specificEval, specificEval, specificEval, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_s, toJava, type, untaint, validateInstanceVariable, variableTableContains, 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.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface org.jruby.runtime.builtin.IRubyObject

checkStringType19, dup, marshalLiveVariables

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, addFirst, addLast, clear, contains, containsAll, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, set, size, sort, spliterator, subList, toArray, toArray

Field Details

DEFAULT_INSPECT_STR_SIZE

public static final int DEFAULT_INSPECT_STR_SIZE

See Also:

• Constant Field Values

Constructor Details

RubyArray

protected RubyArray(Ruby runtime,
 RubyClass klass)

RubyArray

protected RubyArray(RubyClass klass)

RubyArray

protected RubyArray(Ruby runtime,
 RubyClass klass,
 boolean objectSpace)

Method Details

createArrayClass

public static RubyClass createArrayClass(ThreadContext context,
 RubyClass Object,
 RubyModule Enumerable)

getNativeClassIndex

public ClassIndex getNativeClassIndex()

Description copied from class: RubyObject

This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are. Will generally return a value from org.jruby.runtime.ClassIndex

Specified by:

getNativeClassIndex in interface CoreObjectType

Overrides:

getNativeClassIndex in class RubyObject

Returns:

the ClassIndex of the native type this object was constructed from

See Also:

• ClassIndex

create

@Deprecated(since="10.0.0.0")
public static IRubyObject create(IRubyObject klass,
 IRubyObject[] args,
 Block block)

Deprecated.

create

public static IRubyObject create(ThreadContext context,
 IRubyObject klass,
 IRubyObject[] args,
 Block block)

newArray

public static RubyArray<?> newArray(Ruby runtime,
 int len)

newArray

public static RubyArray<?> newArray(ThreadContext context,
 int len)

newArrayLight

public static RubyArray<?> newArrayLight(Ruby runtime,
 int len)

newArray

@Deprecated(since="10.0.0.0")
public static final RubyArray<?> newArray(Ruby runtime)

Deprecated.

newArray

public static RubyArray<?> newArray(ThreadContext context)

newArrayLight

public static RubyArray<?> newArrayLight(Ruby runtime)

newArray

public static RubyArray<?> newArray(Ruby runtime,
 IRubyObject obj)

newArrayLight

public static RubyArray<?> newArrayLight(Ruby runtime,
 IRubyObject obj)

newArrayLight

public static RubyArray<?> newArrayLight(RubyClass arrayClass,
 IRubyObject obj)

newArrayLight

public static RubyArray<?> newArrayLight(Ruby runtime,
 IRubyObject car,
 IRubyObject cdr)

newArrayLight

public static RubyArray<?> newArrayLight(RubyClass arrayClass,
 IRubyObject car,
 IRubyObject cdr)

newArrayLight

public static RubyArray<?> newArrayLight(Ruby runtime,
 IRubyObject... objs)

newArray

public static RubyArray<?> newArray(Ruby runtime,
 IRubyObject car,
 IRubyObject cdr)

newArray

public static RubyArray<?> newArray(Ruby runtime,
 IRubyObject first,
 IRubyObject second,
 IRubyObject third)

newArray

public static RubyArray<?> newArray(Ruby runtime,
 IRubyObject first,
 IRubyObject second,
 IRubyObject third,
 IRubyObject fourth)

newEmptyArray

public static RubyArray<?> newEmptyArray(Ruby runtime)

newEmptyArray

public static RubyArray<?> newEmptyArray(Ruby runtime,
 RubyClass klass)

newArray

public static RubyArray<?> newArray(Ruby runtime,
 IRubyObject[] args)

newArray

public static RubyArray<?> newArray(Ruby runtime,
 Collection<? extends IRubyObject> collection)

newArray

public static RubyArray<?> newArray(Ruby runtime,
 List<? extends IRubyObject> list)

newSharedArray

public static RubyArray<?> newSharedArray(RubyClass arrayClass,
 IRubyObject[] shared)

newArrayMayCopy

public static RubyArray newArrayMayCopy(Ruby runtime,
 IRubyObject... args)

newArrayMayCopy

public static RubyArray newArrayMayCopy(Ruby runtime,
 IRubyObject[] args,
 int start)

newArrayMayCopy

public static RubyArray newArrayMayCopy(Ruby runtime,
 IRubyObject[] args,
 int start,
 int length)

Construct a new RubyArray given the specified range of elements in the source array. The elements may be copied into a new backing store, and therefore you should not expect future changes to the source array to be reflected. Conversely, you should not modify the array after passing it, since the contents may not be copied.

Parameters:

runtime - the runtime

args - the args

start - start index

length - number of elements

Returns:

an array referencing the given elements

newArrayNoCopy

public static RubyArray newArrayNoCopy(Ruby runtime,
 IRubyObject... args)

newArrayNoCopy

public static RubyArray newArrayNoCopy(Ruby runtime,
 IRubyObject[] args,
 int begin)

newArrayNoCopy

public static RubyArray newArrayNoCopy(Ruby runtime,
 IRubyObject[] args,
 int begin,
 int length)

newArrayNoCopyLight

public static RubyArray newArrayNoCopyLight(Ruby runtime,
 IRubyObject[] args)

checkLength

@Deprecated(since="10.0.0.0")
protected static final void checkLength(Ruby runtime,
 long length)

Deprecated.

checkLength

public static final int checkLength(ThreadContext context,
 long length)

getList

@Deprecated(since="9.4-")
public final List<IRubyObject> getList()

Deprecated.

RubyArray implements List, use it directly

Returns:

a read-only copy of this list

getLength

public abstract int getLength()

toJavaArray

@Deprecated(since="10.0.0.0")
public IRubyObject[] toJavaArray()

Deprecated.

Use toJavaArray(ThreadContext) instead.

Returns:

""

toJavaArray

public abstract IRubyObject[] toJavaArray(ThreadContext context)

Return a Java array copy of the elements contained in this Array. This version always creates a new Java array that is exactly the length of the Array's elements.

Returns:

a Java array with exactly the size and contents of this RubyArray's elements

toJavaArrayUnsafe

public abstract IRubyObject[] toJavaArrayUnsafe()

Return a reference to this RubyArray's underlying Java array, if it is not shared with another RubyArray, or an exact copy of the relevant range otherwise. This method is typically used to work with the underlying array directly, knowing that it is not shared and that all accesses must consider the begin offset.

Returns:

The underlying Java array for this RubyArray, or a copy if that array is shared.

toJavaArrayMaybeUnsafe

public abstract IRubyObject[] toJavaArrayMaybeUnsafe()

Return a Java array of the elements contained in this array, possibly a new array object. Use this method to potentially avoid making a new array and copying elements when the Array does not view a subset of the underlying Java array.

Returns:

a Java array with exactly the size and contents of this RubyArray's elements, possibly the actual underlying array.

isSharedJavaArray

public abstract boolean isSharedJavaArray(RubyArray other)

initialize

public abstract IRubyObject initialize(ThreadContext context,
 Block block)

initialize

public abstract IRubyObject initialize(ThreadContext context,
 IRubyObject arg0,
 Block block)

initialize

public abstract IRubyObject initialize(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 Block block)

initialize_copy

public abstract IRubyObject initialize_copy(ThreadContext context,
 IRubyObject orig)

Description copied from class: RubyBasicObject

Initializes this object as a copy of the original, that is the parameter to this object. Will make sure that the argument actually has the same real class as this object. It shouldn't be possible to initialize an object with something totally different.

Overrides:

initialize_copy in class RubyBasicObject

Parameters:

context - the thread context

orig - the original

Returns:

a copy unless the same thing

aryDup

public abstract RubyArray aryDup()

replace

@Deprecated(since="10.0.0.0")
public IRubyObject replace(IRubyObject orig)

Deprecated.

replace

public abstract IRubyObject replace(ThreadContext context,
 IRubyObject orig)

to_s

public abstract RubyString to_s(ThreadContext context)

Overrides:

to_s in class RubyBasicObject

includes

public abstract boolean includes(ThreadContext context,
 IRubyObject item)

includesByEql

protected abstract boolean includesByEql(ThreadContext context,
 IRubyObject item)

hash

public abstract RubyFixnum hash(ThreadContext context)

Description copied from class: RubyBasicObject

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

Parameters:

context - the current thread context

Returns:

the hash value

store

public abstract IRubyObject store(long index,
 IRubyObject value)

store

public abstract IRubyObject store(ThreadContext context,
 long index,
 IRubyObject value)

Store an element at the specified index or throw if the index is invalid.

Parameters:

context - the current thread context

index - the offset to store the value

value - the value to be stored

Returns:

the value set

storeInternal

protected abstract void storeInternal(ThreadContext context,
 int index,
 IRubyObject value)

elt

protected abstract IRubyObject elt(long offset)

eltOk

public abstract T eltOk(long offset)

eltSetOk

public abstract T eltSetOk(long offset,
 T value)

eltSetOk

public abstract T eltSetOk(int offset,
 T value)

entry

public abstract IRubyObject entry(long offset)

entry

public abstract IRubyObject entry(int offset)

eltInternal

public abstract T eltInternal(int offset)

eltInternalSet

public abstract T eltInternalSet(int offset,
 T item)

fetch

@Deprecated(since="9.4-")
public IRubyObject fetch(ThreadContext context,
 IRubyObject[] args,
 Block block)

Deprecated.

Use the versions with zero, one, or two args.

Variable arity version for compatibility. Not bound to a Ruby method.

fetch_values

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

fetch

public abstract IRubyObject fetch(ThreadContext context,
 IRubyObject arg0,
 Block block)

fetch

public abstract IRubyObject fetch(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 Block block)

aryToAry

public static RubyArray aryToAry(ThreadContext context,
 IRubyObject obj)

insert

@Deprecated(since="10.0.0.0")
public IRubyObject insert(IRubyObject arg)

Deprecated.

insert

public abstract IRubyObject insert(ThreadContext context,
 IRubyObject arg)

insert

@Deprecated(since="10.0.0.0")
public IRubyObject insert(IRubyObject arg1,
 IRubyObject arg2)

Deprecated.

insert

public abstract IRubyObject insert(ThreadContext context,
 IRubyObject arg1,
 IRubyObject arg2)

insert

@Deprecated(since="10.0.0.0")
public IRubyObject insert(IRubyObject[] args)

Deprecated.

insert

public abstract IRubyObject insert(ThreadContext context,
 IRubyObject[] args)

transpose

@Deprecated(since="10.0.0.0")
public RubyArray transpose()

Deprecated.

transpose

public abstract RubyArray transpose(ThreadContext context)

values_at

@Deprecated(since="10.0.0.0")
public IRubyObject values_at(IRubyObject[] args)

Deprecated.

values_at

public abstract IRubyObject values_at(ThreadContext context,
 IRubyObject[] args)

subseqLight

public abstract IRubyObject subseqLight(long beg,
 long len)

subseq

public abstract IRubyObject subseq(RubyClass metaClass,
 long beg,
 long len,
 boolean light)

length

public abstract RubyFixnum length(ThreadContext context)

length

@Deprecated(since="10.0.0.0")
public RubyFixnum length()

Deprecated.

size

protected static IRubyObject size(ThreadContext context,
 RubyArray self,
 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[])

append

@Deprecated(since="10.0.0.0")
public RubyArray<?> append(IRubyObject item)

Deprecated.

append

public abstract RubyArray append(ThreadContext context,
 IRubyObject item)

push_m

@Deprecated(since="10.0.3.0")
public RubyArray<?> push_m(IRubyObject[] items)

Deprecated.

push

@Deprecated(since="10.0.0.0")
public RubyArray push(IRubyObject item)

Deprecated.

push

public abstract RubyArray push(ThreadContext context,
 IRubyObject item)

push

@Deprecated(since="10.0.0.0")
public RubyArray<?> push(IRubyObject[] items)

Deprecated.

push

public abstract RubyArray push(ThreadContext context,
 IRubyObject[] items)

pop

public abstract IRubyObject pop(ThreadContext context)

pop

public abstract IRubyObject pop(ThreadContext context,
 IRubyObject num)

shift

public abstract IRubyObject shift(ThreadContext context)

shift

public abstract IRubyObject shift(ThreadContext context,
 IRubyObject num)

unshift

@Deprecated(since="10.0.0.0")
public IRubyObject unshift()

Deprecated.

unshift

public abstract IRubyObject unshift(ThreadContext context)

unshift

@Deprecated(since="10.0.0.0")
public IRubyObject unshift(IRubyObject item)

Deprecated.

unshift

public abstract IRubyObject unshift(ThreadContext context,
 IRubyObject item)

unshift

@Deprecated(since="10.0.0.0")
public IRubyObject unshift(IRubyObject[] items)

Deprecated.

unshift

public abstract IRubyObject unshift(ThreadContext context,
 IRubyObject[] items)

include_p

public abstract RubyBoolean include_p(ThreadContext context,
 IRubyObject item)

aref

@Deprecated(since="10.0.0.0")
public IRubyObject aref(IRubyObject[] args)

Deprecated.

Use the versions with zero, one, or two args.

Variable arity version for compatibility. Not bound to a Ruby method.

aref

public abstract IRubyObject aref(ThreadContext context,
 IRubyObject arg0)

aref

@Deprecated(since="10.0.0.0")
public IRubyObject aref(IRubyObject arg0,
 IRubyObject arg1)

Deprecated.

aref

public abstract IRubyObject aref(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

aset

@Deprecated(since="9.4-")
public IRubyObject aset(IRubyObject[] args)

Deprecated.

Use the versions with zero, one, or two args.

Variable arity version for compatibility. Not bound to a Ruby method.

aset

@Deprecated(since="10.0.0.0")
public IRubyObject aset(IRubyObject arg0,
 IRubyObject arg1)

Deprecated.

aset

@Deprecated(since="10.0.0.0")
public IRubyObject aset(IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

Deprecated.

Use aset(ThreadContext, IRubyObject, IRubyObject, IRubyObject) instead.

Parameters:

arg0 -

arg1 -

arg2 -

Returns:

""

aset

public abstract IRubyObject aset(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

aset

public abstract IRubyObject aset(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

at

@Deprecated(since="10.0.0.0")
public IRubyObject at(IRubyObject pos)

Deprecated.

Use at(ThreadContext, IRubyObject) instead.

Parameters:

pos -

Returns:

""

at

public abstract IRubyObject at(ThreadContext context,
 IRubyObject pos)

concat

public abstract RubyArray concat(ThreadContext context,
 IRubyObject obj)

aryAppend

@Deprecated(since="10.0.0.0")
public RubyArray aryAppend(RubyArray y)

Deprecated.

aryAppend

public abstract RubyArray aryAppend(ThreadContext context,
 RubyArray<?> y)

concat

public abstract RubyArray concat(ThreadContext context,
 IRubyObject[] objs)

concat

public abstract RubyArray concat(IRubyObject obj)

inspect

public abstract RubyString 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

first

@Deprecated(since="9.4-")
public IRubyObject first(IRubyObject[] args)

Deprecated.

first

@Deprecated(since="10.0.0.0")
public IRubyObject first()

Deprecated.

first

public abstract IRubyObject first(ThreadContext context)

first

@Deprecated(since="10.0.0.0")
public IRubyObject first(IRubyObject arg0)

Deprecated.

first

public abstract IRubyObject first(ThreadContext context,
 IRubyObject arg0)

last

@Deprecated(since="9.4-")
public IRubyObject last(IRubyObject[] args)

Deprecated.

Use the versions with zero, one, or two args.

Variable arity version for compatibility. Not bound to a Ruby method.

last

@Deprecated(since="10.0.0.0")
public IRubyObject last()

Deprecated.

last

public abstract IRubyObject last(ThreadContext context)

last

@Deprecated(since="10.0.0.0")
public IRubyObject last(IRubyObject arg0)

Deprecated.

last

public abstract IRubyObject last(ThreadContext context,
 IRubyObject arg0)

each

public abstract IRubyObject each(ThreadContext context,
 Block block)

eachSlice

public abstract IRubyObject eachSlice(ThreadContext context,
 int size,
 Block block)

each_slice

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

each_index

public abstract IRubyObject each_index(ThreadContext context,
 Block block)

reverse_each

public abstract IRubyObject reverse_each(ThreadContext context,
 Block block)

join19

@Deprecated(since="10.0.0.0")
public IRubyObject join19(ThreadContext context,
 IRubyObject sep)

Deprecated.

join

public abstract IRubyObject join(ThreadContext context,
 IRubyObject sep)

join19

@Deprecated(since="10.0.0.0")
public IRubyObject join19(ThreadContext context)

Deprecated.

join

public abstract IRubyObject join(ThreadContext context)

to_a

public abstract RubyArray to_a(ThreadContext context)

Overrides:

to_a in class RubyBasicObject

to_ary

@Deprecated(since="10.0.0.0")
public IRubyObject to_ary()

Deprecated.

to_ary

public final IRubyObject to_ary(ThreadContext context)

to_h

public abstract IRubyObject to_h(ThreadContext context,
 Block block)

convertToArray

public final RubyArray convertToArray()

Description copied from class: RubyBasicObject

Tries to convert this object to a Ruby Array using the "to_ary" method.

Specified by:

convertToArray in interface IRubyObject

Overrides:

convertToArray in class RubyBasicObject

Returns:

array representation of this

checkArrayType

public final IRubyObject checkArrayType()

Description copied from class: RubyBasicObject

rb_check_array_type Returns the result of trying to convert this object to an Array with "to_ary".

Specified by:

checkArrayType in interface IRubyObject

Overrides:

checkArrayType in class RubyBasicObject

Returns:

nil if type check failed

op_equal

public abstract IRubyObject op_equal(ThreadContext context,
 IRubyObject obj)

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

compare

public abstract RubyBoolean compare(ThreadContext context,
 CallSite site,
 IRubyObject other)

eql

public abstract IRubyObject eql(ThreadContext context,
 IRubyObject obj)

compact_bang

@Deprecated(since="10.0.0.0")
public IRubyObject compact_bang()

Deprecated.

Use compact_bang(ThreadContext)

Returns:

""

compact_bang

public abstract IRubyObject compact_bang(ThreadContext context)

compact

@Deprecated(since="10.0.0.0")
public IRubyObject compact()

Deprecated.

compact

public abstract IRubyObject compact(ThreadContext context)

empty_p

@Deprecated(since="10.0.0.0")
public IRubyObject empty_p()

Deprecated.

empty_p

public abstract IRubyObject empty_p(ThreadContext context)

rb_clear

@Deprecated(since="10.0.0.0")
public IRubyObject rb_clear()

Deprecated.

rb_clear

public abstract IRubyObject rb_clear(ThreadContext context)

fill

public abstract IRubyObject fill(ThreadContext context,
 Block block)

fill

public abstract IRubyObject fill(ThreadContext context,
 IRubyObject arg,
 Block block)

fill

public abstract IRubyObject fill(ThreadContext context,
 IRubyObject arg1,
 IRubyObject arg2,
 Block block)

fill

public abstract IRubyObject fill(ThreadContext context,
 IRubyObject arg1,
 IRubyObject arg2,
 IRubyObject arg3,
 Block block)

index

public abstract IRubyObject index(ThreadContext context,
 IRubyObject obj)

index

public abstract IRubyObject index(ThreadContext context,
 IRubyObject obj,
 Block unused)

index

public abstract IRubyObject index(ThreadContext context,
 Block block)

bsearch

public abstract IRubyObject bsearch(ThreadContext context,
 Block block)

bsearch_index

public abstract IRubyObject bsearch_index(ThreadContext context,
 Block block)

rindex

public abstract IRubyObject rindex(ThreadContext context,
 IRubyObject obj,
 Block unused)

rindex

public abstract IRubyObject rindex(ThreadContext context,
 Block block)

indexes

@Deprecated(since="10.0.0.0")
public IRubyObject indexes(IRubyObject[] args)

Deprecated.

indexes

@Deprecated(since="10.0.0.0")
public IRubyObject indexes(ThreadContext context,
 IRubyObject[] args)

Deprecated.

reverse_bang

@Deprecated(since="10.0.0.0")
public IRubyObject reverse_bang()

Deprecated.

reverse_bang

public abstract IRubyObject reverse_bang(ThreadContext context)

reverse

@Deprecated(since="10.0.0.0")
public IRubyObject reverse()

Deprecated.

reverse

public abstract IRubyObject reverse(ThreadContext context)

rbCollect

public abstract IRubyObject rbCollect(ThreadContext context,
 Block block)

map

public abstract IRubyObject map(ThreadContext context,
 Block block)

collect_bang

public abstract IRubyObject collect_bang(ThreadContext context,
 Block block)

map_bang

public abstract IRubyObject map_bang(ThreadContext context,
 Block block)

select

public abstract IRubyObject select(ThreadContext context,
 Block block)

select_bang

public abstract IRubyObject select_bang(ThreadContext context,
 Block block)

keep_if

public abstract IRubyObject keep_if(ThreadContext context,
 Block block)

deconstruct

public final IRubyObject deconstruct(ThreadContext context)

delete

public abstract IRubyObject delete(ThreadContext context,
 IRubyObject item,
 Block block)

delete_at

@Deprecated(since="10.0.0.0")
public IRubyObject delete_at(int pos)

Deprecated.

delete_at

public abstract IRubyObject delete_at(ThreadContext context,
 int pos)

delete_at

@Deprecated(since="10.0.0.0")
public IRubyObject delete_at(IRubyObject obj)

Deprecated.

delete_at

public abstract IRubyObject delete_at(ThreadContext context,
 IRubyObject obj)

reject

public abstract IRubyObject reject(ThreadContext context,
 Block block)

reject_bang

public abstract IRubyObject reject_bang(ThreadContext context,
 Block block)

delete_if

public abstract IRubyObject delete_if(ThreadContext context,
 Block block)

zip

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

op_cmp

public abstract IRubyObject op_cmp(ThreadContext context,
 IRubyObject obj)

Overrides:

op_cmp in class RubyBasicObject

slice_bang

@Deprecated(since="9.4-")
public IRubyObject slice_bang(IRubyObject[] args)

Deprecated.

Use the versions with zero, one, or two args.

Variable arity version for compatibility. Not bound to a Ruby method.

slice_bang

@Deprecated(since="10.0.0.0")
public IRubyObject slice_bang(IRubyObject arg0)

Deprecated.

slice_bang

public abstract IRubyObject slice_bang(ThreadContext context,
 IRubyObject arg0)

slice_bang

@Deprecated(since="10.0.0.0")
public IRubyObject slice_bang(IRubyObject arg0,
 IRubyObject arg1)

Deprecated.

slice_bang

public abstract IRubyObject slice_bang(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

assoc

public abstract IRubyObject assoc(ThreadContext context,
 IRubyObject key)

rassoc

public abstract IRubyObject rassoc(ThreadContext context,
 IRubyObject value)

flatten_bang

public abstract IRubyObject flatten_bang(ThreadContext context)

flatten_bang

public abstract IRubyObject flatten_bang(ThreadContext context,
 IRubyObject arg)

flatten

public abstract IRubyObject flatten(ThreadContext context)

flatten

public abstract IRubyObject flatten(ThreadContext context,
 IRubyObject arg)

count

public abstract IRubyObject count(ThreadContext context,
 Block block)

count

public abstract IRubyObject count(ThreadContext context,
 IRubyObject obj,
 Block block)

nitems

public abstract IRubyObject nitems(ThreadContext context)

nitems

@Deprecated(since="10.0.0.0")
public IRubyObject nitems()

Deprecated.

op_plus

@Deprecated(since="10.0.0.0")
public IRubyObject op_plus(IRubyObject obj)

Deprecated.

op_plus

public abstract IRubyObject op_plus(ThreadContext context,
 IRubyObject obj)

op_times

public abstract IRubyObject op_times(ThreadContext context,
 IRubyObject times)

makeHash

protected abstract RubyHash makeHash(Ruby runtime)

makeHash

protected abstract RubyHash makeHash(RubyHash hash)

uniq_bang

public abstract IRubyObject uniq_bang(ThreadContext context,
 Block block)

uniq

public abstract IRubyObject uniq(ThreadContext context,
 Block block)

op_diff

@Deprecated(since="10.0.0.0")
public IRubyObject op_diff(IRubyObject other)

Deprecated.

op_diff

public abstract IRubyObject op_diff(ThreadContext context,
 IRubyObject other)

difference

public abstract IRubyObject difference(ThreadContext context,
 IRubyObject[] args)

intersection

public abstract IRubyObject intersection(ThreadContext context,
 IRubyObject[] args)

intersect_p

public abstract IRubyObject intersect_p(ThreadContext context,
 IRubyObject other)

op_and

@Deprecated(since="10.0.0.0")
public IRubyObject op_and(IRubyObject other)

Deprecated.

op_and

public abstract IRubyObject op_and(ThreadContext context,
 IRubyObject other)

op_or

@Deprecated(since="10.0.0.0")
public IRubyObject op_or(IRubyObject other)

Deprecated.

op_or

public abstract IRubyObject op_or(ThreadContext context,
 IRubyObject other)

union

public abstract IRubyObject union(ThreadContext context,
 IRubyObject[] args)

unionInternal

protected abstract void unionInternal(ThreadContext context,
 RubyArray... args)

sort

public abstract RubyArray sort(ThreadContext context,
 Block block)

sort_bang

public abstract IRubyObject sort_bang(ThreadContext context,
 Block block)

sort_by_bang

public abstract IRubyObject sort_by_bang(ThreadContext context,
 Block block)

take

public abstract IRubyObject take(ThreadContext context,
 IRubyObject n)

take_while

public abstract IRubyObject take_while(ThreadContext context,
 Block block)

drop

public abstract IRubyObject drop(ThreadContext context,
 IRubyObject n)

drop_while

public abstract IRubyObject drop_while(ThreadContext context,
 Block block)

cycle

public abstract IRubyObject cycle(ThreadContext context,
 Block block)

cycle

public abstract IRubyObject cycle(ThreadContext context,
 IRubyObject arg,
 Block block)

product

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

combination

public abstract IRubyObject combination(ThreadContext context,
 IRubyObject num,
 Block block)

repeatedCombination

public abstract IRubyObject repeatedCombination(ThreadContext context,
 IRubyObject num,
 Block block)

permutation

public abstract IRubyObject permutation(ThreadContext context,
 IRubyObject num,
 Block block)

permutation

public abstract IRubyObject permutation(ThreadContext context,
 Block block)

repeated_permutation

public abstract IRubyObject repeated_permutation(ThreadContext context,
 IRubyObject num,
 Block block)

shuffle_bang

public abstract IRubyObject shuffle_bang(ThreadContext context)

shuffle_bang

public abstract IRubyObject shuffle_bang(ThreadContext context,
 IRubyObject opts)

shuffle

public abstract IRubyObject shuffle(ThreadContext context)

shuffle

public abstract IRubyObject shuffle(ThreadContext context,
 IRubyObject opts)

sample

public abstract IRubyObject sample(ThreadContext context)

sample

public abstract IRubyObject sample(ThreadContext context,
 IRubyObject sampleOrOpts)

sample

public abstract IRubyObject sample(ThreadContext context,
 IRubyObject sample,
 IRubyObject opts)

rotate_bang

public abstract IRubyObject rotate_bang(ThreadContext context)

rotate_bang

public abstract IRubyObject rotate_bang(ThreadContext context,
 IRubyObject cnt)

rotate

public abstract IRubyObject rotate(ThreadContext context)

rotate

public abstract IRubyObject rotate(ThreadContext context,
 IRubyObject cnt)

all_p

public abstract IRubyObject all_p(ThreadContext context,
 Block block)

all_p

public abstract IRubyObject all_p(ThreadContext context,
 IRubyObject arg,
 Block block)

any_p

public abstract IRubyObject any_p(ThreadContext context,
 Block block)

any_p

public abstract IRubyObject any_p(ThreadContext context,
 IRubyObject arg,
 Block block)

none_p

public abstract IRubyObject none_p(ThreadContext context,
 Block block)

none_p

public abstract IRubyObject none_p(ThreadContext context,
 IRubyObject arg,
 Block block)

one_p

public abstract IRubyObject one_p(ThreadContext context,
 Block block)

one_p

public abstract IRubyObject one_p(ThreadContext context,
 IRubyObject arg,
 Block block)

sum

public abstract IRubyObject sum(ThreadContext context,
 Block block)

sum

public abstract IRubyObject sum(ThreadContext context,
 IRubyObject init,
 Block block)

find

public abstract IRubyObject find(ThreadContext context,
 IRubyObject ifnone,
 Block block)

find_index

public abstract IRubyObject find_index(ThreadContext context,
 Block block)

find_index

public abstract IRubyObject find_index(ThreadContext context,
 IRubyObject cond)

newBlankArray

@Deprecated(since="10.0.0.0")
public static RubyArray newBlankArray(Ruby runtime,
 int size)

Deprecated.

newBlankArray

public static RubyArray newBlankArray(ThreadContext context,
 int size)

Construct the most efficient array shape for the given size. This should only be used when you intend to populate all elements, since the packed arrays will be born with a nonzero size and would have to be unpacked to partially populate. We nil-fill all cases, to ensure nulls will never leak out if there's an unpopulated element or an index accessed before assignment.

Parameters:

context - the current thread context

size - the size

Returns:

a RubyArray shaped for the given size

try_convert

public static IRubyObject try_convert(ThreadContext context,
 IRubyObject self,
 IRubyObject arg)

pack

public abstract RubyString pack(ThreadContext context,
 IRubyObject obj)

pack

public abstract RubyString pack(ThreadContext context,
 IRubyObject obj,
 IRubyObject maybeOpts)

dig

public abstract IRubyObject dig(ThreadContext context,
 IRubyObject arg0)

dig

public abstract IRubyObject dig(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

dig

public abstract IRubyObject dig(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

dig

public abstract IRubyObject dig(ThreadContext context,
 IRubyObject[] args)

max

public abstract IRubyObject max(ThreadContext context,
 Block block)

max

public abstract IRubyObject max(ThreadContext context,
 IRubyObject num,
 Block block)

min

public abstract IRubyObject min(ThreadContext context,
 Block block)

min

public abstract IRubyObject min(ThreadContext context,
 IRubyObject num,
 Block block)

minmax

public abstract IRubyObject minmax(ThreadContext context,
 Block block)

getJavaClass

public Class getJavaClass()

Description copied from class: RubyBasicObject

Will return the Java interface that most closely can represent this object, when working through Java integration translations.

Specified by:

getJavaClass in interface IRubyObject

Overrides:

getJavaClass in class RubyBasicObject

Returns:

the true Java class of this (Ruby) object

copyInto

@Deprecated(since="10.0.0.0")
public void copyInto(IRubyObject[] target,
 int start)

Deprecated.

copyInto

public abstract void copyInto(ThreadContext context,
 IRubyObject[] target,
 int start)

Copy the values contained in this array into the target array at the specified offset. It is expected that the target array is large enough to hold all necessary values.

copyInto

@Deprecated(since="10.0.0.0")
public void copyInto(IRubyObject[] target,
 int start,
 int len)

Deprecated.

copyInto

public abstract void copyInto(ThreadContext context,
 IRubyObject[] target,
 int start,
 int len)

Copy the specified number of values contained in this array into the target array at the specified offset. It is expected that the target array is large enough to hold all necessary values.

equals

public abstract boolean equals(Object other)

Description copied from class: RubyObject

This override does not do a "checked" dispatch.

Specified by:

equals in interface Collection<T extends IRubyObject>

Specified by:

equals in interface List<T extends IRubyObject>

Overrides:

equals in class RubyObject

Parameters:

other - object to compare

Returns:

true if equals

See Also:

• RubyBasicObject.equals(Object)

rfind

public abstract IRubyObject rfind(ThreadContext context,
 Block block)

rfind

public abstract IRubyObject rfind(ThreadContext context,
 IRubyObject ifnone,
 Block block)

marshalTo

@Deprecated(since="10.0.0.0",
            forRemoval=true)
public static void marshalTo(RubyArray array,
 MarshalStream output)
                      throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IOException

marshalTo

@Deprecated(since="10.0.0.0",
            forRemoval=true)
public static void marshalTo(ThreadContext context,
 RubyArray array,
 MarshalStream output)
                      throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IOException

marshalTo

public static void marshalTo(ThreadContext context,
 RubyOutputStream out,
 RubyArray array,
 MarshalDumper output)

unmarshalFrom

@Deprecated(since="10.0.0.0",
            forRemoval=true)
public static RubyArray unmarshalFrom(UnmarshalStream input)
                               throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IOException

unmarshalFrom

public static RubyArray unmarshalFrom(ThreadContext context,
 RubyInputStream in,
 MarshalLoader input)

rubyStream

public abstract Stream<IRubyObject> rubyStream()

Returns a stream of each IRubyObject

Returns: