RubyHash (JRuby Core 9.2.5.0 API)

java.lang.Object
- org.jruby.RubyBasicObject
- - org.jruby.RubyObject
  - - org.jruby.RubyHash

All Implemented Interfaces:

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

Direct Known Subclasses:

RubyGlobal.StringOnlyRubyHash, RubySet.DivideTSortHash
```
public class RubyHash
extends RubyObject
implements java.util.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 and Description

static class RubyHash.RubyHashEntry

static class RubyHash.Visitor

static class RubyHash.VisitorWithState<T>
- 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
  java.util.Map.Entry<K,V>

Nested Classes
Modifier and Type	Class and Description
`static class`	`RubyHash.RubyHashEntry`
`static class`	`RubyHash.Visitor`
`static class`	`RubyHash.VisitorWithState<T>`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`COMPARE_BY_IDENTITY_F`
`static int`	`DEFAULT_INSPECT_STR_SIZE`
`static int[]`	`MRI_PRIMES`
`static RubyHash.RubyHashEntry`	`NO_ENTRY`
`protected int`	`size`
`static 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, UNTRUST_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

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

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T> boolean`	`allSymbols()`
`IRubyObject`	`any_p(ThreadContext context, IRubyObject[] args, Block block)`
`IRubyObject`	`aref(IRubyObject key)` Deprecated. use RubyHash.op_aref instead
`IRubyObject`	`aset(IRubyObject key, IRubyObject value)` Deprecated. use RubyHash.op_aset instead
`IRubyObject`	`assoc(ThreadContext context, IRubyObject obj)`
`protected void`	`checkIterating()`
`void`	`clear()`
`IRubyObject`	`compact_bang(ThreadContext context)`
`IRubyObject`	`compact(ThreadContext context)`
`IRubyObject`	`compare_by_identity_p(ThreadContext context)`
`IRubyObject`	`compare_by_identity(ThreadContext context)`
`RubyBoolean`	`compare(ThreadContext context, RubyHash.VisitorWithState<RubyHash> visitor, IRubyObject other)`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.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(Ruby runtime)`
`IRubyObject`	`default_proc()` 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)` rb_hash_set_default
`IRubyObject`	`delete_if(ThreadContext context, Block block)`
`RubyHash`	`delete_ifInternal(ThreadContext context, Block block)` rb_hash_delete_if
`IRubyObject`	`delete(ThreadContext context, IRubyObject key)`
`IRubyObject`	`delete(ThreadContext context, IRubyObject key, Block block)` rb_hash_delete
`IRubyObject`	`dig(ThreadContext context, IRubyObject[] args)`
`java.util.Set`	`directEntrySet()`
`java.util.Set`	`directKeySet()`
`java.util.Collection`	`directValues()`
`IRubyObject`	`dup(ThreadContext context)`
`RubyHash`	`dupFast(ThreadContext context)` A lightweight dup for internal use that does not dispatch to initialize_copy nor rehash the keys.
`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
`IRubyObject`	`each(ThreadContext context, Block block)`
`IRubyObject`	`each19(ThreadContext context, Block block)`
`RubyHash`	`eachCommon(ThreadContext context, Block block)` rb_hash_each
`RubyBoolean`	`empty_p()` rb_hash_empty_p
`java.util.Set`	`entrySet()`
`boolean`	`equals(java.lang.Object other)` This override does not do a "checked" dispatch.
`IRubyObject`	`fastARef(IRubyObject key)`
`void`	`fastASet(IRubyObject key, IRubyObject value)`
`void`	`fastASet(Ruby runtime, IRubyObject key, IRubyObject value, boolean prepareString)`
`void`	`fastASetCheckString(Ruby runtime, IRubyObject key, IRubyObject value)`
`void`	`fastASetCheckString19(Ruby runtime, IRubyObject key, IRubyObject value)` Deprecated.
`void`	`fastASetSmall(IRubyObject key, IRubyObject value)`
`void`	`fastASetSmall(Ruby runtime, IRubyObject key, IRubyObject value, boolean prepareString)`
`void`	`fastASetSmallCheckString(Ruby runtime, IRubyObject key, IRubyObject value)`
`void`	`fastASetSmallCheckString19(Ruby runtime, IRubyObject key, IRubyObject value)` Deprecated.
`boolean`	`fastDelete(IRubyObject key)`
`RubyArray`	`fetch_values(ThreadContext context, IRubyObject[] args, Block block)`
`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)`
`IRubyObject`	`flatten(ThreadContext context)`
`IRubyObject`	`flatten(ThreadContext context, IRubyObject level)`
`java.lang.Object`	`get(java.lang.Object key)`
`IRubyObject`	`getIfNone()`
`java.lang.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)`
`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()` rb_hash_hash
`RubyFixnum`	`hash(ThreadContext context)`
`RubyFixnum`	`hash19()` Deprecated.
`protected int`	`hashValue(IRubyObject key)`
`IRubyObject`	`index(ThreadContext context, IRubyObject expected)` rb_hash_index
`IRubyObject`	`index19(ThreadContext context, IRubyObject expected)` Deprecated.
`RubyHash`	`initialize_copy(ThreadContext context, IRubyObject other)`
`RubyHash`	`initialize_copy19(ThreadContext context, IRubyObject other)` Deprecated.
`IRubyObject`	`initialize(IRubyObject[] args, Block block)` rb_hash_initialize
`IRubyObject`	`inspect()` rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj.
`IRubyObject`	`inspect(ThreadContext context)` rb_hash_inspect
`IRubyObject`	`inspect19(ThreadContext context)` Deprecated.
`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 IRubyObject`	`internalJavaPut(IRubyObject key, IRubyObject value)`
`protected void`	`internalPut(IRubyObject key, IRubyObject value, boolean checkForExisting)`
`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
`protected boolean`	`isComparedByIdentity()` Is this object compared by identity or not? Shortcut for doing getFlag(COMPARE_BY_IDENTITY_F).
`boolean`	`isEmpty()`
`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)` rb_hash_keys
`java.util.Set`	`keySet()`
`static void`	`marshalTo(RubyHash hash, MarshalStream output)`
`RubyHash`	`merge_bang(ThreadContext context, IRubyObject other, Block block)` rb_hash_update
`RubyHash`	`merge_bang19(ThreadContext context, IRubyObject other, Block block)` Deprecated.
`RubyHash`	`merge(ThreadContext context, IRubyObject other, Block block)` rb_hash_merge
`void`	`modify()` rb_hash_modify
`static RubyHash`	`newHash(Ruby runtime)` rb_hash_new
`static RubyHash`	`newHash(Ruby runtime, java.util.Map valueMap, IRubyObject defaultValue)` rb_hash_new
`static RubyHash`	`newKwargs(Ruby runtime, java.lang.String key, IRubyObject value)`
`static 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)` rb_hash_aset
`IRubyObject`	`op_aset19(ThreadContext context, IRubyObject key, IRubyObject value)` Deprecated.
`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_eql19(ThreadContext context, IRubyObject other)` Deprecated.
`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)`
`java.lang.Object`	`put(java.lang.Object key, java.lang.Object value)`
`void`	`putAll(java.util.Map map)`
`IRubyObject`	`rassoc(ThreadContext context, IRubyObject obj)`
`RubyHash`	`rb_clear()` rb_hash_clear
`RubyFixnum`	`rb_size()` rb_hash_size
`RubyArray`	`rb_values()`
`IRubyObject`	`rbClone(ThreadContext context)`
`RubyHash`	`rehash()` rb_hash_rehash
`IRubyObject`	`reject_bang(ThreadContext context, Block block)`
`IRubyObject`	`reject_bangInternal(ThreadContext context, Block block)` rb_hash_reject_bang
`IRubyObject`	`reject(ThreadContext context, Block block)`
`RubyHash`	`rejectInternal(ThreadContext context, Block block)` rb_hash_reject
`java.lang.Object`	`remove(java.lang.Object key)`
`RubyHash`	`replace(ThreadContext context, IRubyObject other)` rb_hash_replace
`RubyHash`	`replace19(ThreadContext context, IRubyObject other)` Deprecated.
`IRubyObject`	`select_bang(ThreadContext context, Block block)`
`IRubyObject`	`select(ThreadContext context, Block block)` rb_hash_select
`IRubyObject`	`select19(ThreadContext context, Block block)` Deprecated.
`IRubyObject`	`set_default_proc(IRubyObject proc)` rb_hash_set_default_proc
`IRubyObject`	`set_default_proc20(IRubyObject proc)` Deprecated.
`void`	`setComparedByIdentity(boolean comparedByIdentity)` Sets whether this object is compared by identity or not.
`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()` rb_hash_to_a
`RubyHash`	`to_h(ThreadContext context)`
`RubyHash`	`to_hash()` rb_hash_to_hash
`IRubyObject`	`to_proc(ThreadContext context)`
`IRubyObject`	`to_s(ThreadContext context)` rb_hash_to_s & to_s_hash
`IRubyObject`	`to_s19(ThreadContext context)`
`IRubyObject`	`transform_keys_bang(ThreadContext context, Block block)`
`IRubyObject`	`transform_keys(ThreadContext context, Block block)`
`IRubyObject`	`transform_values_bang(ThreadContext context, Block block)`
`IRubyObject`	`transform_values(ThreadContext context, Block block)`
`static IRubyObject`	`try_convert(ThreadContext context, IRubyObject recv, IRubyObject args)`
`static RubyHash`	`unmarshalFrom(UnmarshalStream input, boolean defaultValue)`
`RubyArray`	`values_at(ThreadContext context, IRubyObject[] args)` rb_hash_values_at
`java.util.Collection`	`values()`
`RubyArray`	`values(ThreadContext context)` rb_hash_values
`void`	`visitAll(RubyHash.Visitor visitor)` Deprecated.
`<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, createObjectClass, dig, eqlInternal, equalInternal, hashCode, inspect, op_eqq, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject
addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, ensureInstanceVariablesSettable, eql_p, eql, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize_copy, initialize, initialize19, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing, method_missing19, method, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal_19, op_match, op_match19, op_not_equal, op_not_match, op_not, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_method, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_s, toJava, trust, type_deprecated, type, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

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

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 Detail

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,
                java.util.Map valueMap,
                IRubyObject defaultValue)

Method Detail

createHashClass

public static RubyClass createHashClass(Ruby runtime)

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

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,
                                 java.lang.String key,
                                 IRubyObject value)

newHash

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

rb_hash_new

hashValue

protected final int hashValue(IRubyObject key)

checkIterating
```
protected final void checkIterating()
```

internalPut

protected void internalPut(IRubyObject key,
                           IRubyObject value,
                           boolean checkForExisting)

internalJavaPut

protected final IRubyObject internalJavaPut(IRubyObject key,
                                            IRubyObject value)

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.VisitorWithState visitor,
                         T state)

allSymbols
```
public <T> boolean allSymbols()
```

initialize

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

rb_hash_initialize

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(IRubyObject defaultValue)

rb_hash_set_default

default_proc
```
public IRubyObject default_proc()
```
rb_hash_default_proc

set_default_proc

public IRubyObject set_default_proc(IRubyObject proc)

rb_hash_set_default_proc

set_default_proc20

@Deprecated
public IRubyObject set_default_proc20(IRubyObject proc)

Deprecated.

modify
```
public void modify()
```
rb_hash_modify

inspect
```
public IRubyObject inspect()
```
Description copied from class: RubyBasicObject

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

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

Returns:

String

inspect

public IRubyObject inspect(ThreadContext context)

rb_hash_inspect

inspect19

@Deprecated
public IRubyObject inspect19(ThreadContext context)

Deprecated.

rb_size
```
public RubyFixnum rb_size()
```
rb_hash_size

empty_p
```
public RubyBoolean empty_p()
```
rb_hash_empty_p

to_a
```
public RubyArray to_a()
```
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

to_s19

public final IRubyObject to_s19(ThreadContext context)

rehash
```
public RubyHash rehash()
```
rb_hash_rehash

to_hash
```
public RubyHash to_hash()
```
rb_hash_to_hash

to_h

public RubyHash to_h(ThreadContext context)

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)

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)

rb_hash_aset

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)

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_eql19

@Deprecated
public IRubyObject op_eql19(ThreadContext context,
                                        IRubyObject other)

Deprecated.

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()
```
rb_hash_hash

Overrides:

hash in class RubyBasicObject

hash

public RubyFixnum hash(ThreadContext context)

hash19

@Deprecated
public final RubyFixnum hash19()

Deprecated.

fetch

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

rb_hash_fetch

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

public RubyBoolean has_key_p(IRubyObject 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)

each19

public IRubyObject each19(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,
                                  Block block)

transform_values

public IRubyObject transform_values(ThreadContext context,
                                    Block block)

transform_keys_bang

public IRubyObject transform_keys_bang(ThreadContext context,
                                       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.

index

public IRubyObject index(ThreadContext context,
                         IRubyObject expected)

rb_hash_index

index19

@Deprecated
public IRubyObject index19(ThreadContext context,
                                       IRubyObject expected)

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()
```

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(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

select19

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

Deprecated.

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()
```
rb_hash_clear

invert

public RubyHash invert(ThreadContext context)

rb_hash_invert

merge_bang

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

rb_hash_update

merge_bang19

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

Deprecated.

merge

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

rb_hash_merge

initialize_copy

public RubyHash initialize_copy(ThreadContext context,
                                IRubyObject other)

initialize_copy19

@Deprecated
public RubyHash initialize_copy19(ThreadContext context,
                                              IRubyObject other)

Deprecated.

replace

public RubyHash replace(ThreadContext context,
                        IRubyObject other)

rb_hash_replace

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)

rbClone

public IRubyObject rbClone(ThreadContext context)

any_p

public IRubyObject any_p(ThreadContext context,
                         IRubyObject[] args,
                         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:

hasDefaultProc
```
public boolean hasDefaultProc()
```

getIfNone
```
public IRubyObject getIfNone()
```

dig

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

to_proc

public IRubyObject to_proc(ThreadContext context)

marshalTo

public static void marshalTo(RubyHash hash,
                             MarshalStream output)
                      throws java.io.IOException

Throws:: java.io.IOException

unmarshalFrom

public static RubyHash unmarshalFrom(UnmarshalStream input,
                                     boolean defaultValue)
                              throws java.io.IOException

Throws:: java.io.IOException

getJavaClass
```
public java.lang.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 java.util.Map

isEmpty
```
public boolean isEmpty()
```
Specified by:

isEmpty in interface java.util.Map

containsKey
```
public boolean containsKey(java.lang.Object key)
```
Specified by:

containsKey in interface java.util.Map

containsValue
```
public boolean containsValue(java.lang.Object value)
```
Specified by:

containsValue in interface java.util.Map

get

public java.lang.Object get(java.lang.Object key)

Specified by:: get in interface java.util.Map

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

Specified by:: put in interface java.util.Map

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:: remove in interface java.util.Map

putAll
```
public void putAll(java.util.Map map)
```
Specified by:

putAll in interface java.util.Map

clear
```
public void clear()
```
Specified by:

clear in interface java.util.Map

equals
```
public boolean equals(java.lang.Object other)
```
Description copied from class: RubyObject

This override does not do a "checked" dispatch.

Specified by:

equals in interface java.util.Map

Overrides:

equals in class RubyObject

See Also:

RubyBasicObject.equals(Object)

keySet
```
public java.util.Set keySet()
```
Specified by:

keySet in interface java.util.Map

directKeySet
```
public java.util.Set directKeySet()
```

values
```
public java.util.Collection values()
```
Specified by:

values in interface java.util.Map

directValues

public java.util.Collection directValues()

entrySet
```
public java.util.Set entrySet()
```
Specified by:

entrySet in interface java.util.Map

directEntrySet
```
public java.util.Set directEntrySet()
```

isComparedByIdentity
```
protected 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?

op_aset19

@Deprecated
public IRubyObject op_aset19(ThreadContext context,
                                         IRubyObject key,
                                         IRubyObject value)

Deprecated.

aset

public IRubyObject aset(IRubyObject key,
                        IRubyObject value)

Deprecated. use RubyHash.op_aset instead

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

aref
```
public IRubyObject aref(IRubyObject key)
```
Deprecated. use RubyHash.op_aref instead

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

fastASetCheckString19

@Deprecated
public final void fastASetCheckString19(Ruby runtime,
                                                    IRubyObject key,
                                                    IRubyObject value)

Deprecated.

fastASetSmallCheckString19

@Deprecated
public final void fastASetSmallCheckString19(Ruby runtime,
                                                         IRubyObject key,
                                                         IRubyObject value)

Deprecated.

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.

replace19

@Deprecated
public RubyHash replace19(ThreadContext context,
                                      IRubyObject other)

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.

Class RubyHash

Nested Class Summary

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

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

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

Field Summary

Fields inherited from class org.jruby.RubyObject

Fields inherited from class org.jruby.RubyBasicObject

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

Constructor Summary

Method Summary

Methods inherited from class org.jruby.RubyObject

Methods inherited from class org.jruby.RubyBasicObject

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

DEFAULT_INSPECT_STR_SIZE

COMPARE_BY_IDENTITY_F

size

MRI_PRIMES

NO_ENTRY

StoreValueVisitor

Constructor Detail

RubyHash

RubyHash

RubyHash

RubyHash

RubyHash

RubyHash

RubyHash

Method Detail

createHashClass

getNativeClassIndex

create

try_convert

newHash

newSmallHash

newKwargs

newHash

hashValue

checkIterating

internalPut

internalJavaPut

internalPutNoResize

internalGet

internalGetEntry

internalDelete

internalDeleteEntry

visitAll

allSymbols

initialize

default_value_get

default_value_get

default_value_set

default_proc

set_default_proc

set_default_proc20

modify

inspect

inspect

inspect19

rb_size

empty_p

to_a

to_s

to_s19

rehash

to_hash

to_h

convertToHash

fastASet

fastASetSmall

fastASetCheckString

fastASetSmallCheckString

fastASet

fastASetSmall

op_aset

op_asetForString

op_asetSmallForString

fastARef