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:

RubyGlobal.StringOnlyRubyHash, RubySet.DivideTSortHash

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
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
static final int	COMPARE_BY_IDENTITY_F
static final int	DEFAULT_INSPECT_STR_SIZE
static final int[]	MRI_PRIMES
static final RubyHash.RubyHashEntry	NO_ENTRY
static final int	RUBY2_KEYWORD_F
protected int	size
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, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

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

NULL_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
	RubyHash(Ruby runtime)
	RubyHash(Ruby runtime, int buckets)
	RubyHash(Ruby runtime, Map valueMap, IRubyObject defaultValue)
	RubyHash(Ruby runtime, RubyClass klass)
protected	RubyHash(Ruby runtime, RubyClass metaClass, IRubyObject defaultValue, RubyHash.RubyHashEntry[] initialTable, int threshold)
	RubyHash(Ruby runtime, IRubyObject defaultValue)
	RubyHash(Ruby runtime, IRubyObject defaultValue, int buckets)

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[] args, Block block)	Deprecated.
IRubyObject	any_p(ThreadContext context, IRubyObject pattern, Block block)
protected IRubyObject	any_p_i(ThreadContext context, Block block)
protected IRubyObject	any_p_i_fast(ThreadContext context, Block block)
protected IRubyObject	any_p_p(ThreadContext context, IRubyObject pattern)
protected void	appendAssociation(boolean keyIsSymbol, ByteList bytes)	Append appropriate characters to indicate association (": " vs " => ").
IRubyObject	aref(IRubyObject key)	Deprecated, for removal: This API element is subject to removal in a future version. use RubyHash.op_aref instead
IRubyObject	aset(IRubyObject key, IRubyObject value)	Deprecated, for removal: This API element is subject to removal in a future version. use RubyHash.op_aset instead
IRubyObject	assoc(ThreadContext context, IRubyObject obj)
protected final void	checkIterating()
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()	Deprecated.
IRubyObject	default_proc(ThreadContext context)	rb_hash_default_proc
IRubyObject	default_value_get(ThreadContext context)
IRubyObject	default_value_get(ThreadContext context, IRubyObject arg)
IRubyObject	default_value_get(ThreadContext context, IRubyObject[] args)	Deprecated.
IRubyObject	default_value_set(IRubyObject defaultValue)	Deprecated.
IRubyObject	default_value_set(ThreadContext context, IRubyObject defaultValue)	rb_hash_set_default
IRubyObject	delete(IRubyObject key)	Delete entry or null.
IRubyObject	delete(ThreadContext context, IRubyObject key)
IRubyObject	delete(ThreadContext context, IRubyObject key, Block block)	rb_hash_delete
IRubyObject	delete_if(ThreadContext context, Block block)
RubyHash	delete_ifInternal(ThreadContext context, Block block)	rb_hash_delete_if
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)	rb_hash_each_key
IRubyObject	each_pair(ThreadContext context, Block block)	Deprecated.
RubyHash	each_pairCommon(ThreadContext context, Block block)	rb_hash_each_pair
RubyHash	each_pairCommon(ThreadContext context, Block block, boolean oneNine)	Deprecated.
IRubyObject	each_value(ThreadContext context, Block block)
RubyHash	each_valueCommon(ThreadContext context, Block block)	rb_hash_each_value
RubyHash	eachCommon(ThreadContext context, Block block)	rb_hash_each
RubyBoolean	empty_p()	Deprecated.
RubyBoolean	empty_p(ThreadContext context)	rb_hash_empty_p
Set	entrySet()
boolean	equals(Object other)	This override does not do a "checked" dispatch.
IRubyObject	except(ThreadContext context, IRubyObject[] keys)
final IRubyObject	fastARef(IRubyObject key)
final void	fastASet(Ruby runtime, IRubyObject key, IRubyObject value, boolean prepareString)
final void	fastASet(IRubyObject key, IRubyObject value)
final void	fastASetCheckString(Ruby runtime, IRubyObject key, IRubyObject value)
final void	fastASetSmall(Ruby runtime, IRubyObject key, IRubyObject value, boolean prepareString)
final void	fastASetSmall(IRubyObject key, IRubyObject value)
final void	fastASetSmallCheckString(Ruby runtime, IRubyObject key, IRubyObject value)
final void	fastASetSmallPair(ThreadContext context, IRubyObject _pair)
final boolean	fastDelete(IRubyObject key)
IRubyObject	fetch(ThreadContext context, IRubyObject[] args, Block block)	rb_hash_fetch
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)
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(IRubyObject key)	Deprecated.
RubyBoolean	has_key_p(ThreadContext context, IRubyObject key)	rb_hash_has_key
RubyBoolean	has_value_p(ThreadContext context, IRubyObject expected)	rb_hash_has_value
boolean	hasDefaultProc()
RubyFixnum	hash(ThreadContext context)	Will return the hash code of this object.
protected final int	hashValue(IRubyObject key)
boolean	hasKey(IRubyObject key)	A Java API to test the presence of a (Ruby) key in the Hash
IRubyObject	initialize(IRubyObject[] args, Block block)	Deprecated.
IRubyObject	initialize(ThreadContext context, Block block)	rb_hash_initialize
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)	rb_hash_inspect
protected RubyString	inspectHash(ThreadContext context)	inspect_hash
protected RubyHash.RubyHashEntry	internalDelete(IRubyObject key)
protected RubyHash.RubyHashEntry	internalDeleteEntry(RubyHash.RubyHashEntry entry)
protected IRubyObject	internalGet(IRubyObject key)
protected RubyHash.RubyHashEntry	internalGetEntry(IRubyObject key)
protected final IRubyObject	internalJavaPut(IRubyObject key, IRubyObject value)	Deprecated.
IRubyObject	internalPut(IRubyObject key, IRubyObject value)
protected IRubyObject	internalPutNoResize(IRubyObject key, IRubyObject value, boolean checkForExisting)
protected void	internalPutSmall(IRubyObject key, IRubyObject value, boolean checkForExisting)	Deprecated.
RubyHash	invert(ThreadContext context)	rb_hash_invert
boolean	isComparedByIdentity()	Is this object compared by identity or not? Shortcut for doing getFlag(COMPARE_BY_IDENTITY_F).
boolean	isEmpty()
boolean	isRuby2KeywordHash()
IRubyObject	keep_if(ThreadContext context, Block block)
boolean	keep_ifCommon(ThreadContext context, Block block)
IRubyObject	key(ThreadContext context, IRubyObject expected)
final RubyArray	keys()
RubyArray	keys(ThreadContext context)	rb_hash_keys
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)	rb_hash_merge
RubyHash	merge(ThreadContext context, IRubyObject other, Block block)	Deprecated.
RubyHash	merge_bang(ThreadContext context, IRubyObject[] others, Block block)	rb_hash_update
RubyHash	merge_bang(ThreadContext context, IRubyObject other, Block block)	Deprecated.
void	modify()	rb_hash_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)	rb_hash_aref
IRubyObject	op_aset(IRubyObject key, IRubyObject value)	Deprecated.
IRubyObject	op_aset(ThreadContext context, IRubyObject key, IRubyObject value)	Set a key/value pair into this hash.
protected void	op_asetForString(Ruby runtime, RubyString key, IRubyObject value)
protected void	op_asetSmallForString(Ruby runtime, RubyString key, IRubyObject value)
IRubyObject	op_eql(ThreadContext context, IRubyObject other)	rb_hash_eql
IRubyObject	op_equal(ThreadContext context, IRubyObject other)	rb_hash_equal
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()	Deprecated.
RubyHash	rb_clear(ThreadContext context)	rb_hash_clear
RubyFixnum	rb_size()	Deprecated.
RubyFixnum	rb_size(ThreadContext context)	rb_hash_size
final RubyArray	rb_values()	Deprecated.
final RubyArray	rb_values(ThreadContext context)
IRubyObject	rbClone(ThreadContext context)
IRubyObject	rbClone(ThreadContext context, IRubyObject opts)
RubyHash	rehash()	Deprecated.
RubyHash	rehash(ThreadContext context)	rb_hash_rehash
IRubyObject	reject(ThreadContext context, Block block)
IRubyObject	reject_bang(ThreadContext context, Block block)
IRubyObject	reject_bangInternal(ThreadContext context, Block block)	rb_hash_reject_bang
RubyHash	rejectInternal(ThreadContext context, Block block)	rb_hash_reject
Object	remove(Object key)
RubyHash	replace(ThreadContext context, IRubyObject other)	rb_hash_replace
protected void	replaceExternally(ThreadContext context, RubyHash otherHash)
protected void	replaceWith(ThreadContext context, RubyHash otherHash)
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)	rb_hash_select
IRubyObject	select_bang(ThreadContext context, Block block)
IRubyObject	set_default_proc(IRubyObject proc)	Deprecated.
IRubyObject	set_default_proc(ThreadContext context, IRubyObject proc)	rb_hash_set_default_proc
void	setComparedByIdentity(boolean comparedByIdentity)	Sets whether this object is compared by identity or not.
void	setRuby2KeywordHash(boolean value)
IRubyObject	shift(ThreadContext context)	rb_hash_shift
int	size()
RubyHash	slice(ThreadContext context, IRubyObject[] args)	rb_hash_slice
IRubyObject	sort(ThreadContext context, Block block)	Deprecated.
RubyArray	to_a()	Deprecated.
RubyArray	to_a(ThreadContext context)	rb_hash_to_a
RubyHash	to_h(ThreadContext context)	Deprecated.
RubyHash	to_h(ThreadContext context, Block block)
protected RubyHash	to_h_block(ThreadContext context, Block block)
RubyHash	to_hash()	Deprecated.
RubyHash	to_hash(ThreadContext context)	rb_hash_to_hash
IRubyObject	to_proc(ThreadContext context)
IRubyObject	to_s(ThreadContext context)	rb_hash_to_s & to_s_hash
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)
Collection	values()
RubyArray	values(ThreadContext context)	rb_hash_values
RubyArray	values_at(ThreadContext context, IRubyObject[] args)	rb_hash_values_at
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)

Methods inherited from class org.jruby.RubyObject

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

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, compareTo, convertToArray, convertToFloat, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql, eql_p, eql_p, equal_p, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, freeze, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getMarshalVariableList, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, 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, isUntrusted, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, methods, nil_p, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_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, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, singletonClass, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_s, toJava, trust, type, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

checkStringType19, 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

COMPARE_BY_IDENTITY_F

public static final int COMPARE_BY_IDENTITY_F

RUBY2_KEYWORD_F

public static final int RUBY2_KEYWORD_F

size

protected int size

MRI_PRIMES

public static final int[] MRI_PRIMES

NO_ENTRY

public static final RubyHash.RubyHashEntry NO_ENTRY

StoreValueVisitor

public static final RubyHash.VisitorWithState<RubyArray> StoreValueVisitor

Constructor Details

RubyHash

public RubyHash(Ruby runtime,
 RubyClass klass)

RubyHash

public RubyHash(Ruby runtime,
 int buckets)

RubyHash

public RubyHash(Ruby runtime)

RubyHash

public RubyHash(Ruby runtime,
 IRubyObject defaultValue)

RubyHash

public RubyHash(Ruby runtime,
 IRubyObject defaultValue,
 int buckets)

RubyHash

protected RubyHash(Ruby runtime,
 RubyClass metaClass,
 IRubyObject defaultValue,
 RubyHash.RubyHashEntry[] initialTable,
 int threshold)

RubyHash

public RubyHash(Ruby runtime,
 Map valueMap,
 IRubyObject defaultValue)

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

hashValue

protected final int hashValue(IRubyObject key)

checkIterating

protected final void checkIterating()

internalPut

public IRubyObject internalPut(IRubyObject key,
 IRubyObject value)

internalJavaPut

@Deprecated
protected final IRubyObject internalJavaPut(IRubyObject key,
 IRubyObject value)

Deprecated.

internalPutNoResize

protected IRubyObject internalPutNoResize(IRubyObject key,
 IRubyObject value,
 boolean checkForExisting)

internalGet

protected IRubyObject internalGet(IRubyObject key)

internalGetEntry

protected RubyHash.RubyHashEntry internalGetEntry(IRubyObject key)

internalDelete

protected RubyHash.RubyHashEntry internalDelete(IRubyObject key)

internalDeleteEntry

protected RubyHash.RubyHashEntry internalDeleteEntry(RubyHash.RubyHashEntry entry)

visitAll

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

visitAll

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

allSymbols

public <T> boolean allSymbols()

initialize

public IRubyObject initialize(ThreadContext context,
 Block block)

rb_hash_initialize

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)

rb_hash_set_default

default_proc

public IRubyObject default_proc(ThreadContext context)

rb_hash_default_proc

set_default_proc

public IRubyObject set_default_proc(ThreadContext context,
 IRubyObject proc)

rb_hash_set_default_proc

modify

public void modify()

rb_hash_modify

inspectHash

protected RubyString inspectHash(ThreadContext context)

inspect_hash

appendAssociation

protected void appendAssociation(boolean keyIsSymbol,
 ByteList bytes)

Append appropriate characters to indicate association (": " vs " => ").

Parameters:

keyIsSymbol - is the key a symbol

bytes - buffer to which to append

inspect

public IRubyObject inspect(ThreadContext context)

rb_hash_inspect

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

rb_size

public RubyFixnum rb_size(ThreadContext context)

rb_hash_size

empty_p

public RubyBoolean empty_p(ThreadContext context)

rb_hash_empty_p

to_a

public RubyArray to_a(ThreadContext context)

rb_hash_to_a

Overrides:

to_a in class RubyBasicObject

to_s

public IRubyObject to_s(ThreadContext context)

rb_hash_to_s & to_s_hash

Overrides:

to_s in class RubyBasicObject

rehash

public RubyHash rehash(ThreadContext context)

rb_hash_rehash

to_hash

public RubyHash to_hash(ThreadContext context)

rb_hash_to_hash

to_h

@Deprecated
public RubyHash to_h(ThreadContext context)

Deprecated.

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 final void fastASet(IRubyObject key,
 IRubyObject value)

fastASetSmall

public final void fastASetSmall(IRubyObject key,
 IRubyObject value)

fastASetSmallPair

public final void fastASetSmallPair(ThreadContext context,
 IRubyObject _pair)

fastASetCheckString

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

fastASetSmallCheckString

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

fastASet

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

fastASetSmall

public final 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

op_asetForString

protected void op_asetForString(Ruby runtime,
 RubyString key,
 IRubyObject value)

op_asetSmallForString

protected void op_asetSmallForString(Ruby runtime,
 RubyString key,
 IRubyObject value)

fastARef

public final 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)

rb_hash_equal

Specified by:

op_equal in interface IRubyObject

Overrides:

op_equal in class RubyBasicObject

op_eql

public IRubyObject op_eql(ThreadContext context,
 IRubyObject other)

rb_hash_eql

op_aref

public IRubyObject op_aref(ThreadContext context,
 IRubyObject key)

rb_hash_aref

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)

rb_hash_fetch

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)

rb_hash_has_key

has_key_p

@Deprecated
public RubyBoolean has_key_p(IRubyObject key)

Deprecated.

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)

rb_hash_has_value

eachCommon

public RubyHash eachCommon(ThreadContext context,
 Block block)

rb_hash_each

each

public IRubyObject each(ThreadContext context,
 Block block)

each_pairCommon

public RubyHash each_pairCommon(ThreadContext context,
 Block block)

rb_hash_each_pair

each_valueCommon

public RubyHash each_valueCommon(ThreadContext context,
 Block block)

rb_hash_each_value

each_value

public IRubyObject each_value(ThreadContext context,
 Block block)

each_keyCommon

public RubyHash each_keyCommon(ThreadContext context,
 Block block)

rb_hash_each_key

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)

sort

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

Deprecated.

key

public IRubyObject key(ThreadContext context,
 IRubyObject expected)

keys

public RubyArray keys(ThreadContext context)

rb_hash_keys

keys

public final RubyArray keys()

values

public RubyArray values(ThreadContext context)

rb_hash_values

rb_values

public final RubyArray rb_values(ThreadContext context)

shift

public IRubyObject shift(ThreadContext context)

rb_hash_shift

fastDelete

public final boolean fastDelete(IRubyObject key)

delete

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

rb_hash_delete

delete

public IRubyObject delete(IRubyObject key)

Delete entry or null.

delete

public IRubyObject delete(ThreadContext context,
 IRubyObject key)

select

public IRubyObject select(ThreadContext context,
 Block block)

rb_hash_select

slice

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

rb_hash_slice

delete_ifInternal

public RubyHash delete_ifInternal(ThreadContext context,
 Block block)

rb_hash_delete_if

delete_if

public IRubyObject delete_if(ThreadContext context,
 Block block)

rejectInternal

public RubyHash rejectInternal(ThreadContext context,
 Block block)

rb_hash_reject

reject

public IRubyObject reject(ThreadContext context,
 Block block)

reject_bangInternal

public IRubyObject reject_bangInternal(ThreadContext context,
 Block block)

rb_hash_reject_bang

reject_bang

public IRubyObject reject_bang(ThreadContext context,
 Block block)

rb_clear

public RubyHash rb_clear(ThreadContext context)

rb_hash_clear

invert

public RubyHash invert(ThreadContext context)

rb_hash_invert

merge_bang

@Deprecated
public RubyHash merge_bang(ThreadContext context,
 IRubyObject other,
 Block block)

Deprecated.

merge_bang

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

rb_hash_update

addAll

public void addAll(ThreadContext context,
 RubyHash otherHash)

merge

@Deprecated
public RubyHash merge(ThreadContext context,
 IRubyObject other,
 Block block)

Deprecated.

merge

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

rb_hash_merge

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)

rb_hash_replace

replaceWith

protected void replaceWith(ThreadContext context,
 RubyHash otherHash)

replaceExternally

protected void replaceExternally(ThreadContext context,
 RubyHash otherHash)

values_at

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

rb_hash_values_at

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)

any_p_i

protected IRubyObject any_p_i(ThreadContext context,
 Block block)

any_p_i_fast

protected IRubyObject any_p_i_fast(ThreadContext context,
 Block block)

any_p_p

protected IRubyObject any_p_p(ThreadContext context,
 IRubyObject pattern)

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:

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",
            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",
            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)

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

directKeySet

public Set directKeySet()

values

public Collection values()

Specified by:

values in interface Map

directValues

public Collection directValues()

entrySet

public Set entrySet()

Specified by:

entrySet in interface Map

directEntrySet

public Set directEntrySet()

isComparedByIdentity

public boolean isComparedByIdentity()

Is this object compared by identity or not? Shortcut for doing getFlag(COMPARE_BY_IDENTITY_F).

Returns:

true if this object is compared by identity, false otherwise

setComparedByIdentity

public void setComparedByIdentity(boolean comparedByIdentity)

Sets whether this object is compared by identity or not. Shortcut for doing setFlag(COMPARE_BY_IDENTITY_F, frozen).

Parameters:

comparedByIdentity - should this object be compared by identity?

isRuby2KeywordHash

public boolean isRuby2KeywordHash()

setRuby2KeywordHash

public void setRuby2KeywordHash(boolean value)

aset

@Deprecated(forRemoval=true)
public IRubyObject aset(IRubyObject key,
 IRubyObject value)

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

use RubyHash.op_aset instead

Note: this is included as a compatibility measure for AR-JDBC

aref

@Deprecated(forRemoval=true)
public IRubyObject aref(IRubyObject key)

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

use RubyHash.op_aref instead

Note: this is included as a compatibility measure for Mongrel+JRuby

op_aset

@Deprecated
public IRubyObject op_aset(IRubyObject key,
 IRubyObject value)

Deprecated.

each_pair

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

Deprecated.

each_pairCommon

@Deprecated
public RubyHash each_pairCommon(ThreadContext context,
 Block block,
 boolean oneNine)

Deprecated.

visitAll

@Deprecated
public final void visitAll(RubyHash.Visitor visitor)

Deprecated.

default_value_get

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

Deprecated.

rb_hash_default

internalPutSmall

@Deprecated
protected void internalPutSmall(IRubyObject key,
 IRubyObject value,
 boolean checkForExisting)

Deprecated.

to_a

@Deprecated
public RubyArray to_a()

Deprecated.

Overrides:

to_a in class RubyBasicObject

default_value_set

@Deprecated
public IRubyObject default_value_set(IRubyObject defaultValue)

Deprecated.

default_proc

@Deprecated
public IRubyObject default_proc()

Deprecated.

set_default_proc

@Deprecated
public IRubyObject set_default_proc(IRubyObject proc)

Deprecated.

rb_size

@Deprecated
public RubyFixnum rb_size()

Deprecated.

empty_p

@Deprecated
public RubyBoolean empty_p()

Deprecated.

rehash

@Deprecated
public RubyHash rehash()

Deprecated.

to_hash

@Deprecated
public RubyHash to_hash()

Deprecated.

rb_values

@Deprecated
public final RubyArray rb_values()

Deprecated.

rb_clear

@Deprecated
public RubyHash rb_clear()

Deprecated.

any_p

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

Deprecated.

initialize

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

Deprecated.