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
private static class	RubyStruct.EqlRecursive
private static class	RubyStruct.EqualRecursive
private static class	RubyStruct.HashRecursive
private static class	RubyStruct.InspectRecursive
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
private static final String	KEYWORD_INIT_VAR
static final String	MEMBER_VAR
static final String	NO_MEMBER_IN_STRUCT
private static final String	SIZE_VAR
private static final byte[]	STRUCT_BEG
private static final byte[]	STRUCT_END
static final String	UNINITIALIZED_CONSTANT
private final IRubyObject[]	values

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, 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	Description
private	RubyStruct(Ruby runtime, RubyClass rubyClass)	Constructor for RubyStruct.

Method Summary

Modifier and Type	Method	Description
private RubyArray	__member__()
private static RubyArray	__member__(RubyClass clazz)
(package private) final IRubyObject	aref(int idx)
IRubyObject	aref(IRubyObject key)
private IRubyObject	arefImpl(IRubyObject key, boolean nilOnNoMember)
private IRubyObject	aset(int idx, IRubyObject value)
IRubyObject	aset(IRubyObject key, IRubyObject value)
private void	checkSize(int length)
private RubyClass	classOf()
void	copySpecialInstanceVariables(IRubyObject clone)	Lots of MRI objects keep their state in non-lookupable ivars (e:g.
static RubyClass	createStructClass(Ruby runtime)
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)
private IRubyObject	getByName(String name)
private static IRubyObject	getInternalVariable(RubyClass type, String internedName)
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)
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(IRubyObject arg)	rb_obj_init_copy 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)
private RubyString	inspectStruct(ThreadContext context, boolean recur)	inspect_struct
static void	marshalTo(RubyStruct struct, MarshalStream output)
RubyArray	members()
(package private) static RubyArray	members(RubyClass type)
static RubyArray	members(IRubyObject recv, Block block)	Deprecated.
final RubyArray	members19()	Deprecated.
static RubyArray	members19(IRubyObject recv, Block block)	Deprecated.
private void	modify()
static RubyClass	newInstance(IRubyObject recv, IRubyObject[] args, Block block)	Create new Struct class.
static RubyStruct	newStruct(IRubyObject recv, Block block)
static RubyStruct	newStruct(IRubyObject recv, IRubyObject[] args, Block block)	Create new Structure.
static RubyStruct	newStruct(IRubyObject recv, IRubyObject arg0, Block block)
static RubyStruct	newStruct(IRubyObject recv, IRubyObject arg0, IRubyObject arg1, Block block)
static RubyStruct	newStruct(IRubyObject recv, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)
private RaiseException	notStructMemberError(IRubyObject name)
IRubyObject	op_equal(ThreadContext context, IRubyObject other)	rb_obj_equal Will by default use identity equality to compare objects.
private static RubyClass	pathToClass(Ruby runtime, String path)
IRubyObject	select(ThreadContext context, Block block)
IRubyObject	set(IRubyObject value, int index)
private IRubyObject	setByName(String name, IRubyObject value)
private void	setupStructValuesFromHash(ThreadContext context, RubyHash kwArgs)
RubyFixnum	size()
private static IRubyObject	size(ThreadContext context, RubyStruct recv, IRubyObject[] args)	A size method suitable for lambda method reference implementation of RubyEnumerator.SizeFn.size(ThreadContext, IRubyObject, IRubyObject[])
RubyArray	to_a()	Deprecated.
RubyArray	to_a(ThreadContext context)	rb_any_to_a call-seq: obj.to_a -> anArray Returns an array representation of obj.
RubyHash	to_h(ThreadContext context)	Deprecated.
RubyHash	to_h(ThreadContext context, Block block)
static RubyStruct	unmarshalFrom(UnmarshalStream input)
IRubyObject	values_at(IRubyObject[] args)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, dig, dig1, dig2, eqlInternal, equalInternal, equals, 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, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, defaultToJava, display, dup, ensureInstanceVariablesSettable, eql, eql_p, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, infectBy, infectBy, initialize19, inspect, 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, method_missing, method_missing19, method19, methods, methods, methods19, methodsImpl, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal_19, op_match, op_match19, op_not, op_not_equal, op_not_match, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbClone, rbInspect, recacheBuiltinMethods, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, 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, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted, tainted_p, testFrozen, testFrozen, to_s, toJava, trust, type, type_deprecated, 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

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

KEYWORD_INIT_VAR

private static final String KEYWORD_INIT_VAR

See Also:

• Constant Field Values

SIZE_VAR

private static final String SIZE_VAR

See Also:

• Constant Field Values

MEMBER_VAR

public static final String MEMBER_VAR

See Also:

• Constant Field Values

values

private final IRubyObject[] values

STRUCT_BEG

private static final byte[] STRUCT_BEG

STRUCT_END

private static final byte[] STRUCT_END

Constructor Details

RubyStruct

private RubyStruct(Ruby runtime,
 RubyClass rubyClass)

Constructor for RubyStruct.

Parameters:

runtime -

rubyClass -

Method Details

createStructClass

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

getInternalVariable

private static IRubyObject getInternalVariable(RubyClass type,
 String internedName)

classOf

private RubyClass classOf()

modify

private void modify()

hash

public RubyFixnum hash(ThreadContext context)

setByName

private IRubyObject setByName(String name,
 IRubyObject value)

getByName

private IRubyObject getByName(String name)

newInstance

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

Create new Struct class. MRI: rb_struct_s_def / make_struct

newStruct

public static RubyStruct newStruct(IRubyObject recv,
 IRubyObject[] args,
 Block block)

Create new Structure. MRI: struct_alloc

newStruct

public static RubyStruct newStruct(IRubyObject recv,
 Block block)

newStruct

public static RubyStruct newStruct(IRubyObject recv,
 IRubyObject arg0,
 Block block)

newStruct

public static RubyStruct newStruct(IRubyObject recv,
 IRubyObject arg0,
 IRubyObject arg1,
 Block block)

newStruct

public static RubyStruct newStruct(IRubyObject recv,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2,
 Block block)

checkSize

private void checkSize(int length)

initialize

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

setupStructValuesFromHash

private void setupStructValuesFromHash(ThreadContext context,
 RubyHash kwArgs)

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

static RubyArray members(RubyClass type)

members

@Deprecated
public static RubyArray members(IRubyObject recv,
 Block block)

Deprecated.

__member__

private static RubyArray __member__(RubyClass clazz)

__member__

private RubyArray __member__()

members

public RubyArray members()

members19

@Deprecated
public final RubyArray members19()

Deprecated.

select

public IRubyObject select(ThreadContext context,
 Block block)

size

private static IRubyObject size(ThreadContext context,
 RubyStruct recv,
 IRubyObject[] args)

A size method suitable for lambda method reference implementation of RubyEnumerator.SizeFn.size(ThreadContext, IRubyObject, IRubyObject[])

See Also:

• RubyEnumerator.SizeFn.size(ThreadContext, IRubyObject, IRubyObject[])

set

public IRubyObject set(IRubyObject value,
 int index)

notStructMemberError

private RaiseException notStructMemberError(IRubyObject name)

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)

inspectStruct

private RubyString inspectStruct(ThreadContext context,
 boolean recur)

inspect_struct

inspect

public RubyString inspect(ThreadContext context)

to_a

public RubyArray to_a(ThreadContext context)

Description copied from class: RubyBasicObject

rb_any_to_a call-seq: obj.to_a -> anArray Returns an array representation of obj. For objects of class Object and others that don't explicitly override the method, the return value is an array containing self. However, this latter behavior will soon be obsolete. self.to_a #=> -:1: warning: default `to_a' will be obsolete "hello".to_a #=> ["hello"] Time.new.to_a #=> [39, 54, 8, 9, 4, 2003, 3, 99, true, "CDT"] The default to_a method is deprecated.

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

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

public IRubyObject aref(IRubyObject key)

arefImpl

private IRubyObject arefImpl(IRubyObject key,
 boolean nilOnNoMember)

aref

final IRubyObject aref(int idx)

aset

public IRubyObject aset(IRubyObject key,
 IRubyObject value)

aset

private IRubyObject aset(int idx,
 IRubyObject value)

values_at

public IRubyObject values_at(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

public static void marshalTo(RubyStruct struct,
 MarshalStream output)
                      throws IOException

Throws:

IOException

unmarshalFrom

public static RubyStruct unmarshalFrom(UnmarshalStream input)
                                throws IOException

Throws:

IOException

pathToClass

private static RubyClass pathToClass(Ruby runtime,
 String path)

initialize_copy

public IRubyObject initialize_copy(IRubyObject arg)

Description copied from class: RubyBasicObject

rb_obj_init_copy 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

members19

@Deprecated
public static RubyArray members19(IRubyObject recv,
 Block block)

Deprecated.

to_a

@Deprecated
public RubyArray to_a()

Deprecated.

Overrides:

to_a in class RubyBasicObject