Module org.jruby.base

Package org.jruby

Class RubyHash

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyHash

All Implemented Interfaces:

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

Direct Known Subclasses:

RubyHashLinkedBuckets

public class RubyHash
extends RubyObject
implements Map

Implementation of the Hash class. Concurrency: no synchronization is required among readers, but all users must synchronize externally with writers.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RubyHash.RubyHashEntry
static class	RubyHash.Visitor
protected static class	RubyHash.VisitorIOException
static class	RubyHash.VisitorWithState<T>
static interface	RubyHash.VisitorWithStateI

Nested classes/interfaces inherited from class org.jruby.RubyObject

RubyObject.Data

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

RubyBasicObject.Finalizer

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final byte	COMPARE_BY_IDENTITY
static final int	DEFAULT_INSPECT_STR_SIZE
static final int[]	MRI_PRIMES	Deprecated.
static final RubyHash.RubyHashEntry	NO_ENTRY	Deprecated.
protected static final RubyHash.RubyHashEntry	NULL_ENTRY
protected static final byte	PROCDEFAULT_HASH
protected static final byte	RUBY2_KEYWORD
protected Object	state	This field is used as part of the state of RubyHashLinkedBuckets, but when supporting legacy constructors it will point at a delegated instance.
static final RubyHash.VisitorWithState<RubyArray>	StoreValueVisitor

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
	RubyHash(Ruby runtime)	Deprecated.
	RubyHash(Ruby runtime, RubyClass klass)	Deprecated.
	RubyHash(Ruby runtime, RubyClass klass, boolean objectSpace)	Deprecated.
protected	RubyHash(Ruby runtime, RubyClass klass, boolean objectSpace, int unused)
	RubyHash(Ruby runtime, IRubyObject defaultValue)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addAll(ThreadContext context, RubyHash otherHash)
<T> boolean	allSymbols()
IRubyObject	any_p(ThreadContext context, Block block)
IRubyObject	any_p(ThreadContext context, IRubyObject pattern, Block block)
IRubyObject	assoc(ThreadContext context, IRubyObject obj)
void	clear()
IRubyObject	compact(ThreadContext context)
IRubyObject	compact_bang(ThreadContext context)
RubyBoolean	compare(ThreadContext context, RubyHash.VisitorWithState<RubyHash> visitor, IRubyObject other, boolean eql)
IRubyObject	compare_by_identity(ThreadContext context)
IRubyObject	compare_by_identity_p(ThreadContext context)
boolean	containsKey(Object key)
boolean	containsValue(Object value)
RubyHash	convertToHash()	Tries to convert this object to a Ruby Hash using the "to_hash" method.
static IRubyObject	create(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)	rb_hash_s_create
static RubyClass	createHashClass(ThreadContext context, RubyClass Object, RubyModule Enumerable)
IRubyObject	deconstruct_keys(ThreadContext context, IRubyObject _arg1)
IRubyObject	default_proc(ThreadContext context)
IRubyObject	default_value_get(ThreadContext context)
IRubyObject	default_value_get(ThreadContext context, IRubyObject arg)
IRubyObject	default_value_set(ThreadContext context, IRubyObject defaultValue)
IRubyObject	delete(IRubyObject key)
IRubyObject	delete(ThreadContext context, IRubyObject key)
IRubyObject	delete(ThreadContext context, IRubyObject key, Block block)
IRubyObject	delete_if(ThreadContext context, Block block)
RubyHash	delete_ifInternal(ThreadContext context, Block block)
IRubyObject	dig(ThreadContext context, IRubyObject arg0)
IRubyObject	dig(ThreadContext context, IRubyObject[] args)
IRubyObject	dig(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	dig(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
Set	directEntrySet()
Set	directKeySet()
Collection	directValues()
IRubyObject	dup(ThreadContext context)	RubyMethod dup.
RubyHash	dupFast(ThreadContext context)	A lightweight dup for internal use that does not dispatch to initialize_copy nor rehash the keys.
IRubyObject	each(ThreadContext context, Block block)
IRubyObject	each_key(ThreadContext context, Block block)
RubyHash	each_keyCommon(ThreadContext context, Block block)
RubyHash	each_pairCommon(ThreadContext context, Block block)
IRubyObject	each_value(ThreadContext context, Block block)
RubyHash	each_valueCommon(ThreadContext context, Block block)
RubyHash	eachCommon(ThreadContext context, Block block)
RubyBoolean	empty_p(ThreadContext context)
Set	entrySet()
boolean	equals(Object other)	This override does not do a "checked" dispatch.
IRubyObject	except(ThreadContext context, IRubyObject[] keys)
IRubyObject	fastARef(IRubyObject key)
void	fastASet(Ruby runtime, IRubyObject key, IRubyObject value, boolean prepareString)
void	fastASet(IRubyObject key, IRubyObject value)
void	fastASetCheckString(Ruby runtime, IRubyObject key, IRubyObject value)
void	fastASetSmall(Ruby runtime, IRubyObject key, IRubyObject value, boolean prepareString)
void	fastASetSmall(IRubyObject key, IRubyObject value)
void	fastASetSmallCheckString(Ruby runtime, IRubyObject key, IRubyObject value)
void	fastASetSmallPair(ThreadContext context, IRubyObject _pair)
boolean	fastDelete(IRubyObject key)
IRubyObject	fetch(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	fetch(ThreadContext context, IRubyObject key, Block block)
IRubyObject	fetch(ThreadContext context, IRubyObject key, IRubyObject _default, Block block)
RubyArray	fetch_values(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	flatten(ThreadContext context)
IRubyObject	flatten(ThreadContext context, IRubyObject level)
protected boolean	get(int flag)
Object	get(Object key)
IRubyObject	getIfNone()
Class	getJavaClass()	Will return the Java interface that most closely can represent this object, when working through Java integration translations.
ClassIndex	getNativeClassIndex()	This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
RubyBoolean	has_key_p(ThreadContext context, IRubyObject key)
RubyBoolean	has_value_p(ThreadContext context, IRubyObject expected)
boolean	hasDefaultProc()
RubyFixnum	hash(ThreadContext context)	Will return the hash code of this object.
boolean	hasKey(IRubyObject key)	A Java API to test the presence of a (Ruby) key in the Hash
IRubyObject	initialize(ThreadContext context, Block block)
IRubyObject	initialize(ThreadContext context, IRubyObject _default, Block block)
IRubyObject	initialize(ThreadContext context, IRubyObject _default, IRubyObject hash, Block block)
RubyHash	initialize_copy(ThreadContext context, IRubyObject other)	Initializes this object as a copy of the original, that is the parameter to this object.
IRubyObject	inspect(ThreadContext context)	Returns a string containing a human-readable representation of obj.
protected IRubyObject	internalGet(IRubyObject key)
IRubyObject	internalPut(IRubyObject key, IRubyObject value)
RubyHash	invert(ThreadContext context)
boolean	isComparedByIdentity()
boolean	isEmpty()
boolean	isRuby2KeywordHash()
IRubyObject	keep_if(ThreadContext context, Block block)
boolean	keep_ifCommon(ThreadContext context, Block block)
IRubyObject	key(ThreadContext context, IRubyObject expected)
RubyArray	keys()
RubyArray	keys(ThreadContext context)
Set	keySet()
static void	marshalTo(RubyHash hash, MarshalStream output)	Deprecated, for removal: This API element is subject to removal in a future version.
static void	marshalTo(ThreadContext context, RubyOutputStream out, RubyHash hash, MarshalDumper output)
RubyHash	merge(ThreadContext context, IRubyObject[] others, Block block)
RubyHash	merge_bang(ThreadContext context, IRubyObject[] others, Block block)
void	modify()
static final RubyHash	newHash(Ruby runtime)	rb_hash_new
static final RubyHash	newHash(Ruby runtime, Map valueMap, IRubyObject defaultValue)	rb_hash_new
static RubyHash	newHash(Ruby runtime, IRubyObject key, IRubyObject value)
static RubyHash	newKwargs(Ruby runtime, String key, IRubyObject value)
static final RubyHash	newSmallHash(Ruby runtime)	rb_hash_new
IRubyObject	op_aref(ThreadContext context, IRubyObject key)
IRubyObject	op_aset(ThreadContext context, IRubyObject key, IRubyObject value)	Set a key/value pair into this hash.
IRubyObject	op_eql(ThreadContext context, IRubyObject other)
IRubyObject	op_equal(ThreadContext context, IRubyObject other)	rb_obj_equal Will by default use identity equality to compare objects.
IRubyObject	op_ge(ThreadContext context, IRubyObject other)
IRubyObject	op_gt(ThreadContext context, IRubyObject other)
IRubyObject	op_le(ThreadContext context, IRubyObject other)
IRubyObject	op_lt(ThreadContext context, IRubyObject other)
Object	put(Object key, Object value)
void	putAll(Map map)
IRubyObject	rassoc(ThreadContext context, IRubyObject obj)
RubyHash	rb_clear(ThreadContext context)
RubyFixnum	rb_size(ThreadContext context)
RubyArray	rb_values(ThreadContext context)
IRubyObject	rbClone(ThreadContext context)
IRubyObject	rbClone(ThreadContext context, IRubyObject opts)
RubyHash	rehash(ThreadContext context)
IRubyObject	reject(ThreadContext context, Block block)
IRubyObject	reject_bang(ThreadContext context, Block block)
IRubyObject	reject_bangInternal(ThreadContext context, Block block)
RubyHash	rejectInternal(ThreadContext context, Block block)
Object	remove(Object key)
RubyHash	replace(ThreadContext context, IRubyObject other)
static IRubyObject	ruby2_keywords_hash(ThreadContext context, IRubyObject _self, IRubyObject arg)
static IRubyObject	ruby2_keywords_hash_p(ThreadContext context, IRubyObject _self, IRubyObject arg)
IRubyObject	select(ThreadContext context, Block block)
IRubyObject	select_bang(ThreadContext context, Block block)
protected void	set(int flag, boolean set)
IRubyObject	set_default_proc(ThreadContext context, IRubyObject proc)
void	setComparedByIdentity(boolean comparedByIdentity)
void	setRuby2KeywordHash(boolean value)
IRubyObject	shift(ThreadContext context)
int	size()
RubyHash	slice(ThreadContext context, IRubyObject[] args)
RubyArray	to_a(ThreadContext context)
RubyHash	to_h(ThreadContext context, Block block)
protected RubyHash	to_h_block(ThreadContext context, Block block)
RubyHash	to_hash(ThreadContext context)
IRubyObject	to_proc(ThreadContext context)
IRubyObject	to_s(ThreadContext context)
IRubyObject	transform_keys(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	transform_keys_bang(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	transform_values(ThreadContext context, Block block)
IRubyObject	transform_values_bang(ThreadContext context, Block block)
static IRubyObject	try_convert(ThreadContext context, IRubyObject recv, IRubyObject args)
static RubyHash	unmarshalFrom(UnmarshalStream input, boolean defaultValue)	Deprecated, for removal: This API element is subject to removal in a future version.
static RubyHash	unmarshalFrom(ThreadContext context, RubyInputStream in, MarshalLoader input, boolean defaultValue, boolean identity)
Collection	values()
RubyArray	values(ThreadContext context)
RubyArray	values_at(ThreadContext context, IRubyObject[] args)
final void	visitAll(RubyHash.Visitor visitor)	Deprecated.
<T> void	visitAll(ThreadContext context, RubyHash.VisitorWithStateI visitor)
<T> void	visitAll(ThreadContext context, RubyHash.VisitorWithState visitor, T state)
protected <T> void	visitLimited(ThreadContext context, RubyHash.VisitorWithState visitor, long size, T state)
RubyHash	withRuby2Keywords(boolean ruby2Keywords)

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, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, compareTo, convertToArray, convertToFloat, 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_cmp, op_match, op_not, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, 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 org.jruby.runtime.builtin.IRubyObject

checkStringType19, marshalLiveVariables

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Details

DEFAULT_INSPECT_STR_SIZE

public static final int DEFAULT_INSPECT_STR_SIZE

See Also:

• Constant Field Values

state

protected Object state

This field is used as part of the state of RubyHashLinkedBuckets, but when supporting legacy constructors it will point at a delegated instance. Once all consumers of the deprecated constructor have been migrated, we move this field back into the subclasses and eliminate all delegated methods.

COMPARE_BY_IDENTITY

protected static final byte COMPARE_BY_IDENTITY

See Also:

• Constant Field Values

RUBY2_KEYWORD

protected static final byte RUBY2_KEYWORD

See Also:

• Constant Field Values

PROCDEFAULT_HASH

protected static final byte PROCDEFAULT_HASH

See Also:

• Constant Field Values

NULL_ENTRY

protected static final RubyHash.RubyHashEntry NULL_ENTRY

NO_ENTRY

@Deprecated(since="10.0.3.0")
public static final RubyHash.RubyHashEntry NO_ENTRY

Deprecated.

MRI_PRIMES

@Deprecated(since="10.0.3.0")
public static final int[] MRI_PRIMES

Deprecated.

StoreValueVisitor

public static final RubyHash.VisitorWithState<RubyArray> StoreValueVisitor

Constructor Details

RubyHash

protected RubyHash(Ruby runtime,
 RubyClass klass,
 boolean objectSpace,
 int unused)

RubyHash

@Deprecated(since="10.0.3.0")
public RubyHash(Ruby runtime,
 RubyClass klass)

Deprecated.

RubyHash

@Deprecated(since="10.0.3.0")
public RubyHash(Ruby runtime,
 RubyClass klass,
 boolean objectSpace)

Deprecated.

RubyHash

@Deprecated(since="10.0.3.0")
public RubyHash(Ruby runtime)

Deprecated.

RubyHash

@Deprecated(since="10.0.3.0")
public RubyHash(Ruby runtime,
 IRubyObject defaultValue)

Deprecated.

Method Details

createHashClass

public static RubyClass createHashClass(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

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

rb_hash_s_create

try_convert

public static IRubyObject try_convert(ThreadContext context,
 IRubyObject recv,
 IRubyObject args)

newHash

public static final RubyHash newHash(Ruby runtime)

rb_hash_new

newSmallHash

public static final RubyHash newSmallHash(Ruby runtime)

rb_hash_new

newKwargs

public static RubyHash newKwargs(Ruby runtime,
 String key,
 IRubyObject value)

newHash

public static RubyHash newHash(Ruby runtime,
 IRubyObject key,
 IRubyObject value)

newHash

public static final RubyHash newHash(Ruby runtime,
 Map valueMap,
 IRubyObject defaultValue)

rb_hash_new

internalPut

public IRubyObject internalPut(IRubyObject key,
 IRubyObject value)

internalGet

protected IRubyObject internalGet(IRubyObject key)

visitAll

public <T> void visitAll(ThreadContext context,
 RubyHash.VisitorWithStateI visitor)

visitAll

public <T> void visitAll(ThreadContext context,
 RubyHash.VisitorWithState visitor,
 T state)

visitLimited

protected <T> void visitLimited(ThreadContext context,
 RubyHash.VisitorWithState visitor,
 long size,
 T state)

allSymbols

public <T> boolean allSymbols()

initialize

public IRubyObject initialize(ThreadContext context,
 Block block)

initialize

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

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject _default,
 IRubyObject hash,
 Block block)

default_value_get

public IRubyObject default_value_get(ThreadContext context)

default_value_get

public IRubyObject default_value_get(ThreadContext context,
 IRubyObject arg)

default_value_set

public IRubyObject default_value_set(ThreadContext context,
 IRubyObject defaultValue)

default_proc

public IRubyObject default_proc(ThreadContext context)

set_default_proc

public IRubyObject set_default_proc(ThreadContext context,
 IRubyObject proc)

modify

public void modify()

inspect

public IRubyObject inspect(ThreadContext context)

Description copied from class: RubyBasicObject

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

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

rb_size

public RubyFixnum rb_size(ThreadContext context)

empty_p

public RubyBoolean empty_p(ThreadContext context)

to_a

public RubyArray to_a(ThreadContext context)

Overrides:

to_a in class RubyBasicObject

to_s

public IRubyObject to_s(ThreadContext context)

Overrides:

to_s in class RubyBasicObject

rehash

public RubyHash rehash(ThreadContext context)

to_hash

public RubyHash to_hash(ThreadContext context)

to_h

public RubyHash to_h(ThreadContext context,
 Block block)

to_h_block

protected RubyHash to_h_block(ThreadContext context,
 Block block)

convertToHash

public RubyHash convertToHash()

Description copied from class: RubyBasicObject

Tries to convert this object to a Ruby Hash using the "to_hash" method.

Specified by:

convertToHash in interface IRubyObject

Overrides:

convertToHash in class RubyBasicObject

Returns:

hash representation of this

fastASet

public void fastASet(IRubyObject key,
 IRubyObject value)

fastASetSmall

public void fastASetSmall(IRubyObject key,
 IRubyObject value)

fastASetSmallPair

public void fastASetSmallPair(ThreadContext context,
 IRubyObject _pair)

fastASetCheckString

public void fastASetCheckString(Ruby runtime,
 IRubyObject key,
 IRubyObject value)

fastASetSmallCheckString

public void fastASetSmallCheckString(Ruby runtime,
 IRubyObject key,
 IRubyObject value)

fastASet

public void fastASet(Ruby runtime,
 IRubyObject key,
 IRubyObject value,
 boolean prepareString)

fastASetSmall

public void fastASetSmall(Ruby runtime,
 IRubyObject key,
 IRubyObject value,
 boolean prepareString)

op_aset

public IRubyObject op_aset(ThreadContext context,
 IRubyObject key,
 IRubyObject value)

Set a key/value pair into this hash.

Parameters:

context - the current thread context

key - the key

value - the value

Returns:

the value set

fastARef

public IRubyObject fastARef(IRubyObject key)

compare

public RubyBoolean compare(ThreadContext context,
 RubyHash.VisitorWithState<RubyHash> visitor,
 IRubyObject other,
 boolean eql)

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

op_eql

public IRubyObject op_eql(ThreadContext context,
 IRubyObject other)

op_aref

public IRubyObject op_aref(ThreadContext context,
 IRubyObject key)

op_lt

public IRubyObject op_lt(ThreadContext context,
 IRubyObject other)

op_le

public IRubyObject op_le(ThreadContext context,
 IRubyObject other)

op_gt

public IRubyObject op_gt(ThreadContext context,
 IRubyObject other)

op_ge

public IRubyObject op_ge(ThreadContext context,
 IRubyObject other)

hash

public 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

fetch

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

except

public IRubyObject except(ThreadContext context,
 IRubyObject[] keys)

fetch

public IRubyObject fetch(ThreadContext context,
 IRubyObject key,
 Block block)

fetch

public IRubyObject fetch(ThreadContext context,
 IRubyObject key,
 IRubyObject _default,
 Block block)

has_key_p

public RubyBoolean has_key_p(ThreadContext context,
 IRubyObject key)

hasKey

public boolean hasKey(IRubyObject key)

A Java API to test the presence of a (Ruby) key in the Hash

Parameters:

key - the native (Ruby) key

Returns:

true if the hash contains the provided key

has_value_p

public RubyBoolean has_value_p(ThreadContext context,
 IRubyObject expected)

eachCommon

public RubyHash eachCommon(ThreadContext context,
 Block block)

each

public IRubyObject each(ThreadContext context,
 Block block)

each_pairCommon

public RubyHash each_pairCommon(ThreadContext context,
 Block block)

each_valueCommon

public RubyHash each_valueCommon(ThreadContext context,
 Block block)

each_value

public IRubyObject each_value(ThreadContext context,
 Block block)

each_keyCommon

public RubyHash each_keyCommon(ThreadContext context,
 Block block)

each_key

public IRubyObject each_key(ThreadContext context,
 Block block)

transform_keys

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

transform_values

public IRubyObject transform_values(ThreadContext context,
 Block block)

transform_keys_bang

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

transform_values_bang

public IRubyObject transform_values_bang(ThreadContext context,
 Block block)

select_bang

public IRubyObject select_bang(ThreadContext context,
 Block block)

keep_if

public IRubyObject keep_if(ThreadContext context,
 Block block)

keep_ifCommon

public boolean keep_ifCommon(ThreadContext context,
 Block block)

key

public IRubyObject key(ThreadContext context,
 IRubyObject expected)

keys

public RubyArray keys(ThreadContext context)

keys

public RubyArray keys()

values

public RubyArray values(ThreadContext context)

rb_values

public RubyArray rb_values(ThreadContext context)

shift

public IRubyObject shift(ThreadContext context)

fastDelete

public boolean fastDelete(IRubyObject key)

delete

public IRubyObject delete(ThreadContext context,
 IRubyObject key,
 Block block)

delete

public IRubyObject delete(IRubyObject key)

delete

public IRubyObject delete(ThreadContext context,
 IRubyObject key)

select

public IRubyObject select(ThreadContext context,
 Block block)

slice

public RubyHash slice(ThreadContext context,
 IRubyObject[] args)

delete_ifInternal

public RubyHash delete_ifInternal(ThreadContext context,
 Block block)

delete_if

public IRubyObject delete_if(ThreadContext context,
 Block block)

rejectInternal

public RubyHash rejectInternal(ThreadContext context,
 Block block)

reject

public IRubyObject reject(ThreadContext context,
 Block block)

reject_bangInternal

public IRubyObject reject_bangInternal(ThreadContext context,
 Block block)

reject_bang

public IRubyObject reject_bang(ThreadContext context,
 Block block)

rb_clear

public RubyHash rb_clear(ThreadContext context)

invert

public RubyHash invert(ThreadContext context)

merge_bang

public RubyHash merge_bang(ThreadContext context,
 IRubyObject[] others,
 Block block)

addAll

public void addAll(ThreadContext context,
 RubyHash otherHash)

merge

public RubyHash merge(ThreadContext context,
 IRubyObject[] others,
 Block block)

initialize_copy

public RubyHash initialize_copy(ThreadContext context,
 IRubyObject other)

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

other - the original

Returns:

a copy unless the same thing

replace

public RubyHash replace(ThreadContext context,
 IRubyObject other)

values_at

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

fetch_values

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

assoc

public IRubyObject assoc(ThreadContext context,
 IRubyObject obj)

rassoc

public IRubyObject rassoc(ThreadContext context,
 IRubyObject obj)

flatten

public IRubyObject flatten(ThreadContext context)

flatten

public IRubyObject flatten(ThreadContext context,
 IRubyObject level)

compact

public IRubyObject compact(ThreadContext context)

compact_bang

public IRubyObject compact_bang(ThreadContext context)

compare_by_identity

public IRubyObject compare_by_identity(ThreadContext context)

compare_by_identity_p

public IRubyObject compare_by_identity_p(ThreadContext context)

dup

public IRubyObject dup(ThreadContext context)

Description copied from interface: IRubyObject

RubyMethod dup.

Specified by:

dup in interface IRubyObject

Parameters:

context - the thread context

Returns:

a dup-ed object

rbClone

public IRubyObject rbClone(ThreadContext context,
 IRubyObject opts)

Overrides:

rbClone in class RubyBasicObject

rbClone

public IRubyObject rbClone(ThreadContext context)

any_p

public IRubyObject any_p(ThreadContext context,
 Block block)

any_p

public IRubyObject any_p(ThreadContext context,
 IRubyObject pattern,
 Block block)

dupFast

public RubyHash dupFast(ThreadContext context)

A lightweight dup for internal use that does not dispatch to initialize_copy nor rehash the keys. Intended for use in dup'ing keyword args for processing.

Parameters:

context -

Returns:

withRuby2Keywords

public RubyHash withRuby2Keywords(boolean ruby2Keywords)

hasDefaultProc

public boolean hasDefaultProc()

getIfNone

public IRubyObject getIfNone()

deconstruct_keys

public IRubyObject deconstruct_keys(ThreadContext context,
 IRubyObject _arg1)

dig

public IRubyObject dig(ThreadContext context,
 IRubyObject arg0)

dig

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

dig

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

dig

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

to_proc

public IRubyObject to_proc(ThreadContext context)

ruby2_keywords_hash

public static IRubyObject ruby2_keywords_hash(ThreadContext context,
 IRubyObject _self,
 IRubyObject arg)

ruby2_keywords_hash_p

public static IRubyObject ruby2_keywords_hash_p(ThreadContext context,
 IRubyObject _self,
 IRubyObject arg)

marshalTo

@Deprecated(since="10.0.0.0",
            forRemoval=true)
public static void marshalTo(RubyHash hash,
 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,
 RubyHash hash,
 MarshalDumper output)

unmarshalFrom

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

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

Throws:

IOException

unmarshalFrom

public static RubyHash unmarshalFrom(ThreadContext context,
 RubyInputStream in,
 MarshalLoader input,
 boolean defaultValue,
 boolean identity)

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

size

public int size()

Specified by:

size in interface Map

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map

get

public Object get(Object key)

Specified by:

get in interface Map

put

public Object put(Object key,
 Object value)

Specified by:

put in interface Map

remove

public Object remove(Object key)

Specified by:

remove in interface Map

putAll

public void putAll(Map map)

Specified by:

putAll in interface Map

clear

public void clear()

Specified by:

clear in interface Map

equals

public boolean equals(Object other)

Description copied from class: RubyObject

This override does not do a "checked" dispatch.

Specified by:

equals in interface Map

Overrides:

equals in class RubyObject

Parameters:

other - object to compare

Returns:

true if equals

See Also:

• RubyBasicObject.equals(Object)

keySet

public Set keySet()

Specified by:

keySet in interface Map

values

public Collection values()

Specified by:

values in interface Map

entrySet

public Set entrySet()

Specified by:

entrySet in interface Map

directKeySet

public Set directKeySet()

directValues

public Collection directValues()

directEntrySet

public Set directEntrySet()

isComparedByIdentity

public boolean isComparedByIdentity()

setComparedByIdentity

public void setComparedByIdentity(boolean comparedByIdentity)

isRuby2KeywordHash

public boolean isRuby2KeywordHash()

setRuby2KeywordHash

public void setRuby2KeywordHash(boolean value)

set

protected void set(int flag,
 boolean set)

get

protected boolean get(int flag)

visitAll

@Deprecated(since="9.1.3.0")
public final void visitAll(RubyHash.Visitor visitor)

Deprecated.