org.jruby

Class RubyObject

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

All Implemented Interfaces:

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

Direct Known Subclasses:

Addrinfo, ArrayJavaProxyCreator, ConditionVariable, DynamicLibrary, Enum, Enums, JavaAccessibleObject, JavaObject, JavaProxy, JavaProxyReflectionObject, JRubyExecutionContextLocal, JRubyObjectInputStream, MemoryObject, MethodMissing, Mutex, Option, PsychEmitter, PsychParser, Queue, RubyArray, RubyBinding, RubyBoolean, RubyClassPathVariable, RubyContinuation, RubyConverter, RubyData, RubyDigest.DigestBase, RubyDigest.DigestClass, RubyDir, RubyEncoding, RubyEnumerator, RubyException, RubyFileStat, RubyGzipFile, RubyHash, RubyIconv, RubyIO, RubyMatchData, RubyMethod, RubyModule, RubyNameError.RubyNameErrorMessage, RubyNil, RubyNumeric, RubyObject.Data, RubyObjectSpace.WeakMap, RubyObjectVar0, RubyPathname, RubyProc, RubyProcess.RubyStatus, RubyRandom, RubyRange, RubyRegexp, RubyString, RubyStringIO, RubyStringIO, RubyStringScanner, RubyStruct, RubySymbol, RubyThread, RubyThread.Location, RubyThreadGroup, RubyTime, RubyYielder, StringIO, StructByReference, StructLayout.ArrayProxy, StructLayout.Field, ThreadFiber, TracePoint, Type, VariadicInvoker, WeakRef, ZStream

public class RubyObject
extends RubyBasicObject

RubyObject represents the implementation of the Object class in Ruby. As such, it defines very few methods of its own, inheriting most from the included Kernel module. Methods that are implemented here, such as "initialize" should be implemented with care; reification of Ruby classes into Java classes can produce conflicting method names in rare cases. See JRUBY-5906 for an example.

Author:

headius

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RubyObject.Data

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

RubyBasicObject.Finalizer

Field Summary

Fields

Modifier and Type	Field and Description
static Class[]	FIELD_ALLOCATED_CLASSES
static ObjectAllocator[]	FIELD_ALLOCATORS
static ObjectAllocator	IVAR_INSPECTING_OBJECT_ALLOCATOR Allocator that inspects all methods for instance variables and chooses a concrete class to construct based on that.
static ObjectAllocator	OBJECT_ALLOCATOR Default allocator instance for all Ruby objects.
static ObjectAllocator	OBJECT_VAR0_ALLOCATOR
static ObjectAllocator	OBJECT_VAR1_ALLOCATOR
static ObjectAllocator	OBJECT_VAR2_ALLOCATOR
static ObjectAllocator	OBJECT_VAR3_ALLOCATOR
static ObjectAllocator	OBJECT_VAR4_ALLOCATOR
static ObjectAllocator	OBJECT_VAR5_ALLOCATOR
static ObjectAllocator	OBJECT_VAR6_ALLOCATOR
static ObjectAllocator	OBJECT_VAR7_ALLOCATOR
static ObjectAllocator	OBJECT_VAR8_ALLOCATOR
static ObjectAllocator	OBJECT_VAR9_ALLOCATOR
static ObjectAllocator	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, metaClass, NEVER, NIL_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUSTED_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, VAR_TABLE_OFFSET, varTable, varTableStamp

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

NULL_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
	RubyObject(RubyClass metaClass) Path for objects that don't taint and don't enter objectspace.
	RubyObject(Ruby runtime, RubyClass metaClass) Standard path for object creation.
protected	RubyObject(Ruby runtime, RubyClass metaClass, boolean useObjectSpace) Path for objects who want to decide whether they don't want to be in ObjectSpace even when it is on.
protected	RubyObject(Ruby runtime, RubyClass metaClass, boolean useObjectSpace, boolean canBeTainted) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	attachToObjectSpace() Will make sure that this object is added to the current object space.
void	callInit(Block block) Call the Ruby initialize method with the supplied arguments and block.
void	callInit(IRubyObject[] args, Block block) Call the Ruby initialize method with the supplied arguments and block.
void	callInit(IRubyObject arg0, Block block) Call the Ruby initialize method with the supplied arguments and block.
void	callInit(IRubyObject arg0, IRubyObject arg1, Block block) Call the Ruby initialize method with the supplied arguments and block.
void	callInit(IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block) Call the Ruby initialize method with the supplied arguments and block.
void	callInit(ThreadContext context, Block block)
void	callInit(ThreadContext context, IRubyObject[] args, Block block)
void	callInit(ThreadContext context, IRubyObject arg0, Block block)
void	callInit(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
void	callInit(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)
IRubyObject	convertToType(RubyClass target, int convertMethodIndex) Deprecated.
static RubyClass	createObjectClass(Ruby runtime, RubyClass objectClass) Will create the Ruby class Object in the runtime specified.
protected static boolean	eqlInternal(ThreadContext context, IRubyObject a, IRubyObject b) Helper method for checking equality, first using Java identity equality, and then calling the "eql?" method.
protected static boolean	equalInternal(ThreadContext context, IRubyObject a, IRubyObject b) Helper method for checking equality, first using Java identity equality, and then calling the "==" method.
boolean	equals(Object other) This method is just a wrapper around the Ruby "==" method, provided so that RubyObjects can be used as keys in the Java HashMap object underlying RubyHash.
int	getNativeTypeIndex() This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
int	hashCode() Override the Object#hashCode method to make sure that the Ruby hash is actually used as the hashcode for Ruby objects.
IRubyObject	initialize() Deprecated.
IRubyObject	initialize(ThreadContext context)
static RubyString	inspect(ThreadContext context, IRubyObject object) rb_inspect The internal helper that ensures a RubyString instance is returned so dangerous casting can be omitted Prefered over callMethod(context, "inspect")
IRubyObject	op_eqq(ThreadContext context, IRubyObject other) rb_equal The Ruby "===" method is used by default in case/when statements.
static void	puts(Object obj) Simple helper to print any objects.
IRubyObject	specificEval(ThreadContext context, RubyModule mod, IRubyObject[] args, Block block) Deprecated.
String	toString() The default toString method is just a wrapper that calls the Ruby "to_s" method.

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, 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, getJavaClass, getMetaClass, getNativeHandle, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id_deprecated, id, infectBy, initialize_copy, 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, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing19, method, method19, methods, methods, methods19, nil_p, op_cmp, op_equal_19, op_equal, 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, 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_added19, singleton_method_removed19, singleton_method_undefined19, singleton_methods, singleton_methods19, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_s, toJava, trust, type_deprecated, type, untaint, untrust, untrusted_p, 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 Detail

OBJECT_ALLOCATOR

public static final ObjectAllocator OBJECT_ALLOCATOR

Default allocator instance for all Ruby objects. The only reason to not use this allocator is if you actually need to have all instances of something be a subclass of RubyObject.

See Also:

ObjectAllocator

OBJECT_VAR0_ALLOCATOR

public static final ObjectAllocator OBJECT_VAR0_ALLOCATOR

OBJECT_VAR1_ALLOCATOR

public static final ObjectAllocator OBJECT_VAR1_ALLOCATOR

OBJECT_VAR2_ALLOCATOR

public static final ObjectAllocator OBJECT_VAR2_ALLOCATOR

OBJECT_VAR3_ALLOCATOR

public static final ObjectAllocator OBJECT_VAR3_ALLOCATOR

OBJECT_VAR4_ALLOCATOR

public static final ObjectAllocator OBJECT_VAR4_ALLOCATOR

OBJECT_VAR5_ALLOCATOR

public static final ObjectAllocator OBJECT_VAR5_ALLOCATOR

OBJECT_VAR6_ALLOCATOR

public static final ObjectAllocator OBJECT_VAR6_ALLOCATOR

OBJECT_VAR7_ALLOCATOR

public static final ObjectAllocator OBJECT_VAR7_ALLOCATOR

OBJECT_VAR8_ALLOCATOR

public static final ObjectAllocator OBJECT_VAR8_ALLOCATOR

OBJECT_VAR9_ALLOCATOR

public static final ObjectAllocator OBJECT_VAR9_ALLOCATOR

FIELD_ALLOCATORS

public static final ObjectAllocator[] FIELD_ALLOCATORS

FIELD_ALLOCATED_CLASSES

public static final Class[] FIELD_ALLOCATED_CLASSES

IVAR_INSPECTING_OBJECT_ALLOCATOR

public static final ObjectAllocator IVAR_INSPECTING_OBJECT_ALLOCATOR

Allocator that inspects all methods for instance variables and chooses a concrete class to construct based on that. This allows using specialized subclasses to hold instance variables in fields rather than always holding them in an array.

REIFYING_OBJECT_ALLOCATOR

public static final ObjectAllocator REIFYING_OBJECT_ALLOCATOR

Constructor Detail

RubyObject

public RubyObject(Ruby runtime,
          RubyClass metaClass)

Standard path for object creation. Objects are entered into ObjectSpace only if ObjectSpace is enabled.

RubyObject

public RubyObject(RubyClass metaClass)

Path for objects that don't taint and don't enter objectspace.

RubyObject

@Deprecated
protected RubyObject(Ruby runtime,
                     RubyClass metaClass,
                     boolean useObjectSpace,
                     boolean canBeTainted)

Deprecated.

RubyObject

protected RubyObject(Ruby runtime,
          RubyClass metaClass,
          boolean useObjectSpace)

Path for objects who want to decide whether they don't want to be in ObjectSpace even when it is on. (notably used by objects being considered immediate, they'll always pass false here)

Method Detail

createObjectClass

public static RubyClass createObjectClass(Ruby runtime,
                          RubyClass objectClass)

Will create the Ruby class Object in the runtime specified. This method needs to take the actual class as an argument because of the Object class' central part in runtime initialization.

initialize

@Deprecated
public IRubyObject initialize()

Deprecated.

Overrides:

initialize in class RubyBasicObject

initialize

public IRubyObject initialize(ThreadContext context)

attachToObjectSpace

public void attachToObjectSpace()

Will make sure that this object is added to the current object space.

See Also:

ObjectSpace

getNativeTypeIndex

public int getNativeTypeIndex()

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:

getNativeTypeIndex in interface CoreObjectType

Overrides:

getNativeTypeIndex in class RubyBasicObject

Returns:

the ClassIndex of the native type this object was constructed from

See Also:

ClassIndex

puts

public static void puts(Object obj)

Simple helper to print any objects.

equals

public boolean equals(Object other)

This method is just a wrapper around the Ruby "==" method, provided so that RubyObjects can be used as keys in the Java HashMap object underlying RubyHash.

Overrides:

equals in class Object

toString

public String toString()

The default toString method is just a wrapper that calls the Ruby "to_s" method.

Overrides:

toString in class Object

callInit

public final void callInit(IRubyObject[] args,
            Block block)

Call the Ruby initialize method with the supplied arguments and block.

callInit

public final void callInit(Block block)

Call the Ruby initialize method with the supplied arguments and block.

callInit

public final void callInit(IRubyObject arg0,
            Block block)

Call the Ruby initialize method with the supplied arguments and block.

callInit

public final void callInit(IRubyObject arg0,
            IRubyObject arg1,
            Block block)

Call the Ruby initialize method with the supplied arguments and block.

callInit

public final void callInit(IRubyObject arg0,
            IRubyObject arg1,
            IRubyObject arg2,
            Block block)

Call the Ruby initialize method with the supplied arguments and block.

callInit

public final void callInit(ThreadContext context,
            IRubyObject[] args,
            Block block)

callInit

public final void callInit(ThreadContext context,
            Block block)

callInit

public final void callInit(ThreadContext context,
            IRubyObject arg0,
            Block block)

callInit

public final void callInit(ThreadContext context,
            IRubyObject arg0,
            IRubyObject arg1,
            Block block)

callInit

public final void callInit(ThreadContext context,
            IRubyObject arg0,
            IRubyObject arg1,
            IRubyObject arg2,
            Block block)

convertToType

@Deprecated
public final IRubyObject convertToType(RubyClass target,
                                   int convertMethodIndex)

Deprecated.

Tries to convert this object to the specified Ruby type, using a specific conversion method.

specificEval

@Deprecated
public IRubyObject specificEval(ThreadContext context,
                                  RubyModule mod,
                                  IRubyObject[] args,
                                  Block block)

Deprecated.

specific_eval Evaluates the block or string inside of the context of this object, using the supplied arguments. If a block is given, this will be yielded in the specific context of this object. If no block is given then a String-like object needs to be the first argument, and this string will be evaluated. Second and third arguments in the args-array is optional, but can contain the filename and line of the string under evaluation.

op_eqq

public IRubyObject op_eqq(ThreadContext context,
                 IRubyObject other)

rb_equal The Ruby "===" method is used by default in case/when statements. The Object implementation first checks Java identity equality and then calls the "==" method too.

Specified by:

op_eqq in interface IRubyObject

Overrides:

op_eqq in class RubyBasicObject

equalInternal

protected static boolean equalInternal(ThreadContext context,
                    IRubyObject a,
                    IRubyObject b)

Helper method for checking equality, first using Java identity equality, and then calling the "==" method.

eqlInternal

protected static boolean eqlInternal(ThreadContext context,
                  IRubyObject a,
                  IRubyObject b)

Helper method for checking equality, first using Java identity equality, and then calling the "eql?" method.

hashCode

public int hashCode()

Override the Object#hashCode method to make sure that the Ruby hash is actually used as the hashcode for Ruby objects. If the Ruby "hash" method doesn't return a number, the Object#hashCode implementation will be used instead.

Overrides:

hashCode in class Object

inspect

public static RubyString inspect(ThreadContext context,
                 IRubyObject object)

rb_inspect The internal helper that ensures a RubyString instance is returned so dangerous casting can be omitted Prefered over callMethod(context, "inspect")