jruby/docs BETA
Navigation
org.jruby.ext.ffi 33
C AbstractInvoker
C AbstractMemory
I AllocatedDirectMemoryIO
C ArrayMemoryIO
C AutoPointer
C Buffer
C CallbackInfo
C CallbackManager
C DataConverter
C Enums
C FFI
C FFIService
C Factory
C FreedMemoryIO
C IOModule
C InvalidMemoryIO
C MappedType
C MemoryIO
C MemoryObject
C MemoryPointer
C MemoryUtil
E NativeType
C NoImplFactory
C NullMemoryIO
C Platform
C Pointer
C Struct
C StructByValue
C StructLayout
C SwappedMemoryIO
C Type
C TypeResolver
C Util
StructByValue — members 7+
M create_struct_by_value_class(context, ffi, type) RubyClass
M layout(context) IRubyObject
M new_struct_by_value(context, klass, struct_class1) IRubyObject
M struct_class(context) IRubyObject
M struct_class() RubyClass
M struct_layout() StructLayout
M to_s(context) IRubyObject
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 COMPARE_BY_IDENTITY_F int
F ERR_INSECURE_SET_INST_VAR String
F FALSE_F int
F FL_USHIFT int
F FROZEN_F int
F IS_OVERLAID_F int
F NEVER IRubyObject
F NIL_F int
F REFINED_MODULE_F int
F STAMP_OFFSET long
F TAINTED_F int
F UNDEF IRubyObject
F USER0_F int
F USER1_F int
F USER2_F int
F USER3_F int
F USER4_F int
F USER5_F int
F USER6_F int
F USER7_F int
F USER8_F int
F USER9_F int
F USERA_F int
F VAR_TABLE_OFFSET long
F varTable Object[]
F varTableStamp int
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 call_method(context, method_index, name) IRubyObject
M call_method(context, method_index, name, arg) IRubyObject
M call_super(context, 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_integer(method_index, convert_method) RubyInteger
M convert_to_string() RubyString
C copy_instance_variables_into(other)
C copy_special_instance_variables(clone)
M current_context() ThreadContext
M data_get_struct() Object
M data_get_struct_checked() 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 fast_get_instance_variable(interned_name) IRubyObject
M fast_get_internal_variable(interned_name) Object
M fast_has_instance_variable(interned_name) boolean
M fast_has_internal_variable(interned_name) boolean
M fast_set_instance_variable(interned_name, value) IRubyObject
C fast_set_internal_variable(interned_name, value)
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 id() IRubyObject
M immediate?() boolean
M infect_by(obj) IRubyObject
M initialize(context) IRubyObject
M initialize_copy(original) IRubyObject
M initialize_copy(context, original) IRubyObject
M inspect() IRubyObject
M inspect(context) 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 methods(context, args, use_symbols) IRubyObject
M module?() boolean
M native_handle() Object
C native_handle=(value)
M native_type_index() int
M nil?() boolean
M nil_p(context) IRubyObject
M op_cmp(context, other) IRubyObject
M op_equal(context, obj) 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 respond_to_p(mname, include_private) 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)
C sync_variables(variables)
M taint(context) IRubyObject
C taint=(taint)
M taint?() boolean
M tainted_p(context) RubyBoolean
M to_a(context) RubyArray
M to_a() RubyArray
M to_java(target) T
M to_s() IRubyObject
M true?() boolean
M trust(context) IRubyObject
M type() RubyClass
M type() RubyClass
M untaint(context) IRubyObject
M untrust(context) IRubyObject
C untrusted=(untrusted)
M untrusted?() boolean
M untrusted_p(context) RubyBoolean
M variable_count() int
M variable_list() Variable<Object>>
M variable_name_list() List<String>
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 convert_to_type(target, convert_method_index) IRubyObject
M equals(other) boolean
M hash_code() int
M native_class_index() ClassIndex
M op_eqq(context, other) IRubyObject
M specific_eval(context, mod, args, block, eval_type) IRubyObject
M to_ruby_string(context) RubyString
M to_string() String
from Type
M alignment(context) IRubyObject
M native_alignment() int
M native_size() int
M native_type() NativeType
M size(context) IRubyObject

org.jruby.ext.ffi.StructByValue

class final extends Type 7 members

Class Methods

create_struct_by_value_class

RubyClass create_struct_by_value_class ( ThreadContext context, RubyModule ffi, RubyClass type )
Java: createStructByValueClass(org.jruby.runtime.ThreadContext context, org.jruby.RubyModule FFI, org.jruby.RubyClass Type)

new_struct_by_value

IRubyObject new_struct_by_value ( ThreadContext context, IRubyObject klass, IRubyObject struct_class1 )
Java: newStructByValue(org.jruby.runtime.ThreadContext context, org.jruby.runtime.builtin.IRubyObject klass, org.jruby.runtime.builtin.IRubyObject structClass1)

Instance Methods

layout

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

struct_class

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

struct_class

RubyClass struct_class ( )
Java: getStructClass() · also: get_struct_class

struct_layout

StructLayout struct_layout ( )
Java: getStructLayout() · also: get_struct_layout

to_s

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

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.
COMPARE_BY_IDENTITY_F int
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
FL_USHIFT int
FROZEN_F int
IS_OVERLAID_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.
REFINED_MODULE_F int
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.
USER0_F int
USER1_F int
USER2_F int
USER3_F int
USER4_F int
USER5_F int
USER6_F int
USER7_F int
USER8_F int
USER9_F int
USERA_F int
VAR_TABLE_OFFSET long
varTable Object[] variable table, lazily allocated as needed (if needed)
varTableStamp int 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.

call_method

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

call_method

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

call_super

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

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_integer

RubyInteger convert_to_integer ( int method_index, String convert_method )
Java: convertToInteger(int methodIndex, String convertMethod)

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)

copy_special_instance_variables

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

Lots of MRI objects keep their state in non-lookupable ivars (e:g. Range, Struct, etc). This method is responsible for dupping our java field equivalents

current_context

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

data_get_struct

Object data_get_struct ( )
Java: dataGetStruct()

data_get_struct_checked

Object data_get_struct_checked ( )
Java: dataGetStructChecked()

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? Based on the #FALSE_F flag.

Returns: true is false

fast_get_instance_variable

IRubyObject fast_get_instance_variable ( String interned_name )
Java: fastGetInstanceVariable(String internedName)

fast_get_internal_variable

Object fast_get_internal_variable ( String interned_name )
Java: fastGetInternalVariable(String internedName)

fast_has_instance_variable

boolean fast_has_instance_variable ( String interned_name )
Java: fastHasInstanceVariable(String internedName)

fast_has_internal_variable

boolean fast_has_internal_variable ( String interned_name )
Java: fastHasInternalVariable(String internedName)

fast_set_instance_variable

IRubyObject fast_set_instance_variable ( String interned_name, IRubyObject value )
Java: fastSetInstanceVariable(String internedName, org.jruby.runtime.builtin.IRubyObject value)

fast_set_internal_variable

fast_set_internal_variable ( String interned_name, Object value )
Java: fastSetInternalVariable(String internedName, Object value)

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. Shortcut for doing setFlag(FROZEN_F, frozen).

nametypedescription
frozenbooleanshould this object be frozen?

frozen?

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

Is this value frozen or not? Shortcut for doing getFlag(FROZEN_F).

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)

Get the value of a custom flag on this object. The only guaranteed flags that can be sent in to this method is:

  • #FALSE_F
  • #NIL_F
  • #FROZEN_F

nametypedescription
flagintthe flag to get

Returns: true if the flag is set, false otherwise

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

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

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

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

inspect

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

Returns a string containing a human-readable representation of obj. If not overridden, uses the to_s method to generate the string. [ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]" Time.new.inspect #=> "Wed Apr 09 08:54:39 CDT 2003"

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

methods

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

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.

native_handle

Object native_handle ( )
Java: getNativeHandle() · also: get_native_handle

native_handle=

native_handle= ( Object value )
Java: setNativeHandle(Object value) · also: set_native_handle

native_type_index

int native_type_index ( )
Java: getNativeTypeIndex() · also: get_native_type_index

nil?

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

Does this object represent nil? See the docs for the #NIL_F flag for more information.

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_equal

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

rb_obj_equal Will by default use identity equality to compare objects. This follows the Ruby semantics. The name of this method doesn't follow the convention because hierarchy problems

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)

respond_to_p

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

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)

Sets or unsets a flag on this object. The only flags that are guaranteed to be valid to use as the first argument is:

  • #FALSE_F
  • #NIL_F
  • #FROZEN_F

nametypedescription
flagintthe actual flag to set or unset.
setbooleanif true, the flag will be set, if false, the flag will be unset.

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.

sync_variables

sync_variables ( List<Variable<Object>> variables )
Java: syncVariables(List<org.jruby.runtime.builtin.Variable<Object>> variables)

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_a

RubyArray to_a ( )
Java: to_a()

to_java

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

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? Based on the #FALSE_F flag.

Returns: true it truthy

trust

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

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)

untrust

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

untrusted=

untrusted= ( boolean untrusted )
Java: setUntrusted(boolean untrusted) · also: set_untrusted

untrusted?

boolean untrusted? ( )
Java: isUntrusted() · also: is_untrusted

untrusted_p

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

variable_count

int variable_count ( )
Java: getVariableCount() · also: get_variable_count

variable_list

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

Gets a list of all variables in this object.

variable_name_list

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

Gets a name list of all variables in this object.

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)

convert_to_type

IRubyObject convert_to_type ( RubyClass target, int convert_method_index )
Java: convertToType(org.jruby.RubyClass target, int convertMethodIndex)

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.

specific_eval

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

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 Type

alignment

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

Gets the native alignment of this Type in bytes

nametypedescription
contextorg.jruby.runtime.ThreadContextThe Ruby thread context.

Returns: The native alignment of this Type.

native_alignment

int native_alignment ( )
Java: getNativeAlignment() · also: get_native_alignment

Gets the native alignment of this Type in bytes

Returns: The native alignment of this Type.

native_size

int native_size ( )
Java: getNativeSize() · also: get_native_size

Gets the native size of this Type in bytes

Returns: The native size of this Type.

native_type

NativeType native_type ( )
Java: getNativeType() · also: get_native_type

Gets the native type of this Type when passed as a parameter

Returns: The native type of this Type.

size

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

Gets the native size of this Type in bytes

nametypedescription
contextorg.jruby.runtime.ThreadContextThe Ruby thread context.

Returns: The native size of this Type.