org.jruby.javasupport

Class JavaObject

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.javasupport.JavaObject

All Implemented Interfaces:

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

Direct Known Subclasses:

JavaArray, JavaClass

public class JavaObject
extends RubyObject

Author:

jpetersen

See Also:

Serialized Form

Nested Class Summary

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 inherited from class org.jruby.RubyObject

FIELD_ALLOCATED_CLASSES, FIELD_ALLOCATORS, IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, OBJECT_VAR0_ALLOCATOR, OBJECT_VAR1_ALLOCATOR, OBJECT_VAR2_ALLOCATOR, OBJECT_VAR3_ALLOCATOR, OBJECT_VAR4_ALLOCATOR, OBJECT_VAR5_ALLOCATOR, OBJECT_VAR6_ALLOCATOR, OBJECT_VAR7_ALLOCATOR, OBJECT_VAR8_ALLOCATOR, OBJECT_VAR9_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, 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
protected	JavaObject(Ruby runtime, Object value)
protected	JavaObject(Ruby runtime, RubyClass rubyClass, Object value)

Method Summary

Methods

Modifier and Type	Method and Description
static RubyClass	createJavaObjectClass(Ruby runtime, RubyModule javaModule)
Object	dataGetStruct() Our version of Data_Get_Struct.
void	dataWrapStruct(Object object) Our version of Data_Wrap_Struct.
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.
Class<?>	getJavaClass() Will return the Java interface that most closely can represent this object, when working through JAva integration translations.
Object	getValue()
RubyFixnum	hash() rb_obj_id Will return the hash code of this object.
int	hashCode() Override the Object#hashCode method to make sure that the Ruby hash is actually used as the hashcode for Ruby objects.
IRubyObject	is_java_proxy()
IRubyObject	java_class()
RubyString	java_type()
RubyFixnum	length()
IRubyObject	marshal_dump()
IRubyObject	marshal_load(ThreadContext context, IRubyObject str)
IRubyObject	op_equal(IRubyObject other)
static IRubyObject	op_equal(JavaProxy self, IRubyObject other)
protected static void	registerRubyMethods(Ruby runtime, RubyClass result)
IRubyObject	ruby_synchronized(ThreadContext context, Block block)
static IRubyObject	ruby_synchronized(ThreadContext context, Object lock, Block block)
IRubyObject	same(IRubyObject other)
IRubyObject	to_s() rb_any_to_s call-seq: obj.to_s => string Returns a string representing obj.
static IRubyObject	to_s(Ruby runtime, Object dataStruct)
Object	toJava(Class cls) Convert the object to the specified Java class, if possible.
static JavaObject	wrap(Ruby runtime, Object value)
static IRubyObject	wrap(ThreadContext context, IRubyObject self, IRubyObject object)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, eqlInternal, equalInternal, getNativeTypeIndex, initialize, initialize, inspect, op_eqq, puts, specificEval, toString

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, dataGetStructChecked, 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, getNativeHandle, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, 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, 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

Constructor Detail

JavaObject

protected JavaObject(Ruby runtime,
          RubyClass rubyClass,
          Object value)

JavaObject

protected JavaObject(Ruby runtime,
          Object value)

Method Detail

dataGetStruct

public Object dataGetStruct()

Description copied from interface: IRubyObject

Our version of Data_Get_Struct. Returns a wrapped data value if there is one, otherwise returns null.

Specified by:

dataGetStruct in interface IRubyObject

Overrides:

dataGetStruct in class RubyBasicObject

Returns:

the object wrapped.

See Also:

IRubyObject.dataGetStruct()

dataWrapStruct

public void dataWrapStruct(Object object)

Description copied from interface: IRubyObject

Our version of Data_Wrap_Struct. This method will just set a private pointer to the object provided. This pointer is transient and will not be accessible from Ruby.

Specified by:

dataWrapStruct in interface IRubyObject

Overrides:

dataWrapStruct in class RubyBasicObject

Parameters:

object - the object to wrap

See Also:

IRubyObject.dataWrapStruct(Object)

wrap

public static JavaObject wrap(Ruby runtime,
              Object value)

wrap

public static IRubyObject wrap(ThreadContext context,
               IRubyObject self,
               IRubyObject object)

getJavaClass

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

Class

getValue

public Object getValue()

createJavaObjectClass

public static RubyClass createJavaObjectClass(Ruby runtime,
                              RubyModule javaModule)

registerRubyMethods

protected static void registerRubyMethods(Ruby runtime,
                       RubyClass result)

equals

public boolean equals(Object other)

Description copied from class: RubyObject

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 RubyObject

hashCode

public int hashCode()

Description copied from class: RubyObject

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 RubyObject

hash

public RubyFixnum hash()

Description copied from class: RubyBasicObject

rb_obj_id 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

to_s

public IRubyObject to_s()

Description copied from class: RubyBasicObject

rb_any_to_s call-seq: obj.to_s => string Returns a string representing obj. The default to_s prints the object's class and an encoding of the object id. As a special case, the top-level object that is the initial execution context of Ruby programs returns ``main.''

Overrides:

to_s in class RubyBasicObject

to_s

public static IRubyObject to_s(Ruby runtime,
               Object dataStruct)

op_equal

public IRubyObject op_equal(IRubyObject other)

op_equal

public static IRubyObject op_equal(JavaProxy self,
                   IRubyObject other)

same

public IRubyObject same(IRubyObject other)

java_type

public RubyString java_type()

java_class

public IRubyObject java_class()

length

public RubyFixnum length()

is_java_proxy

public IRubyObject is_java_proxy()

ruby_synchronized

public IRubyObject ruby_synchronized(ThreadContext context,
                            Block block)

ruby_synchronized

public static IRubyObject ruby_synchronized(ThreadContext context,
                            Object lock,
                            Block block)

marshal_dump

public IRubyObject marshal_dump()

marshal_load

public IRubyObject marshal_load(ThreadContext context,
                       IRubyObject str)

toJava

public Object toJava(Class cls)

Description copied from interface: IRubyObject

Convert the object to the specified Java class, if possible.

Specified by:

toJava in interface IRubyObject

Overrides:

toJava in class RubyBasicObject

Parameters:

cls - The target type to which the object should be converted.

See Also:

IRubyObject.toJava(java.lang.Class)