Package org.jruby

Class RubyStruct

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyStruct

All Implemented Interfaces:

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

public class RubyStruct
extends RubyObject

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RubyStruct.Accessor
static class	RubyStruct.Mutator
static class	RubyStruct.StructMethods

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

RubyObject.Data

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

RubyBasicObject.Finalizer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IDENTIFIER_NEEDS_TO_BE_CONSTANT
static final String	MEMBER_VAR
static final String	NO_MEMBER_IN_STRUCT
static final String	UNINITIALIZED_CONSTANT

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, 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

Constructor	Description
RubyStruct(ThreadContext context, RubyClass rubyClass)

Method Summary

Modifier and Type	Method	Description
IRubyObject	aref(IRubyObject key)	Deprecated.
IRubyObject	aref(ThreadContext context, IRubyObject key)
IRubyObject	aset(IRubyObject key, IRubyObject value)	Deprecated.
IRubyObject	aset(ThreadContext context, IRubyObject key, IRubyObject value)
RubyBoolean	compare(ThreadContext context, CallSite site, IRubyObject other)
void	copySpecialInstanceVariables(IRubyObject clone)	Lots of MRI objects keep their state in non-lookupable ivars (e:g.
static RubyClass	createStructClass(ThreadContext context, RubyClass Object, RubyModule Enumerable)
IRubyObject	deconstruct_keys(ThreadContext context, IRubyObject keysArg)
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)
IRubyObject	each(ThreadContext context, Block block)
IRubyObject	each_pair(ThreadContext context, Block block)
IRubyObject	each_pairInternal(ThreadContext context, Block block)
IRubyObject	eachInternal(ThreadContext context, Block block)
IRubyObject	eql_p(ThreadContext context, IRubyObject other)
final IRubyObject	get(int index)
ClassIndex	getNativeClassIndex()	This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
RubyFixnum	hash(ThreadContext context)	Will return the hash code of this object.
IRubyObject	initialize(ThreadContext context)
IRubyObject	initialize(ThreadContext context, IRubyObject arg0)
IRubyObject	initialize(ThreadContext context, IRubyObject[] args)
IRubyObject	initialize(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	initialize(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
IRubyObject	initialize_copy(ThreadContext context, IRubyObject arg)	Initializes this object as a copy of the original, that is the parameter to this object.
IRubyObject	initializeInternal(ThreadContext context, int provided, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
RubyString	inspect(ThreadContext context)	Returns a string containing a human-readable representation of obj.
static void	marshalTo(RubyStruct struct, MarshalStream output)	Deprecated, for removal: This API element is subject to removal in a future version.
static void	marshalTo(ThreadContext context, RubyOutputStream out, RubyStruct struct, MarshalDumper output)
RubyArray	members()	Deprecated.
static RubyArray	members(IRubyObject recv, Block block)	Deprecated.
RubyArray	members(ThreadContext context)
static RubyClass	newInstance(IRubyObject recv, IRubyObject[] args, Block block)	Deprecated.
static RubyClass	newInstance(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)	Create new Struct class.
static RubyStruct	newStruct(IRubyObject recv, Block block)	Deprecated. Use Create.newStruct(ThreadContext, RubyClass, Block) instead.
static RubyStruct	newStruct(IRubyObject recv, IRubyObject[] args, Block block)	Deprecated. Use Create.newStruct(ThreadContext, RubyClass, IRubyObject[], Block) instead.
static RubyStruct	newStruct(IRubyObject recv, IRubyObject arg0, Block block)	Deprecated. Use Create.newStruct(ThreadContext, RubyClass, IRubyObject, Block) instead.
static RubyStruct	newStruct(IRubyObject recv, IRubyObject arg0, IRubyObject arg1, Block block)	Deprecated. Use Create.newStruct(ThreadContext, RubyClass, IRubyObject, IRubyObject, Block) instead.
static RubyStruct	newStruct(IRubyObject recv, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)	Deprecated. Use Create.newStruct(ThreadContext, RubyClass, IRubyObject, IRubyObject, IRubyObject, Block) instead.
IRubyObject	op_equal(ThreadContext context, IRubyObject other)	rb_obj_equal Will by default use identity equality to compare objects.
IRubyObject	select(ThreadContext context, Block block)
IRubyObject	set(IRubyObject value, int index)	Deprecated.
RubyFixnum	size()	Deprecated.
RubyFixnum	size(ThreadContext context)
RubyArray	to_a()	Deprecated.
RubyArray	to_a(ThreadContext context)
RubyHash	to_h(ThreadContext context)	Deprecated.
RubyHash	to_h(ThreadContext context, Block block)
static IRubyObject	unmarshalFrom(UnmarshalStream input)	Deprecated, for removal: This API element is subject to removal in a future version.
static IRubyObject	unmarshalFrom(ThreadContext context, RubyInputStream in, MarshalLoader input)
IRubyObject	values_at(IRubyObject[] args)	Deprecated.
IRubyObject	values_at(ThreadContext context, IRubyObject[] args)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, dig, dig1, dig2, eqlInternal, equalInternal, equals, 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, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql, 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, getJavaClass, 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_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, 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, 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, dup, marshalLiveVariables

Field Details

NO_MEMBER_IN_STRUCT

public static final String NO_MEMBER_IN_STRUCT

See Also:

• Constant Field Values

IDENTIFIER_NEEDS_TO_BE_CONSTANT

public static final String IDENTIFIER_NEEDS_TO_BE_CONSTANT

See Also:

• Constant Field Values

UNINITIALIZED_CONSTANT

public static final String UNINITIALIZED_CONSTANT

See Also:

• Constant Field Values

MEMBER_VAR

public static final String MEMBER_VAR

See Also:

• Constant Field Values

Constructor Details

RubyStruct

public RubyStruct(ThreadContext context,
 RubyClass rubyClass)

Method Details

createStructClass

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

deconstruct_keys

public IRubyObject deconstruct_keys(ThreadContext context,
 IRubyObject keysArg)

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

newInstance

@Deprecated
public static RubyClass newInstance(IRubyObject recv,
 IRubyObject[] args,
 Block block)

Deprecated.

newInstance

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

Create new Struct class. MRI: rb_struct_s_def / make_struct

newStruct

@Deprecated(since="10.0")
public static RubyStruct newStruct(IRubyObject recv,
 IRubyObject[] args,
 Block block)

Deprecated.

Use Create.newStruct(ThreadContext, RubyClass, IRubyObject[], Block) instead.

Create new Structure. MRI: struct_alloc

newStruct

@Deprecated(since="10.0")
public static RubyStruct newStruct(IRubyObject recv,
 Block block)

Deprecated.

Use Create.newStruct(ThreadContext, RubyClass, Block) instead.

Parameters:

recv -

block -

Returns:

newStruct

@Deprecated(since="10.0")
public static RubyStruct newStruct(IRubyObject recv,
 IRubyObject arg0,
 Block block)

Deprecated.

Use Create.newStruct(ThreadContext, RubyClass, IRubyObject, Block) instead.

Parameters:

recv -

arg0 -

block -

Returns:

newStruct

@Deprecated(since="10.0")
public static RubyStruct newStruct(IRubyObject recv,
 IRubyObject arg0,
 IRubyObject arg1,
 Block block)

Deprecated.

Use Create.newStruct(ThreadContext, RubyClass, IRubyObject, IRubyObject, Block) instead.

Parameters:

recv -

arg0 -

arg1 -

block -

Returns:

newStruct

@Deprecated(since="10.0")
public static RubyStruct newStruct(IRubyObject recv,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2,
 Block block)

Deprecated.

Use Create.newStruct(ThreadContext, RubyClass, IRubyObject, IRubyObject, IRubyObject, Block) instead.

Parameters:

recv -

arg0 -

arg1 -

arg2 -

block -

Returns:

initialize

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

initialize

public IRubyObject initialize(ThreadContext context)

Overrides:

initialize in class RubyBasicObject

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject arg0)

initialize

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

initialize

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

initializeInternal

public IRubyObject initializeInternal(ThreadContext context,
 int provided,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

members

@Deprecated(since="9.4-")
public static RubyArray members(IRubyObject recv,
 Block block)

Deprecated.

members

@Deprecated(since="10.0")
public RubyArray members()

Deprecated.

members

public RubyArray members(ThreadContext context)

select

public IRubyObject select(ThreadContext context,
 Block block)

set

@Deprecated(since="10.0")
public IRubyObject set(IRubyObject value,
 int index)

Deprecated.

get

public final IRubyObject get(int index)

copySpecialInstanceVariables

public void copySpecialInstanceVariables(IRubyObject clone)

Description copied from class: RubyBasicObject

Lots of MRI objects keep their state in non-lookupable ivars (e:g. Range, Struct, etc). This method is responsible for dupping our java field equivalents

Specified by:

copySpecialInstanceVariables in interface IRubyObject

Overrides:

copySpecialInstanceVariables in class RubyBasicObject

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

eql_p

public IRubyObject eql_p(ThreadContext context,
 IRubyObject other)

Overrides:

eql_p in class RubyBasicObject

compare

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

inspect

public RubyString inspect(ThreadContext context)

Description copied from class: RubyBasicObject

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

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

to_a

public RubyArray to_a(ThreadContext context)

Overrides:

to_a in class RubyBasicObject

to_h

@Deprecated
public RubyHash to_h(ThreadContext context)

Deprecated.

to_h

public RubyHash to_h(ThreadContext context,
 Block block)

size

public RubyFixnum size(ThreadContext context)

size

@Deprecated
public RubyFixnum size()

Deprecated.

eachInternal

public IRubyObject eachInternal(ThreadContext context,
 Block block)

each

public IRubyObject each(ThreadContext context,
 Block block)

each_pairInternal

public IRubyObject each_pairInternal(ThreadContext context,
 Block block)

each_pair

public IRubyObject each_pair(ThreadContext context,
 Block block)

aref

@Deprecated(since="10.0")
public IRubyObject aref(IRubyObject key)

Deprecated.

aref

public IRubyObject aref(ThreadContext context,
 IRubyObject key)

aset

@Deprecated(since="10.0")
public IRubyObject aset(IRubyObject key,
 IRubyObject value)

Deprecated.

aset

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

values_at

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

Deprecated.

values_at

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

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)

marshalTo

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

unmarshalFrom

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

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

Throws:

IOException

unmarshalFrom

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

initialize_copy

public IRubyObject initialize_copy(ThreadContext context,
 IRubyObject arg)

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

arg - the original

Returns:

a copy unless the same thing

to_a

@Deprecated(since="9.4-")
public RubyArray to_a()

Deprecated.

Overrides:

to_a in class RubyBasicObject