org.jruby.runtime.builtin

Interface IRubyObject

All Known Subinterfaces:

JavaProxyMethod

All Known Implementing Classes:

AbstractInvoker, AbstractMemory, AbstractRubyMethod, Addrinfo, ArrayJavaProxy, ArrayJavaProxyCreator, AutoPointer, BlankSlateWrapper, Buffer, CallbackInfo, ConcreteJavaProxy, ConditionVariable, DynamicLibrary, DynamicLibrary.Symbol, Enum, Enums, FileDescriptorIO, Function, IncludedModuleWrapper, InterfaceJavaProxy, JavaAccessibleObject, JavaArray, JavaCallable, JavaClass, JavaConstructor, JavaField, JavaMethod, JavaObject, JavaProxy, JavaProxyClass, JavaProxyClass.ProxyMethodImpl, JavaProxyConstructor, JavaProxyReflectionObject, JFFIInvoker, JRubyExecutionContextLocal, JRubyFiberLocal, JRubyObjectInputStream, JRubyThreadLocal, JZlibDeflate, JZlibInflate, JZlibRubyGzipReader, JZlibRubyGzipWriter, MapJavaProxy, MappedType, MemoryObject, MemoryPointer, MetaClass, MethodMissing, Mutex, NativeException, Option, Pointer, PsychEmitter, PsychParser, Queue, RubyArray, RubyBasicObject, RubyBasicSocket, RubyBigDecimal, RubyBignum, RubyBinding, RubyBoolean, RubyBoolean.False, RubyBoolean.True, RubyClass, RubyClassPathVariable, RubyComplex, RubyContinuation, RubyConverter, RubyData, RubyDigest.DigestBase, RubyDigest.DigestClass, RubyDir, RubyEncoding, RubyEnumerator, RubyException, RubyFile, RubyFileStat, RubyFixnum, RubyFloat, RubyGlobal.CaseInsensitiveStringOnlyRubyHash, RubyGlobal.StringOnlyRubyHash, RubyGzipFile, RubyHash, RubyIconv, RubyIconv.RubyFailure, RubyInteger, RubyIO, RubyIPSocket, RubyLocalJumpError, RubyMatchData, RubyMethod, RubyModule, RubyNameError, RubyNameError.RubyNameErrorMessage, RubyNil, RubyNoMethodError, RubyNumeric, RubyObject, RubyObject.Data, RubyObjectSpace.WeakMap, RubyObjectVar0, RubyObjectVar1, RubyObjectVar2, RubyObjectVar3, RubyObjectVar4, RubyObjectVar5, RubyObjectVar6, RubyObjectVar7, RubyObjectVar8, RubyObjectVar9, RubyPathname, RubyProc, RubyProcess.RubyStatus, RubyRandom, RubyRange, RubyRational, RubyRegexp, RubyServerSocket, RubySocket, RubyString, RubyStringIO, RubyStringIO, RubyStringScanner, RubyStruct, RubySymbol, RubySystemCallError, RubySystemExit, RubyTCPServer, RubyTCPSocket, RubyThread, RubyThread.Location, RubyThreadGroup, RubyTime, RubyUDPSocket, RubyUnboundMethod, RubyUNIXServer, RubyUNIXSocket, RubyYielder, SizedQueue, StringArraySet, StringIO, Struct, StructByReference, StructByValue, StructLayout, StructLayout.ArrayField, StructLayout.ArrayProxy, StructLayout.CharArrayProxy, StructLayout.EnumField, StructLayout.Field, StructLayout.FunctionField, StructLayout.InnerStructField, StructLayout.MappedField, StructLayout.NumberField, StructLayout.PointerField, Tempfile, ThreadFiber, TracePoint, Type, Type.Array, Type.Builtin, UndefinedValue, VariadicInvoker, WeakRef, ZStream

public interface IRubyObject

Object is the parent class of all classes in Ruby. Its methods are therefore available to all objects unless explicitly overridden.

Field Summary

Fields

Modifier and Type	Field and Description
static IRubyObject[]	NULL_ARRAY

Method Summary

Methods

Modifier and Type	Method and Description
void	addFinalizer(IRubyObject finalizer)
IRubyObject	anyToString()
String	asJavaString() Convert the object into a symbol name if possible.
RubyString	asString() rb_obj_as_string
IRubyObject	callMethod(ThreadContext context, int methodIndex, String name) Deprecated.
IRubyObject	callMethod(ThreadContext context, int methodIndex, String name, IRubyObject arg) Deprecated.
IRubyObject	callMethod(ThreadContext context, String name)
IRubyObject	callMethod(ThreadContext context, String name, IRubyObject arg)
IRubyObject	callMethod(ThreadContext context, String name, IRubyObject[] args)
IRubyObject	callMethod(ThreadContext context, String name, IRubyObject[] args, Block block)
IRubyObject	callSuper(ThreadContext context, IRubyObject[] args, Block block) Deprecated.
IRubyObject	checkArrayType()
IRubyObject	checkCallMethod(ThreadContext context, String name)
IRubyObject	checkStringType()
IRubyObject	checkStringType19()
RubyArray	convertToArray() Methods which perform to_xxx if the object has such a method
RubyFloat	convertToFloat()
RubyHash	convertToHash()
RubyInteger	convertToInteger()
RubyInteger	convertToInteger(int convertMethodIndex, String convertMethod) Deprecated.
RubyInteger	convertToInteger(String convertMethod)
RubyString	convertToString()
void	copySpecialInstanceVariables(IRubyObject clone)
Object	dataGetStruct() Our version of Data_Get_Struct.
Object	dataGetStructChecked()
void	dataWrapStruct(Object obj) Our version of Data_Wrap_Struct.
IRubyObject	dup() RubyMethod dup.
boolean	eql(IRubyObject other)
InstanceVariables	getInstanceVariables()
InternalVariables	getInternalVariables()
Class	getJavaClass() RubyMethod getJavaClass.
RubyClass	getMetaClass() RubyMethod getRubyClass.
Ruby	getRuntime() RubyMethod getRuntime.
RubyClass	getSingletonClass() RubyMethod getSingletonClass.
RubyClass	getType() RubyMethod getType.
Object	getVariable(int index)
int	getVariableCount()
List<Variable<Object>>	getVariableList()
List<String>	getVariableNameList()
boolean	hasVariables() Returns true if object has any variables, defined as: instance variables class variables constants internal variables, such as those used when marshalling Ranges and Exceptions
IRubyObject	id()
IRubyObject	infectBy(IRubyObject obj) Infect this object using the taint of another object
IRubyObject	inspect() RubyMethod inspect.
boolean	isClass()
boolean	isFrozen() RubyMethod isFrozen.
boolean	isImmediate()
boolean	isModule()
boolean	isNil() RubyMethod isNil.
boolean	isTaint() RubyMethod isTaint.
boolean	isTrue()
boolean	isUntrusted() RubyMethod isUntrusted.
IRubyObject	op_eqq(ThreadContext context, IRubyObject other)
IRubyObject	op_equal(ThreadContext context, IRubyObject other)
IRubyObject	rbClone() RubyMethod rbClone.
void	removeFinalizers()
boolean	respondsTo(String string) RubyMethod respondsTo.
boolean	respondsToMissing(String string) RubyMethod respondsTo.
boolean	respondsToMissing(String string, boolean priv) RubyMethod respondsTo.
void	setFrozen(boolean b) RubyMethod setFrozen.
void	setTaint(boolean b) RubyMethod setTaint.
void	setUntrusted(boolean b) RubyMethod setUntrusted.
void	setVariable(int index, Object value)
void	syncVariables(IRubyObject source) Sets object's variables to those in the supplied object, removing/replacing any previously defined variables of the same name.
void	syncVariables(List<Variable<Object>> variables) Deprecated.
Object	toJava(Class cls) Convert the object to the specified Java class, if possible.

Field Detail

NULL_ARRAY

static final IRubyObject[] NULL_ARRAY

Method Detail

callSuper

@Deprecated
IRubyObject callSuper(ThreadContext context,
                               IRubyObject[] args,
                               Block block)

Deprecated.

callMethod

IRubyObject callMethod(ThreadContext context,
                     String name)

callMethod

IRubyObject callMethod(ThreadContext context,
                     String name,
                     IRubyObject arg)

callMethod

IRubyObject callMethod(ThreadContext context,
                     String name,
                     IRubyObject[] args)

callMethod

IRubyObject callMethod(ThreadContext context,
                     String name,
                     IRubyObject[] args,
                     Block block)

callMethod

@Deprecated
IRubyObject callMethod(ThreadContext context,
                                int methodIndex,
                                String name)

Deprecated.

callMethod

@Deprecated
IRubyObject callMethod(ThreadContext context,
                                int methodIndex,
                                String name,
                                IRubyObject arg)

Deprecated.

checkCallMethod

IRubyObject checkCallMethod(ThreadContext context,
                          String name)

isNil

boolean isNil()

RubyMethod isNil.

Returns:

boolean

isTrue

boolean isTrue()

Returns:

isTaint

boolean isTaint()

RubyMethod isTaint.

Returns:

boolean

setTaint

void setTaint(boolean b)

RubyMethod setTaint.

Parameters:

b -

infectBy

IRubyObject infectBy(IRubyObject obj)

Infect this object using the taint of another object

Parameters:

obj -

Returns:

isFrozen

boolean isFrozen()

RubyMethod isFrozen.

Returns:

boolean

setFrozen

void setFrozen(boolean b)

RubyMethod setFrozen.

Parameters:

b -

isUntrusted

boolean isUntrusted()

RubyMethod isUntrusted.

Returns:

boolean

setUntrusted

void setUntrusted(boolean b)

RubyMethod setUntrusted.

Parameters:

b -

isImmediate

boolean isImmediate()

Returns:

getMetaClass

RubyClass getMetaClass()

RubyMethod getRubyClass.

Returns:

getSingletonClass

RubyClass getSingletonClass()

RubyMethod getSingletonClass.

Returns:

RubyClass

getType

RubyClass getType()

RubyMethod getType.

Returns:

RubyClass

respondsTo

boolean respondsTo(String string)

RubyMethod respondsTo.

Parameters:

string -

Returns:

boolean

respondsToMissing

boolean respondsToMissing(String string)

RubyMethod respondsTo.

Parameters:

string -

Returns:

boolean

respondsToMissing

boolean respondsToMissing(String string,
                        boolean priv)

RubyMethod respondsTo.

Parameters:

string -

Returns:

boolean

getRuntime

Ruby getRuntime()

RubyMethod getRuntime.

Returns:

getJavaClass

Class getJavaClass()

RubyMethod getJavaClass.

Returns:

Class

asJavaString

String asJavaString()

Convert the object into a symbol name if possible.

Returns:

String the symbol name

asString

RubyString asString()

rb_obj_as_string

Returns:

convertToArray

RubyArray convertToArray()

Methods which perform to_xxx if the object has such a method

Returns:

convertToHash

RubyHash convertToHash()

Returns:

convertToFloat

RubyFloat convertToFloat()

Returns:

convertToInteger

RubyInteger convertToInteger()

Returns:

convertToInteger

@Deprecated
RubyInteger convertToInteger(int convertMethodIndex,
                                      String convertMethod)

Deprecated.

Returns:

convertToInteger

RubyInteger convertToInteger(String convertMethod)

Returns:

convertToString

RubyString convertToString()

Returns:

anyToString

IRubyObject anyToString()

Returns:

checkStringType

IRubyObject checkStringType()

Returns:

checkStringType19

IRubyObject checkStringType19()

Returns:

checkArrayType

IRubyObject checkArrayType()

Returns:

toJava

Object toJava(Class cls)

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

Parameters:

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

dup

IRubyObject dup()

RubyMethod dup.

Returns:

inspect

IRubyObject inspect()

RubyMethod inspect.

Returns:

String

rbClone

IRubyObject rbClone()

RubyMethod rbClone.

Returns:

IRubyObject

isModule

boolean isModule()

Returns:

true if an object is Ruby Module instance (note that it will return false for Ruby Classes). If is_a? semantics is required, use (someObject instanceof RubyModule) instead.

isClass

boolean isClass()

Returns:

true if an object is Ruby Class instance (note that it will return false for Ruby singleton classes). If is_a? semantics is required, use (someObject instanceof RubyClass/MetaClass) instead.

dataWrapStruct

void dataWrapStruct(Object obj)

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.

Parameters:

obj - the object to wrap

dataGetStruct

Object dataGetStruct()

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

Returns:

the object wrapped.

dataGetStructChecked

Object dataGetStructChecked()

id

IRubyObject id()

Returns:

op_equal

IRubyObject op_equal(ThreadContext context,
                   IRubyObject other)

op_eqq

IRubyObject op_eqq(ThreadContext context,
                 IRubyObject other)

eql

boolean eql(IRubyObject other)

addFinalizer

void addFinalizer(IRubyObject finalizer)

removeFinalizers

void removeFinalizers()

hasVariables

boolean hasVariables()

Returns true if object has any variables, defined as:

• instance variables
• class variables
• constants
• internal variables, such as those used when marshalling Ranges and Exceptions

Returns:

true if object has any variables, else false

getVariableCount

int getVariableCount()

Returns:

the count of all variables (ivar/cvar/constant/internal)

syncVariables

@Deprecated
void syncVariables(List<Variable<Object>> variables)

Deprecated.

Sets object's variables to those in the supplied list, removing/replacing any previously defined variables. Applies to all variable types (ivar/cvar/constant/internal).

Parameters:

variables - the variables to be set for object

syncVariables

void syncVariables(IRubyObject source)

Sets object's variables to those in the supplied object, removing/replacing any previously defined variables of the same name. Applies to all variable types (ivar/cvar/constant/internal).

Parameters:

source - the source object containing the variables to sync

getVariableList

List<Variable<Object>> getVariableList()

Returns:

a list of all variables (ivar/cvar/constant/internal)

getInstanceVariables

InstanceVariables getInstanceVariables()

getInternalVariables

InternalVariables getInternalVariables()

getVariableNameList

List<String> getVariableNameList()

Returns:

a list of all variable names (ivar/cvar/constant/internal)

copySpecialInstanceVariables

void copySpecialInstanceVariables(IRubyObject clone)

getVariable

Object getVariable(int index)

setVariable

void setVariable(int index,
               Object value)