jruby/docs BETA
Navigation
org.jruby 121
C AbstractRubyMethod
I Appendable
C BasicObjectStub
I DelegatedModule
E EvalType
C FiberScheduler
I Finalizable
C FlagRegistry
C IncludedModule
C IncludedModuleWrapper
C JarBootstrapMain
C Main
C MetaClass
C NativeException
I ObjectFlags
I ParseResult
C PrependedModule
I Profile
C Ruby
C RubyArgsFile
C RubyArgumentError
C RubyArithmeticSequence
C RubyArray
C RubyArrayNative
C RubyBasicObject
C RubyBignum
C RubyBinding
C RubyBoolean
C RubyChain
C RubyClass
C RubyClassPathVariable
C RubyComparable
C RubyComplex
C RubyConcurrencyError
C RubyConverter
C RubyData
C RubyDir
C RubyDomainError
C RubyEOFError
C RubyEncoding
C RubyEncodingError
C RubyEnumerable
C RubyEnumerator
C RubyException
C RubyFatal
C RubyFiberError
C RubyFile
C RubyFileStat
C RubyFileTest
C RubyFixnum
C RubyFloat
C RubyFloatDomainError
C RubyFrozenError
C RubyGC
C RubyGenerator
C RubyGlobal
C RubyHash
C RubyHashLinkedBuckets
C RubyIO
C RubyIOBuffer
C RubyIOError
C RubyIndexError
C RubyInstanceConfig
C RubyInteger
C RubyInterrupt
C RubyInterruptedRegexpError
C RubyKernel
C RubyKeyError
C RubyLoadError
C RubyLocalJumpError
C RubyMarshal
C RubyMatchData
C RubyMath
C RubyMethod
C RubyModule
C RubyNameError
C RubyNil
C RubyNoMatchingPatternError
C RubyNoMatchingPatternKeyError
C RubyNoMemoryError
C RubyNoMethodError
C RubyNotImplementedError
C RubyNumeric
C RubyObject
I RubyObjectAdapter
C RubyObjectSpace
C RubyProc
C RubyProcess
C RubyProducer
C RubyRandom
C RubyRandomBase
C RubyRange
C RubyRangeError
C RubyRational
C RubyRegexp
C RubyRegexpError
I RubyRuntimeAdapter
C RubyRuntimeError
C RubyScriptError
C RubySecurityError
C RubySignal
C RubySignalException
C RubyStandardError
C RubyStopIteration
C RubyString
C RubyStruct
C RubySymbol
C RubySyntaxError
C RubySystemCallError
C RubySystemExit
C RubySystemStackError
C RubyThread
C RubyThreadError
C RubyThreadGroup
C RubyTime
C RubyTypeError
C RubyUnboundMethod
C RubyUncaughtThrowError
C RubyYielder
C RubyZeroDivisionError
C TopSelfFactory
RubySecurityError — members 0+
from IRubyObject
F NULL_ARRAY IRubyObject[]
M check_string_type19() IRubyObject
M dup(context) IRubyObject
C marshal_live_variables(stream, context, out)
from RubyBasicObject
F ALL_F int
F BASICOBJECT_ALLOCATOR ObjectAllocator
F ERR_INSECURE_SET_INST_VAR String
F FALSE_F int
F FROZEN_F int
F NEVER IRubyObject
F NIL_F int
F STAMP_OFFSET long
F TAINTED_F int
F UNDEF IRubyObject
F VAR_TABLE_OFFSET long
F varTable Object[]
F varTableStamp byte
M __id__(context) RubyInteger
C add_finalizer(f)
M add_finalizer(context, f) IRubyObject
M any_to_string() IRubyObject
M as_java_string() String
M as_string() RubyString
M call_method(context, name) IRubyObject
M call_method(context, name, arg) IRubyObject
M call_method(context, name, args) IRubyObject
M call_method(name, args) IRubyObject
M call_method(name, arg) IRubyObject
M call_method(name) IRubyObject
M call_method(context, name, args, block) IRubyObject
M check_array_type() IRubyObject
M check_call_method(context, name) IRubyObject
M check_call_method(context, sites) IRubyObject
C check_frozen()
M check_string_type() IRubyObject
M class?() boolean
M compare_to(other) int
M convert_to_array() RubyArray
M convert_to_float() RubyFloat
M convert_to_hash() RubyHash
M convert_to_integer() RubyInteger
M convert_to_integer(convert_method) RubyInteger
M convert_to_string() RubyString
C copy_instance_variables_into(other)
M current_context() ThreadContext
M data_get_struct() Object
C data_wrap_struct(obj)
M decode(id) RubyString
M display(context, args) IRubyObject
M dup() IRubyObject
C ensure_instance_variables_settable()
M eql(other) boolean
M eql_p(obj) IRubyObject
M eql_p(context, obj) IRubyObject
M equal_p(context, other) IRubyObject
M eval_under(context, under, src, file, line, eval_type) IRubyObject
M extend(args) IRubyObject
M false?() boolean
M ffi_handle() Object
C ffi_handle=(value)
C for_each_instance_variable(accessor)
C for_each_instance_variable_name(consumer)
M freeze(context) IRubyObject
C frozen=(frozen)
M frozen?() boolean
M frozen_p(context) RubyBoolean
M get_flag(flag) boolean
M get_instance_variable(name) IRubyObject
M get_internal_variable(name) Object
M get_variable(index) Object
M has_instance_variable(name) boolean
M has_internal_variable(name) boolean
M has_variables?() boolean
M hash() RubyFixnum
M hash(context) RubyFixnum
M hashy_inspect() IRubyObject
M hashy_inspect(context) IRubyObject
M id() IRubyObject
M immediate?() boolean
M infect_by(obj) IRubyObject
M initialize_copy(original) IRubyObject
M initialize_copy(context, original) IRubyObject
M inspect() IRubyObject
M instance_eval(context, block) IRubyObject
M instance_eval(context, arg0, block) IRubyObject
M instance_eval(context, arg0, arg1, block) IRubyObject
M instance_eval(context, arg0, arg1, arg2, block) IRubyObject
M instance_eval(context, args, block) IRubyObject
M instance_exec(context, args, block) IRubyObject
M instance_of_p(context, type) RubyBoolean
M instance_variable_defined_p(context, name) IRubyObject
M instance_variable_get(context, name) IRubyObject
M instance_variable_list() IRubyObject>>
M instance_variable_name_list() List<String>
M instance_variable_set(name, value) IRubyObject
M instance_variables() InstanceVariables
M instance_variables(context) RubyArray
M internal_variables() InternalVariables
M is_builtin(method_name) boolean
M java_class() Class<?>
M kind_of_p(context, type) RubyBoolean
M make_meta_class(super_class) RubyClass
M make_meta_class(context, super_class) RubyClass
M make_meta_class_bootstrap(runtime, super_class, class) RubyClass
M marshal_variable_list() Variable<Object>>
M meta_class() RubyClass
C meta_class=(meta_class)
M method(name) IRubyObject
M method(name, refined_scope) IRubyObject
M method(context, name, refined_scope) IRubyObject
M methods(context, args) IRubyObject
M module?() boolean
M nil?() boolean
M nil_p(context) IRubyObject
M op_cmp(context, other) IRubyObject
M op_match(context, arg) IRubyObject
M op_not(context) IRubyObject
M op_not_equal(context, other) IRubyObject
M op_not_match(context, arg) IRubyObject
M private_methods(context, args) IRubyObject
M protected_methods(context, args) IRubyObject
M public_methods(context, args) IRubyObject
M rb_clone() IRubyObject
M rb_clone(context, maybe_opts) IRubyObject
C remove_finalizers()
M remove_instance_variable(name) IRubyObject
M remove_instance_variable(context, name, block) IRubyObject
M remove_internal_variable(name) Object
M respond_to_p(mname) RubyBoolean
M responds_to(name) boolean
M responds_to_missing(name) boolean
M responds_to_missing(name, inc_private) boolean
M runtime() Ruby
M send(context, block) IRubyObject
M send(context, arg0, block) IRubyObject
M send(context, arg0, arg1, block) IRubyObject
M send(context, arg0, arg1, arg2, block) IRubyObject
M send(context, args, block) IRubyObject
C set_flag(flag, set)
M set_instance_variable(name, value) IRubyObject
C set_internal_variable(name, value)
C set_variable(index, value)
M singleton_class() RubyClass
M singleton_class(context) RubyClass
M singleton_method(name) IRubyObject
M singleton_method(context, name) IRubyObject
M singleton_methods(context, args) RubyArray
M special_const?() boolean
M special_object?() boolean
M specific_eval(context, mod, block, eval_type) IRubyObject
M specific_eval(context, mod, arg, block, eval_type) IRubyObject
M specific_eval(context, mod, arg0, arg1, block, eval_type) IRubyObject
M specific_eval(context, mod, arg0, arg1, arg2, block, eval_type) IRubyObject
C sync_variables(other)
M taint(context) IRubyObject
C taint=(taint)
M taint?() boolean
M tainted_p(context) RubyBoolean
M to_a(context) RubyArray
M to_s() IRubyObject
M true?() boolean
M type() RubyClass
M type() RubyClass
M untaint(context) IRubyObject
from RubyObject
F IVAR_INSPECTING_OBJECT_ALLOCATOR ObjectAllocator
F OBJECT_ALLOCATOR ObjectAllocator
F REIFYING_OBJECT_ALLOCATOR ObjectAllocator
C attach_to_object_space()
C call_init(args, block)
C call_init(block)
C call_init(arg0, block)
C call_init(arg0, arg1, block)
C call_init(arg0, arg1, arg2, block)
C call_init(context, args, block)
C call_init(context, block)
C call_init(context, arg0, block)
C call_init(context, arg0, arg1, block)
C call_init(context, arg0, arg1, arg2, block)
M equals(other) boolean
M hash_code() int
M native_class_index() ClassIndex
M op_eqq(context, other) IRubyObject
M to_ruby_string(context) RubyString
M to_string() String
from RubyException
F EXCEPTION_ALLOCATOR ObjectAllocator
F TRACE_HEAD int
F TRACE_MAX int
F TRACE_TAIL int
M backtrace() IRubyObject
M backtrace() IRubyObject
M backtrace_elements() RubyStackTraceElement[]
M backtrace_locations(context) IRubyObject
C capture_backtrace(context)
M cause(context) IRubyObject
M cause() Object
C cause=(cause)
C copy_special_instance_variables(clone)
M detailed_message(context) IRubyObject
M detailed_message(context, opts) IRubyObject
M detailed_message(context, args) IRubyObject
M exception(args) RubyException
M full_message(context) IRubyObject
M full_message(context, opts) IRubyObject
M initialize(context) IRubyObject
M initialize(context, arg0) IRubyObject
M initialize(context, arg0, arg1) IRubyObject
M initialize(args, block) IRubyObject
M inspect(context) RubyString
M message(context) IRubyObject
M message() IRubyObject
C message=(message)
M message_as_java_string() String
M op_equal(context, other) RubyBoolean
C prepare_integrated_backtrace(context, java_trace)
C print_backtrace(error_stream)
C print_backtrace(error_stream, skip)
M set_backtrace(obj) IRubyObject
M set_backtrace(context, obj) IRubyObject
C set_backtrace(context, obj)
C set_cause(context, cause)
M to_java(target) T
M to_s(context) IRubyObject
M to_throwable() RaiseException
M variable_list() Variable<Object>>
M variable_name_list() List<String>

org.jruby.RubySecurityError

class extends RubyException 0 members

The Java representation of a Ruby SecurityError.

Inherited

from IRubyObject

fieldtypenote
NULL_ARRAY IRubyObject[]

check_string_type19

IRubyObject check_string_type19 ( )
Java: checkStringType19()
Deprecated. Use #checkStringType() instead.

is this a string?

Returns: the string if so

dup

IRubyObject dup ( ThreadContext context )
Java: dup(org.jruby.runtime.ThreadContext context)

RubyMethod dup.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context

Returns: a dup-ed object

marshal_live_variables

marshal_live_variables ( MarshalDumper stream, ThreadContext context, RubyOutputStream out )
Java: marshalLiveVariables(org.jruby.runtime.marshal.MarshalDumper stream, org.jruby.runtime.ThreadContext context, org.jruby.util.io.RubyOutputStream out)

from RubyBasicObject

fieldtypenote
ALL_F int
BASICOBJECT_ALLOCATOR ObjectAllocator 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.
ERR_INSECURE_SET_INST_VAR String The error message used when some one tries to modify an instance variable in a high security setting.
FALSE_F int
FROZEN_F int
NEVER IRubyObject A value that is used as a null sentinel in among other places the RubyArray implementation. It will cause large problems to call any methods on this object.
NIL_F int This flag is a bit funny. It's used to denote that this value is nil. It's a bit counterintuitive for a Java programmer to not use subclassing to handle this case, since we have a RubyNil subclass anyway. Well, the reason for it being a flag is that the #isNil() method is called extremely often. So often that it gives a good speed boost to make it monomorphic and final. It turns out using a flag for this actually gives us better performance than having a polymorphic #isNil() method.
STAMP_OFFSET long
TAINTED_F int
UNDEF IRubyObject A value that specifies an undefined value. This value is used as a sentinel for undefined constant values, and other places where neither null nor NEVER makes sense.
VAR_TABLE_OFFSET long
varTable Object[] variable table, lazily allocated as needed (if needed)
varTableStamp byte locking stamp for Unsafe ops updating the vartable

__id__

RubyInteger __id__ ( ThreadContext context )
Java: __id__(org.jruby.runtime.ThreadContext context)

rb_obj_id Return the internal id of an object.

add_finalizer

add_finalizer ( IRubyObject f )
Java: addFinalizer(org.jruby.runtime.builtin.IRubyObject f)

add_finalizer

IRubyObject add_finalizer ( ThreadContext context, IRubyObject f )
Java: addFinalizer(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject f)

Adds the specified object as a finalizer for this object.

any_to_string

IRubyObject any_to_string ( )
Java: anyToString()

Internal method that helps to convert any object into the format of a class name and a hex string inside of #<>.

as_java_string

String as_java_string ( )
Java: asJavaString()

rb_to_id Will try to convert this object to a String using the Ruby "to_str" if the object isn't already a String. If this still doesn't work, will throw a Ruby TypeError.

Returns: a (Java) string

as_string

RubyString as_string ( )
Java: asString()

rb_obj_as_string First converts this object into a String using the "to_s" method and returns it. If to_s doesn't return a Ruby String, Convert#anyToString is used instead.

call_method

IRubyObject call_method ( ThreadContext context, String name )
Java: callMethod(org.jruby.runtime.ThreadContext context, String name)

Will invoke a named method with no arguments and no block.

call_method

IRubyObject call_method ( ThreadContext context, String name, IRubyObject arg )
Java: callMethod(org.jruby.runtime.ThreadContext context, String name, org.jruby.runtime.builtin.IRubyObject arg)

Will invoke a named method with one argument and no block with functional invocation.

call_method

IRubyObject call_method ( ThreadContext context, String name, IRubyObject[] args )
Java: callMethod(org.jruby.runtime.ThreadContext context, String name, org.jruby.runtime.builtin.IRubyObject[] args)

Will invoke a named method with the supplied arguments and no block with functional invocation.

call_method

IRubyObject call_method ( String name, IRubyObject[] args )
Java: callMethod(String name, org.jruby.runtime.builtin.IRubyObject[] args)

call_method

IRubyObject call_method ( String name, IRubyObject arg )
Java: callMethod(String name, org.jruby.runtime.builtin.IRubyObject arg)

call_method

IRubyObject call_method ( String name )
Java: callMethod(String name)

call_method

IRubyObject call_method ( ThreadContext context, String name, IRubyObject[] args, Block block )
Java: callMethod(org.jruby.runtime.ThreadContext context, String name, org.jruby.runtime.builtin.IRubyObject[] args, org.jruby.runtime.Block block)

Will invoke a named method with the supplied arguments and supplied block with functional invocation.

check_array_type

IRubyObject check_array_type ( )
Java: checkArrayType()

rb_check_array_type Returns the result of trying to convert this object to an Array with "to_ary".

check_call_method

IRubyObject check_call_method ( ThreadContext context, String name )
Java: checkCallMethod(org.jruby.runtime.ThreadContext context, String name)

Will invoke a named method with no arguments and no block if that method or a custom method missing exists. Otherwise returns null. 1.9: rb_check_funcall

check_call_method

IRubyObject check_call_method ( ThreadContext context, JavaSites.CheckedSites sites )
Java: checkCallMethod(org.jruby.runtime.ThreadContext context, org.jruby.runtime.JavaSites.CheckedSites sites)

Will invoke a named method with no arguments and no block if that method or a custom method missing exists. Otherwise returns null. 1.9: rb_check_funcall

check_frozen

check_frozen ( )
Java: checkFrozen()

The actual method that checks frozen with the default frozen message from MRI. If possible, call this instead of #testFrozen.

check_string_type

IRubyObject check_string_type ( )
Java: checkStringType()

rb_check_string_type Tries to return a coerced string representation of this object, using "to_str". If that returns something other than a String or nil, an empty String will be returned.

class?

boolean class? ( )
Java: isClass() · also: is_class

Specifically polymorphic method that are meant to be overridden by classes to specify that they are classes in an easy way.

compare_to

int compare_to ( IRubyObject other )
Java: compareTo(org.jruby.runtime.builtin.IRubyObject other)

Compares this Ruby object with another.

nametypedescription
otherorg.jruby.runtime.builtin.IRubyObjectanother IRubyObject

Returns: 0 if equal, < 0 if this is less than other, > 0 if this is greater than other

convert_to_array

RubyArray convert_to_array ( )
Java: convertToArray()

Tries to convert this object to a Ruby Array using the "to_ary" method.

Returns: array representation of this

convert_to_float

RubyFloat convert_to_float ( )
Java: convertToFloat()

Tries to convert this object to a Ruby Float using the "to_f" method.

Returns: float representation of this

convert_to_hash

RubyHash convert_to_hash ( )
Java: convertToHash()

Tries to convert this object to a Ruby Hash using the "to_hash" method.

Returns: hash representation of this

convert_to_integer

RubyInteger convert_to_integer ( )
Java: convertToInteger()

Tries to convert this object to a Ruby Integer using the "to_int" method.

Returns: an integer representation of this

convert_to_integer

RubyInteger convert_to_integer ( String convert_method )
Java: convertToInteger(String convertMethod)

Tries to convert this object to a Ruby Integer using the supplied conversion method.

nametypedescription
convert_methodStringconversion method to use e.g. "to_i"

Returns: an integer representation of this

convert_to_string

RubyString convert_to_string ( )
Java: convertToString()

Tries to convert this object to a Ruby String using the "to_str" method.

Returns: a string representation of this

copy_instance_variables_into

copy_instance_variables_into ( InstanceVariables other )
Java: copyInstanceVariablesInto(org.jruby.runtime.builtin.InstanceVariables other)

current_context

ThreadContext current_context ( )
Java: getCurrentContext() · also: get_current_context

data_get_struct

Object data_get_struct ( )
Java: dataGetStruct()

data_wrap_struct

data_wrap_struct ( Object obj )
Java: dataWrapStruct(Object obj)

decode

RubyString decode ( String id )
Java: decode(String id)

raw (id) strings are not properly encoded but in an iso_8859_1 form. This method will lookup properly encoded string from the symbol table.

nametypedescription
idStringthe id of the string

Returns: the string of the symbol found from id

display

IRubyObject display ( ThreadContext context, IRubyObject[] args )
Java: display(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject[] args)

dup

IRubyObject dup ( )
Java: dup()

ensure_instance_variables_settable

ensure_instance_variables_settable ( )
Java: ensureInstanceVariablesSettable()

Makes sure that instance variables can be set on this object, including information about whether this object is frozen. Will throw a suitable exception in that case.

eql

boolean eql ( IRubyObject other )
Java: eql(org.jruby.runtime.builtin.IRubyObject other)

method used for Hash key comparison (specialized for String, Symbol and Fixnum)

Returns: Will by default just call the Ruby method "eql?"

eql_p

IRubyObject eql_p ( IRubyObject obj )
Java: eql_p(org.jruby.runtime.builtin.IRubyObject obj)

eql_p

IRubyObject eql_p ( ThreadContext context, IRubyObject obj )
Java: eql_p(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject obj)

equal_p

IRubyObject equal_p ( ThreadContext context, IRubyObject other )
Java: equal_p(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject other)

rb_obj_equal Will use Java identity equality.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
otherorg.jruby.runtime.builtin.IRubyObjectto compare with

Returns: are they equal?

eval_under

IRubyObject eval_under ( ThreadContext context, RubyModule under, RubyString src, String file, int line, EvalType eval_type )
Java: evalUnder(org.jruby.runtime.ThreadContext context, org.jruby.RubyModule under, org.jruby.RubyString src, String file, int line, org.jruby.EvalType evalType)

extend

IRubyObject extend ( IRubyObject[] args )
Java: extend(org.jruby.runtime.builtin.IRubyObject[] args)

rb_obj_extend call-seq: obj.extend(module, ...) => obj Adds to _obj_ the instance methods from each module given as a parameter. module Mod def hello "Hello from Mod.\n" end end class Klass def hello "Hello from Klass.\n" end end k = Klass.new k.hello #=> "Hello from Klass.\n" k.extend(Mod) #=> #<Klass:0x401b3bc8> k.hello #=> "Hello from Mod.\n"

nametypedescription
argsorg.jruby.runtime.builtin.IRubyObject[]to use as modules to extend

Returns: itself

false?

boolean false? ( )
Java: isFalse() · also: is_false

Is this value a falsey value or not?

Returns: true if falsey

ffi_handle

Object ffi_handle ( )
Java: getFFIHandle() · also: get_ffi_handle

ffi_handle=

ffi_handle= ( Object value )
Java: setFFIHandle(Object value) · also: set_ffi_handle

for_each_instance_variable

for_each_instance_variable ( BiConsumer<String,IRubyObject> accessor )
Java: forEachInstanceVariable(java.util.function.BiConsumer<String,org.jruby.runtime.builtin.IRubyObject> accessor)

for_each_instance_variable_name

for_each_instance_variable_name ( Consumer<String> consumer )
Java: forEachInstanceVariableName(java.util.function.Consumer<String> consumer)

freeze

IRubyObject freeze ( ThreadContext context )
Java: freeze(org.jruby.runtime.ThreadContext context)

frozen=

frozen= ( boolean frozen )
Java: setFrozen(boolean frozen) · also: set_frozen

Sets whether this object is frozen or not.

nametypedescription
frozenbooleanshould this object be frozen?

frozen?

boolean frozen? ( )
Java: isFrozen() · also: is_frozen

Is this value frozen or not?

Returns: true if this object is frozen, false otherwise

frozen_p

RubyBoolean frozen_p ( ThreadContext context )
Java: frozen_p(org.jruby.runtime.ThreadContext context)

get_flag

boolean get_flag ( int flag )
Java: getFlag(int flag)
Deprecated. external access to global object flags is going away

get_instance_variable

IRubyObject get_instance_variable ( String name )
Java: getInstanceVariable(String name)

get_internal_variable

Object get_internal_variable ( String name )
Java: getInternalVariable(String name)

get_variable

Object get_variable ( int index )
Java: getVariable(int index)

has_instance_variable

boolean has_instance_variable ( String name )
Java: hasInstanceVariable(String name)

has_internal_variable

boolean has_internal_variable ( String name )
Java: hasInternalVariable(String name)

has_variables?

boolean has_variables? ( )
Java: hasVariables() · also: has_variables

Returns true if object has any variables

hash

RubyFixnum hash ( )
Java: hash()
Deprecated. Use RubyBasicObject#hash(ThreadContext) instead.

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.

Returns: hash value

hash

RubyFixnum hash ( ThreadContext context )
Java: hash(org.jruby.runtime.ThreadContext context)

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.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe current thread context

Returns: the hash value

hashy_inspect

IRubyObject hashy_inspect ( )
Java: hashyInspect()

hashy_inspect

IRubyObject hashy_inspect ( ThreadContext context )
Java: hashyInspect(org.jruby.runtime.ThreadContext context)

id

IRubyObject id ( )
Java: id()

immediate?

boolean immediate? ( )
Java: isImmediate() · also: is_immediate

Is object immediate (def: Fixnum, Symbol, true, false, nil?).

infect_by

IRubyObject infect_by ( IRubyObject obj )
Java: infectBy(org.jruby.runtime.builtin.IRubyObject obj)

initialize_copy

IRubyObject initialize_copy ( IRubyObject original )
Java: initialize_copy(org.jruby.runtime.builtin.IRubyObject original)
Deprecated. Use org.jruby.RubyBasicObject#initialize_copy(ThreadContext, IRubyObject) instead.
nametypedescription
originalorg.jruby.runtime.builtin.IRubyObjectobject

Returns: a copy

initialize_copy

IRubyObject initialize_copy ( ThreadContext context, IRubyObject original )
Java: initialize_copy(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject original)

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.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
originalorg.jruby.runtime.builtin.IRubyObjectthe original

Returns: a copy unless the same thing

inspect

IRubyObject inspect ( )
Java: inspect()

instance_eval

IRubyObject instance_eval ( ThreadContext context, Block block )
Java: instance_eval(org.jruby.runtime.ThreadContext context, org.jruby.runtime.Block block)

instance_eval

IRubyObject instance_eval ( ThreadContext context, IRubyObject arg0, Block block )
Java: instance_eval(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.Block block)

instance_eval

IRubyObject instance_eval ( ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block )
Java: instance_eval(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.builtin.IRubyObject arg1, org.jruby.runtime.Block block)

instance_eval

IRubyObject instance_eval ( ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block )
Java: instance_eval(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.builtin.IRubyObject arg1, org.jruby.runtime.builtin.IRubyObject arg2, org.jruby.runtime.Block block)

instance_eval

IRubyObject instance_eval ( ThreadContext context, IRubyObject[] args, Block block )
Java: instance_eval(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject[] args, org.jruby.runtime.Block block)

instance_exec

IRubyObject instance_exec ( ThreadContext context, IRubyObject[] args, Block block )
Java: instance_exec(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject[] args, org.jruby.runtime.Block block)

rb_obj_instance_exec call-seq: obj.instance_exec(arg...) {|var...| block } => obj Executes the given block within the context of the receiver (_obj_). In order to set the context, the variable +self+ is set to _obj_ while the code is executing, giving the code access to _obj_'s instance variables. Arguments are passed as block parameters. class Klass def initialize @secret = 99 end end k = Klass.new k.instance_exec(5) {|x| @secret+x } #=> 104

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
argsorg.jruby.runtime.builtin.IRubyObject[]the args
blockorg.jruby.runtime.Blockblock

Returns: the result

instance_of_p

RubyBoolean instance_of_p ( ThreadContext context, IRubyObject type )
Java: instance_of_p(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject type)

rb_obj_is_instance_of call-seq: obj.instance_of?(class) => true or false Returns true if obj is an instance of the given class. See also Object#kind_of?.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
typeorg.jruby.runtime.builtin.IRubyObjectthe type

Returns: true if this is instance of type

instance_variable_defined_p

IRubyObject instance_variable_defined_p ( ThreadContext context, IRubyObject name )
Java: instance_variable_defined_p(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject name)

rb_obj_ivar_defined call-seq: obj.instance_variable_defined?(symbol) => true or false Returns true if the given instance variable is defined in obj. class Fred def initialize(p1, p2) @a, @b = p1, p2 end end fred = Fred.new('cat', 99) fred.instance_variable_defined?(:@a) #=> true fred.instance_variable_defined?("@b") #=> true fred.instance_variable_defined?("@c") #=> false

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
nameorg.jruby.runtime.builtin.IRubyObjectof ivar

Returns: true if defined

instance_variable_get

IRubyObject instance_variable_get ( ThreadContext context, IRubyObject name )
Java: instance_variable_get(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject name)

rb_obj_ivar_get call-seq: obj.instance_variable_get(symbol) => obj Returns the value of the given instance variable, or nil if the instance variable is not set. The @ part of the variable name should be included for regular instance variables. Throws a NameError exception if the supplied symbol is not valid as an instance variable name. class Fred def initialize(p1, p2) @a, @b = p1, p2 end end fred = Fred.new('cat', 99) fred.instance_variable_get(:@a) #=> "cat" fred.instance_variable_get("@b") #=> 99

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
nameorg.jruby.runtime.builtin.IRubyObjectof ivar

Returns: value of ivar

instance_variable_list

List<Variable<IRubyObject>> instance_variable_list ( )
Java: getInstanceVariableList() · also: get_instance_variable_list

Gets a list of all variables in this object.

instance_variable_name_list

List<String> instance_variable_name_list ( )
Java: getInstanceVariableNameList() · also: get_instance_variable_name_list

Gets a name list of all variables in this object.

instance_variable_set

IRubyObject instance_variable_set ( IRubyObject name, IRubyObject value )
Java: instance_variable_set(org.jruby.runtime.builtin.IRubyObject name, org.jruby.runtime.builtin.IRubyObject value)

rb_obj_ivar_set call-seq: obj.instance_variable_set(symbol, obj) => obj Sets the instance variable names by symbol to object, thereby frustrating the efforts of the class's author to attempt to provide proper encapsulation. The variable did not have to exist prior to this call. class Fred def initialize(p1, p2) @a, @b = p1, p2 end end fred = Fred.new('cat', 99) fred.instance_variable_set(:@a, 'dog') #=> "dog" fred.instance_variable_set(:@c, 'cat') #=> "cat" fred.inspect #=> "#<Fred:0x401b3da8 @a=\"dog\", @b=99, @c=\"cat\">"

nametypedescription
nameorg.jruby.runtime.builtin.IRubyObjectof ivar
valueorg.jruby.runtime.builtin.IRubyObjectto set

Returns: value of old set ivar

instance_variables

InstanceVariables instance_variables ( )
Java: getInstanceVariables() · also: get_instance_variables

Dummy method to avoid a cast, and to avoid polluting the IRubyObject interface with all the instance variable management methods.

instance_variables

RubyArray instance_variables ( ThreadContext context )
Java: instance_variables(org.jruby.runtime.ThreadContext context)

rb_obj_instance_variables call-seq: obj.instance_variables => array Returns an array of instance variable names for the receiver. Note that simply defining an accessor does not create the corresponding instance variable. class Fred attr_accessor :a1 def initialize @iv = 3 end end Fred.new.instance_variables #=> [:"@iv"]

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context

Returns: list of ivars

internal_variables

InternalVariables internal_variables ( )
Java: getInternalVariables() · also: get_internal_variables

Dummy method to avoid a cast, and to avoid polluting the IRubyObject interface with all the instance variable management methods.

is_builtin

boolean is_builtin ( String method_name )
Java: isBuiltin(String methodName)

A method to determine whether the method named by methodName is a builtin method, i.e. a method built-in to JRuby and loaded during its core boot process.

nametypedescription
method_nameStringto look for.

Returns: true if so

java_class

Class<?> java_class ( )
Java: getJavaClass() · also: get_java_class

Will return the Java interface that most closely can represent this object, when working through Java integration translations.

Returns: the true Java class of this (Ruby) object

kind_of_p

RubyBoolean kind_of_p ( ThreadContext context, IRubyObject type )
Java: kind_of_p(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject type)

rb_obj_is_kind_of call-seq: obj.is_a?(class) => true or false obj.kind_of?(class) => true or false Returns true if class is the class of obj, or if class is one of the superclasses of obj or modules included in obj. module M; end class A include M end class B < A; end class C < B; end b = B.new b.instance_of? A #=> false b.instance_of? B #=> true b.instance_of? C #=> false b.instance_of? M #=> false b.kind_of? A #=> true b.kind_of? B #=> true b.kind_of? C #=> false b.kind_of? M #=> true

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
typeorg.jruby.runtime.builtin.IRubyObjectthe type

Returns: true if this is kind of type

make_meta_class

RubyClass make_meta_class ( RubyClass super_class )
Java: makeMetaClass(org.jruby.RubyClass superClass)

make_meta_class

RubyClass make_meta_class ( ThreadContext context, RubyClass super_class )
Java: makeMetaClass(org.jruby.runtime.ThreadContext context, org.jruby.RubyClass superClass)

rb_make_metaclass Will create a new meta class, insert this in the chain of classes for this specific object, and return the generated meta class.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
super_classorg.jruby.RubyClassthe super class

Returns: the new meta class

make_meta_class_bootstrap

RubyClass make_meta_class_bootstrap ( Ruby runtime, RubyClass super_class, RubyClass class )
Java: makeMetaClassBootstrap(org.jruby.Ruby runtime, org.jruby.RubyClass superClass, org.jruby.RubyClass Class)

This will create a new metaclass. This is only used during bootstrapping before the initial ThreadContext is defined. Normal needs of making a metaclass should use RubyBasicObject#makeMetaClass(ThreadContext, RubyClass)

nametypedescription
runtimeorg.jruby.Rubythe runtime
super_classorg.jruby.RubyClassof the metaclass
classorg.jruby.RubyClassa reference to Ruby Class

Returns: the new metaclass

marshal_variable_list

List<Variable<Object>> marshal_variable_list ( )
Java: getMarshalVariableList() · also: get_marshal_variable_list

meta_class

RubyClass meta_class ( )
Java: getMetaClass() · also: get_meta_class

if exist return the meta-class else return the type of the object.

meta_class=

meta_class= ( RubyClass meta_class )
Java: setMetaClass(org.jruby.RubyClass metaClass) · also: set_meta_class

Makes it possible to change the metaclass of an object. In practice, this is a simple version of Smalltalks Become, except that it doesn't work when we're dealing with subclasses. In practice it's used to change the singleton/meta class used, without changing the "real" inheritance chain.

nametypedescription
meta_classorg.jruby.RubyClassthe meta class to set

method

IRubyObject method ( IRubyObject name )
Java: method(org.jruby.runtime.builtin.IRubyObject name)

method

IRubyObject method ( IRubyObject name, StaticScope refined_scope )
Java: method(org.jruby.runtime.builtin.IRubyObject name, org.jruby.parser.StaticScope refinedScope)

method

IRubyObject method ( ThreadContext context, IRubyObject name, StaticScope refined_scope )
Java: method(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject name, org.jruby.parser.StaticScope refinedScope)

Like #method(IRubyObject) but using the given refinement scope to search for the method.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
nameorg.jruby.runtime.builtin.IRubyObjectthe name of the method
refined_scopeorg.jruby.parser.StaticScopethe static scope for the caller method

Returns: method instance

methods

IRubyObject methods ( ThreadContext context, IRubyObject[] args )
Java: methods(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject[] args)

rb_obj_methods call-seq: obj.methods => array Returns a list of the names of methods publicly accessible in obj. This will include all the methods accessible in obj's ancestors. class Klass def kMethod() end end k = Klass.new k.methods[0..9] #=> ["kMethod", "freeze", "nil?", "is_a?", "class", "instance_variable_set", "methods", "extend", "__send__", "instance_eval"] k.methods.length #=> 42

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
argsorg.jruby.runtime.builtin.IRubyObject[]include ancestors

Returns: methods

module?

boolean module? ( )
Java: isModule() · also: is_module

Specifically polymorphic method that are meant to be overridden by modules to specify that they are modules in an easy way.

nil?

boolean nil? ( )
Java: isNil() · also: is_nil

Does this object represent nil?

Returns: true if nil

nil_p

IRubyObject nil_p ( ThreadContext context )
Java: nil_p(org.jruby.runtime.ThreadContext context)

rb_false call_seq: nil.nil? => true <anything_else>.nil? => false Only the object nil responds true to nil?.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context

Returns: true if nil

op_cmp

IRubyObject op_cmp ( ThreadContext context, IRubyObject other )
Java: op_cmp(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject other)

op_match

IRubyObject op_match ( ThreadContext context, IRubyObject arg )
Java: op_match(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject arg)

rb_obj_pattern_match call-seq: obj =~ other => nil Pattern Match---Overridden by descendents (notably Regexp and String) to provide meaningful pattern-match semantics.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
argorg.jruby.runtime.builtin.IRubyObjectarg

Returns: true if matches (always nil)

op_not

IRubyObject op_not ( ThreadContext context )
Java: op_not(org.jruby.runtime.ThreadContext context)

op_not_equal

IRubyObject op_not_equal ( ThreadContext context, IRubyObject other )
Java: op_not_equal(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject other)

The != method implemented for BasicObject.

nametypedescription
contextorg.jruby.runtime.ThreadContextthread context
otherorg.jruby.runtime.builtin.IRubyObjectother object

Returns: false if this == other, true otherwise

op_not_match

IRubyObject op_not_match ( ThreadContext context, IRubyObject arg )
Java: op_not_match(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject arg)

Invert the match operator.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
argorg.jruby.runtime.builtin.IRubyObjectarg

Returns: true if they do not match

private_methods

IRubyObject private_methods ( ThreadContext context, IRubyObject[] args )
Java: private_methods(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject[] args)

protected_methods

IRubyObject protected_methods ( ThreadContext context, IRubyObject[] args )
Java: protected_methods(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject[] args)

public_methods

IRubyObject public_methods ( ThreadContext context, IRubyObject[] args )
Java: public_methods(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject[] args)

rb_clone

IRubyObject rb_clone ( )
Java: rbClone()

rb_clone

IRubyObject rb_clone ( ThreadContext context, IRubyObject maybe_opts )
Java: rbClone(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject maybeOpts)

remove_finalizers

remove_finalizers ( )
Java: removeFinalizers()

Remove all the finalizers for this object.

remove_instance_variable

IRubyObject remove_instance_variable ( String name )
Java: removeInstanceVariable(String name)

remove_instance_variable

IRubyObject remove_instance_variable ( ThreadContext context, IRubyObject name, Block block )
Java: remove_instance_variable(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject name, org.jruby.runtime.Block block)

rb_obj_remove_instance_variable call-seq: obj.remove_instance_variable(symbol) => obj Removes the named instance variable from obj, returning that variable's value. class Dummy attr_reader :var def initialize @var = 99 end def remove remove_instance_variable(:@var) end end d = Dummy.new d.var #=> 99 d.remove #=> 99 d.var #=> nil

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
nameorg.jruby.runtime.builtin.IRubyObjectof ivar
blockorg.jruby.runtime.Blockthe block (not used)

Returns: value of removed ivar

remove_internal_variable

Object remove_internal_variable ( String name )
Java: removeInternalVariable(String name)

respond_to_p

RubyBoolean respond_to_p ( IRubyObject mname )
Java: respond_to_p(org.jruby.runtime.builtin.IRubyObject mname)

responds_to

boolean responds_to ( String name )
Java: respondsTo(String name)

Does this object respond to the specified message? Uses a shortcut if it can be proved that respond_to? and respond_to_missing? haven't been overridden.

responds_to_missing

boolean responds_to_missing ( String name )
Java: respondsToMissing(String name)

Does this object respond to the specified message via "method_missing?"

responds_to_missing

boolean responds_to_missing ( String name, boolean inc_private )
Java: respondsToMissing(String name, boolean incPrivate)

Does this object respond to the specified message via "method_missing?"

runtime

Ruby runtime ( )
Java: getRuntime() · also: get_runtime

Will return the runtime that this object is associated with.

Returns: current runtime

send

IRubyObject send ( ThreadContext context, Block block )
Java: send(org.jruby.runtime.ThreadContext context, org.jruby.runtime.Block block)

send

IRubyObject send ( ThreadContext context, IRubyObject arg0, Block block )
Java: send(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.Block block)

send

IRubyObject send ( ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block )
Java: send(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.builtin.IRubyObject arg1, org.jruby.runtime.Block block)

send

IRubyObject send ( ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block )
Java: send(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.builtin.IRubyObject arg1, org.jruby.runtime.builtin.IRubyObject arg2, org.jruby.runtime.Block block)

send

IRubyObject send ( ThreadContext context, IRubyObject[] args, Block block )
Java: send(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject[] args, org.jruby.runtime.Block block)

set_flag

set_flag ( int flag, boolean set )
Java: setFlag(int flag, boolean set)
Deprecated. external access to global object flags is going away

set_instance_variable

IRubyObject set_instance_variable ( String name, IRubyObject value )
Java: setInstanceVariable(String name, org.jruby.runtime.builtin.IRubyObject value)

rb_iv_set / rb_ivar_set

set_internal_variable

set_internal_variable ( String name, Object value )
Java: setInternalVariable(String name, Object value)

set_variable

set_variable ( int index, Object value )
Java: setVariable(int index, Object value)

singleton_class

RubyClass singleton_class ( )
Java: getSingletonClass() · also: get_singleton_class

singleton_class

RubyClass singleton_class ( ThreadContext context )
Java: singletonClass(org.jruby.runtime.ThreadContext context)

Will either return the existing singleton class for this object, or create a new one and return that. For a few types a singleton class is not possible so it will throw an error.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe current thread context

Returns: the singleton of this type

singleton_method

IRubyObject singleton_method ( IRubyObject name )
Java: singleton_method(org.jruby.runtime.builtin.IRubyObject name)

singleton_method

IRubyObject singleton_method ( ThreadContext context, IRubyObject name )
Java: singleton_method(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject name)

singleton_methods

RubyArray singleton_methods ( ThreadContext context, IRubyObject[] args )
Java: singleton_methods(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject[] args)

special_const?

boolean special_const? ( )
Java: isSpecialConst() · also: is_special_const

special_object?

boolean special_object? ( )
Java: isSpecialObject() · also: is_special_object

specific_eval

IRubyObject specific_eval ( ThreadContext context, RubyModule mod, Block block, EvalType eval_type )
Java: specificEval(org.jruby.runtime.ThreadContext context, org.jruby.RubyModule mod, org.jruby.runtime.Block block, org.jruby.EvalType evalType)

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.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
modorg.jruby.RubyModulemodule to yield in
blockorg.jruby.runtime.Blockto call
eval_typeorg.jruby.EvalTypetype of evaal to perform

Returns: the result

specific_eval

IRubyObject specific_eval ( ThreadContext context, RubyModule mod, IRubyObject arg, Block block, EvalType eval_type )
Java: specificEval(org.jruby.runtime.ThreadContext context, org.jruby.RubyModule mod, org.jruby.runtime.builtin.IRubyObject arg, org.jruby.runtime.Block block, org.jruby.EvalType evalType)

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.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
modorg.jruby.RubyModulemodule to yield in
argorg.jruby.runtime.builtin.IRubyObjectto pass to block
blockorg.jruby.runtime.Blockto call
eval_typeorg.jruby.EvalTypetype of evaal to perform

Returns: the result

specific_eval

IRubyObject specific_eval ( ThreadContext context, RubyModule mod, IRubyObject arg0, IRubyObject arg1, Block block, EvalType eval_type )
Java: specificEval(org.jruby.runtime.ThreadContext context, org.jruby.RubyModule mod, org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.builtin.IRubyObject arg1, org.jruby.runtime.Block block, org.jruby.EvalType evalType)

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.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
modorg.jruby.RubyModulemodule to yield in
arg0org.jruby.runtime.builtin.IRubyObjectto pass to block
arg1org.jruby.runtime.builtin.IRubyObjectto pass to block
blockorg.jruby.runtime.Blockto call
eval_typeorg.jruby.EvalTypetype of evaal to perform

Returns: the result

specific_eval

IRubyObject specific_eval ( ThreadContext context, RubyModule mod, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block, EvalType eval_type )
Java: specificEval(org.jruby.runtime.ThreadContext context, org.jruby.RubyModule mod, org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.builtin.IRubyObject arg1, org.jruby.runtime.builtin.IRubyObject arg2, org.jruby.runtime.Block block, org.jruby.EvalType evalType)

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.

nametypedescription
contextorg.jruby.runtime.ThreadContextthe thread context
modorg.jruby.RubyModulemodule to yield in
arg0org.jruby.runtime.builtin.IRubyObjectto pass to block
arg1org.jruby.runtime.builtin.IRubyObjectto pass to block
arg2org.jruby.runtime.builtin.IRubyObjectto pass to block
blockorg.jruby.runtime.Blockto call
eval_typeorg.jruby.EvalTypetype of evaal to perform

Returns: the result

sync_variables

sync_variables ( IRubyObject other )
Java: syncVariables(org.jruby.runtime.builtin.IRubyObject other)

Sync one this object's variables with other's - this is used to make rbClone work correctly.

taint

IRubyObject taint ( ThreadContext context )
Java: taint(org.jruby.runtime.ThreadContext context)

taint=

taint= ( boolean taint )
Java: setTaint(boolean taint) · also: set_taint

taint?

boolean taint? ( )
Java: isTaint() · also: is_taint

tainted_p

RubyBoolean tainted_p ( ThreadContext context )
Java: tainted_p(org.jruby.runtime.ThreadContext context)

to_a

RubyArray to_a ( ThreadContext context )
Java: to_a(org.jruby.runtime.ThreadContext context)

to_s

IRubyObject to_s ( )
Java: to_s()
Deprecated. Use RubyBasicObject#to_s(ThreadContext) instead.

Returns: ""

true?

boolean true? ( )
Java: isTrue() · also: is_true

Is this value a truthy value or not?

Returns: true if truthy

type

RubyClass type ( )
Java: getType() · also: get_type

type

RubyClass type ( )
Java: type()

rb_obj_class Returns the real class of this object, excluding any singleton/meta class in the inheritance chain.

Returns: the real class

untaint

IRubyObject untaint ( ThreadContext context )
Java: untaint(org.jruby.runtime.ThreadContext context)

from RubyObject

fieldtypenote
IVAR_INSPECTING_OBJECT_ALLOCATOR ObjectAllocator 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.
OBJECT_ALLOCATOR ObjectAllocator 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.
REIFYING_OBJECT_ALLOCATOR ObjectAllocator

attach_to_object_space

attach_to_object_space ( )
Java: attachToObjectSpace()

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

call_init

call_init ( IRubyObject[] args, Block block )
Java: callInit(org.jruby.runtime.builtin.IRubyObject[] args, org.jruby.runtime.Block block)

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

nametypedescription
argsorg.jruby.runtime.builtin.IRubyObject[]args
blockorg.jruby.runtime.Blockblock

call_init

call_init ( Block block )
Java: callInit(org.jruby.runtime.Block block)

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

nametypedescription
blockorg.jruby.runtime.Blockblock

call_init

call_init ( IRubyObject arg0, Block block )
Java: callInit(org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.Block block)

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

nametypedescription
arg0org.jruby.runtime.builtin.IRubyObjectarg0
blockorg.jruby.runtime.Blockblock

call_init

call_init ( IRubyObject arg0, IRubyObject arg1, Block block )
Java: callInit(org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.builtin.IRubyObject arg1, org.jruby.runtime.Block block)

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

nametypedescription
arg0org.jruby.runtime.builtin.IRubyObjectarg0
arg1org.jruby.runtime.builtin.IRubyObjectarg1
blockorg.jruby.runtime.Blockblock

call_init

call_init ( IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block )
Java: callInit(org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.builtin.IRubyObject arg1, org.jruby.runtime.builtin.IRubyObject arg2, org.jruby.runtime.Block block)

call_init

call_init ( ThreadContext context, IRubyObject[] args, Block block )
Java: callInit(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject[] args, org.jruby.runtime.Block block)

call_init

call_init ( ThreadContext context, Block block )
Java: callInit(org.jruby.runtime.ThreadContext context, org.jruby.runtime.Block block)

call_init

call_init ( ThreadContext context, IRubyObject arg0, Block block )
Java: callInit(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.Block block)

call_init

call_init ( ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block )
Java: callInit(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.builtin.IRubyObject arg1, org.jruby.runtime.Block block)

call_init

call_init ( ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block )
Java: callInit(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.builtin.IRubyObject arg1, org.jruby.runtime.builtin.IRubyObject arg2, org.jruby.runtime.Block block)

equals

boolean equals ( Object other )
Java: equals(Object other)

This override does not do a "checked" dispatch.

hash_code

int hash_code ( )
Java: hashCode()

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

Returns: the hash code

native_class_index

ClassIndex native_class_index ( )
Java: getNativeClassIndex() · also: get_native_class_index

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

op_eqq

IRubyObject op_eqq ( ThreadContext context, IRubyObject other )
Java: op_eqq(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.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.

to_ruby_string

RubyString to_ruby_string ( ThreadContext context )
Java: toRubyString(org.jruby.runtime.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.

nametypedescription
contextorg.jruby.runtime.ThreadContextthread context this is executing on.

Returns: the string.

to_string

String to_string ( )
Java: toString()

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

Returns: string representation

from RubyException

fieldtypenote
EXCEPTION_ALLOCATOR ObjectAllocator
TRACE_HEAD int
TRACE_MAX int
TRACE_TAIL int

backtrace

IRubyObject backtrace ( )
Java: backtrace()

backtrace

IRubyObject backtrace ( )
Java: getBacktrace() · also: get_backtrace

backtrace_elements

RubyStackTraceElement[] backtrace_elements ( )
Java: getBacktraceElements() · also: get_backtrace_elements

backtrace_locations

IRubyObject backtrace_locations ( ThreadContext context )
Java: backtrace_locations(org.jruby.runtime.ThreadContext context)

capture_backtrace

capture_backtrace ( ThreadContext context )
Java: captureBacktrace(org.jruby.runtime.ThreadContext context)

cause

IRubyObject cause ( ThreadContext context )
Java: cause(org.jruby.runtime.ThreadContext context)

cause

Object cause ( )
Java: getCause() · also: get_cause

cause=

cause= ( IRubyObject cause )
Java: setCause(org.jruby.runtime.builtin.IRubyObject cause) · also: set_cause

copy_special_instance_variables

copy_special_instance_variables ( IRubyObject clone )
Java: copySpecialInstanceVariables(org.jruby.runtime.builtin.IRubyObject clone)

detailed_message

IRubyObject detailed_message ( ThreadContext context )
Java: detailed_message(org.jruby.runtime.ThreadContext context)

detailed_message

IRubyObject detailed_message ( ThreadContext context, IRubyObject opts )
Java: detailed_message(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject opts)

detailed_message

IRubyObject detailed_message ( ThreadContext context, IRubyObject[] args )
Java: detailed_message(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject[] args)

exception

RubyException exception ( IRubyObject[] args )
Java: exception(org.jruby.runtime.builtin.IRubyObject[] args)

full_message

IRubyObject full_message ( ThreadContext context )
Java: full_message(org.jruby.runtime.ThreadContext context)

full_message

IRubyObject full_message ( ThreadContext context, IRubyObject opts )
Java: full_message(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject opts)

initialize

IRubyObject initialize ( ThreadContext context )
Java: initialize(org.jruby.runtime.ThreadContext context)

initialize

IRubyObject initialize ( ThreadContext context, IRubyObject arg0 )
Java: initialize(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject arg0)

initialize

IRubyObject initialize ( ThreadContext context, IRubyObject arg0, IRubyObject arg1 )
Java: initialize(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject arg0, org.jruby.runtime.builtin.IRubyObject arg1)

initialize

IRubyObject initialize ( IRubyObject[] args, Block block )
Java: initialize(org.jruby.runtime.builtin.IRubyObject[] args, org.jruby.runtime.Block block)

inspect

RubyString inspect ( ThreadContext context )
Java: inspect(org.jruby.runtime.ThreadContext context)

inspects an object and return a kind of debug information

Returns: A RubyString containing the debug information.

message

IRubyObject message ( ThreadContext context )
Java: message(org.jruby.runtime.ThreadContext context)

message

IRubyObject message ( )
Java: getMessage() · also: get_message

Returns: error message if provided or nil

message=

message= ( IRubyObject message )
Java: setMessage(org.jruby.runtime.builtin.IRubyObject message) · also: set_message

Set the message for this NameError.

nametypedescription
messageorg.jruby.runtime.builtin.IRubyObjectthe message

message_as_java_string

String message_as_java_string ( )
Java: getMessageAsJavaString() · also: get_message_as_java_string

op_equal

RubyBoolean op_equal ( ThreadContext context, IRubyObject other )
Java: op_equal(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject other)

prepare_integrated_backtrace

prepare_integrated_backtrace ( ThreadContext context, StackTraceElement[] java_trace )
Java: prepareIntegratedBacktrace(org.jruby.runtime.ThreadContext context, StackTraceElement[] javaTrace)

print_backtrace

print_backtrace ( PrintStream error_stream )
Java: printBacktrace(java.io.PrintStream errorStream)

Print the Ruby exception's backtrace to the given PrintStream.

nametypedescription
error_streamjava.io.PrintStreamthe PrintStream to which backtrace should be printed

print_backtrace

print_backtrace ( PrintStream error_stream, int skip )
Java: printBacktrace(java.io.PrintStream errorStream, int skip)

Print the Ruby exception's backtrace to the given PrintStream. This version accepts a number of lines to skip and is primarily used internally for exception printing where the first line is treated specially.

nametypedescription
error_streamjava.io.PrintStreamthe PrintStream to which backtrace should be printed

set_backtrace

IRubyObject set_backtrace ( IRubyObject obj )
Java: set_backtrace(org.jruby.runtime.builtin.IRubyObject obj)

set_backtrace

IRubyObject set_backtrace ( ThreadContext context, IRubyObject obj )
Java: set_backtrace(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject obj)

set_backtrace

set_backtrace ( ThreadContext context, IRubyObject obj )
Java: setBacktrace(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject obj)

set_cause

set_cause ( ThreadContext context, IRubyObject cause )
Java: setCause(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject cause)

to_java

T to_java ( Class<T> target )
Java: toJava(Class<T> target)

Coerce this Ruby exception to the requested Java type, if possible. If the requested type is a supertype of RaiseException, the attached throwable will be returned. Otherwise, it will fall back on RubyBasicObject toJava logic.

nametypedescription
targetClass<T>the target type to which this object should be converted

Returns: the converted result

to_s

IRubyObject to_s ( ThreadContext context )
Java: to_s(org.jruby.runtime.ThreadContext context)

to_throwable

RaiseException to_throwable ( )
Java: toThrowable()

Get a throwable suitable for throwing in Java. The throwable here will be constructed lazily by calling constructThrowable and then cached for future calls. All throwables returned by Ruby exception objects will descend from RaiseException and follow the Throwable hierarchy below Exception

variable_list

List<Variable<Object>> variable_list ( )
Java: getVariableList() · also: get_variable_list

variable_name_list

List<String> variable_name_list ( )
Java: getVariableNameList() · also: get_variable_name_list