Package 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:

AbstractRubyMethod, Addrinfo, ArrayJavaProxyCreator, ConditionVariable, DynamicLibrary, Enums, Ifaddr, JavaObject, JavaProxy, JavaProxyReflectionObject, JRubyExecutionContextLocal, JRubyObjectInputStream, MemoryObject, Monitor, Mutex, Option, Queue, RubyArgsFile, RubyArithmeticSequence, RubyArray, RubyBinding, RubyBoolean, RubyChain, RubyClassPathVariable, RubyContinuation, RubyConverter, RubyDate, RubyDigest.DigestBase, RubyDigest.DigestClass, RubyDir, RubyEncoding, RubyEnumerator, RubyEnumerator.FeedValue, RubyException, RubyFileStat, RubyGenerator, RubyGzipFile, RubyHash, RubyIO, RubyMatchData, RubyModule, RubyNameError.RubyNameErrorMessage, RubyNil, RubyNumeric, RubyObject.Data, RubyObjectSpace.WeakMap, RubyPathname, RubyProc, RubyProcess.RubyStatus, RubyRandom, RubyRange, RubyRegexp, RubyRipper, RubySet, RubyString, RubyStringScanner, RubyStruct, RubySymbol, RubySyslog, RubyThread, RubyThread.Location, RubyThreadGroup, RubyTime, RubyYielder, StringIO, StructLayout.ArrayProxy, StructLayout.Field, ThreadFiber, TracePoint, Type, VariadicInvoker, 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.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RubyObject.Data

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

RubyBasicObject.Finalizer

Field Summary

Fields

Modifier and Type	Field	Description
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.
static final ObjectAllocator	OBJECT_ALLOCATOR	Default allocator instance for all Ruby objects.
static final 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, 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
	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

Modifier and Type	Method	Description
void	attachToObjectSpace()	Will make sure that this object is added to the current object space.
final void	callInit(Block block)	Call the Ruby initialize method with the supplied arguments and block.
final void	callInit(IRubyObject[] args, Block block)	Call the Ruby initialize method with the supplied arguments and block.
final void	callInit(IRubyObject arg0, Block block)	Call the Ruby initialize method with the supplied arguments and block.
final void	callInit(IRubyObject arg0, IRubyObject arg1, Block block)	Call the Ruby initialize method with the supplied arguments and block.
final void	callInit(IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)	Call the Ruby initialize method with the supplied arguments and block.
final void	callInit(ThreadContext context, Block block)
final void	callInit(ThreadContext context, IRubyObject[] args, Block block)
final void	callInit(ThreadContext context, IRubyObject arg0, Block block)
final void	callInit(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
final void	callInit(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)
final IRubyObject	convertToType(RubyClass target, int convertMethodIndex)	Deprecated.
static RubyClass	createObjectClass(Ruby runtime, RubyClass objectClass)	Will create the Ruby class Object in the runtime specified.
static IRubyObject	dig(ThreadContext context, IRubyObject obj, IRubyObject[] args, int idx)
static IRubyObject	dig1(ThreadContext context, IRubyObject obj, IRubyObject arg1)
static IRubyObject	dig2(ThreadContext context, IRubyObject obj, IRubyObject arg1, IRubyObject arg2)
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.
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 override does not do a "checked" dispatch.
private static boolean	fastNumEqualInternal(ThreadContext context, IRubyObject a, IRubyObject b)
ClassIndex	getNativeClassIndex()	This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
int	hashCode()	This override does not do "checked" dispatch since Object usually has #hash defined.
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 Preferred over callMethod(context, "inspect")
private static boolean	isArrayDig(IRubyObject obj, JavaSites.ObjectSites sites)
private static boolean	isHashDig(IRubyObject obj, JavaSites.ObjectSites sites)
private static boolean	isStructDig(IRubyObject obj, JavaSites.ObjectSites sites)
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)	Deprecated. no longer used - uses Java's System.out
private void	readObject(ObjectInputStream in)	Tries to support Java unserialization of Ruby objects.
private static IRubyObject	reifyAndAllocate(Ruby runtime, RubyClass klass)	Reify the class and allocate an instance.
private static JavaSites.ObjectSites	sites(ThreadContext context)
IRubyObject	specificEval(ThreadContext context, RubyModule mod, IRubyObject[] args, Block block, EvalType evalType)	Deprecated.
RubyString	toRubyString(ThreadContext context)	The default toString method is just a wrapper that calls the Ruby "to_s" method.
String	toString()	The default toString method is just a wrapper that calls the Ruby "to_s" method.
private void	writeObject(ObjectOutputStream out)	Tries to support Java serialization of Ruby objects.

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, copySpecialInstanceVariables, 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, initialize, 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, 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, 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_a, to_a, 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

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

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 Details

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 Details

reifyAndAllocate

private static IRubyObject reifyAndAllocate(Ruby runtime,
 RubyClass klass)

Reify the class and allocate an instance.

Parameters:

runtime - the current runtime

klass - the target Ruby class

Returns:

a new instance of the now-reified class

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.

attachToObjectSpace

public void attachToObjectSpace()

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

See Also:

• ObjectSpace

getNativeClassIndex

public ClassIndex getNativeClassIndex()

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 RubyBasicObject

See Also:

• ClassIndex

puts

public static void puts(Object obj)

Deprecated.

no longer used - uses Java's System.out

Simple helper to print any objects.

equals

public boolean equals(Object other)

This override does not do a "checked" dispatch.

Overrides:

equals in class RubyBasicObject

See Also:

• RubyBasicObject.equals(Object)

toRubyString

public RubyString toRubyString(ThreadContext context)

The default toString method is just a wrapper that calls the Ruby "to_s" method. This will raise if it is not actually a Ruby String.

Parameters:

context - thread context this is executing on.

Returns:

the string.

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,
 EvalType evalType)

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

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

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

fastNumEqualInternal

private static boolean fastNumEqualInternal(ThreadContext context,
 IRubyObject a,
 IRubyObject b)

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

This override does not do "checked" dispatch since Object usually has #hash defined.

Overrides:

hashCode in class RubyBasicObject

See Also:

• RubyBasicObject.hashCode()

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 Preferred over callMethod(context, "inspect")

dig

public static IRubyObject dig(ThreadContext context,
 IRubyObject obj,
 IRubyObject[] args,
 int idx)

dig1

public static IRubyObject dig1(ThreadContext context,
 IRubyObject obj,
 IRubyObject arg1)

dig2

public static IRubyObject dig2(ThreadContext context,
 IRubyObject obj,
 IRubyObject arg1,
 IRubyObject arg2)

isStructDig

private static boolean isStructDig(IRubyObject obj,
 JavaSites.ObjectSites sites)

isHashDig

private static boolean isHashDig(IRubyObject obj,
 JavaSites.ObjectSites sites)

isArrayDig

private static boolean isArrayDig(IRubyObject obj,
 JavaSites.ObjectSites sites)

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Tries to support Java serialization of Ruby objects. This is still experimental and might not work.

Throws:

IOException

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Tries to support Java unserialization of Ruby objects. This is still experimental and might not work.

Throws:

IOException

ClassNotFoundException

sites

private static JavaSites.ObjectSites sites(ThreadContext context)