Package org.jruby

Class RubyClass

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyModule

org.jruby.RubyClass

All Implemented Interfaces:

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

Direct Known Subclasses:

IncludedModule, MetaClass, PrependedModule

public class RubyClass
extends RubyModule

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RubyClass.ConcreteJavaReifier
static enum	RubyClass.CS_NAMES

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

RubyModule.Autoload, RubyModule.AutoloadMethod, RubyModule.CacheEntryFactory, RubyModule.ConstantEntry, RubyModule.InvalidatorList<T>, RubyModule.JavaClassKindOf, RubyModule.KindOf, RubyModule.MethodClumper, RubyModule.ModuleKernelMethods, RubyModule.ProfilingCacheEntryFactory, RubyModule.RefinementMethods, RubyModule.RespondToMissingMethod, RubyModule.SourceLocation, RubyModule.SynchronizedCacheEntryFactory, RubyModule.WrapperCacheEntryFactory

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

RubyObject.Data

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

RubyBasicObject.Finalizer

Field Summary

Fields

Modifier and Type	Field	Description
static final ObjectAllocator	CLASS_ALLOCATOR
static final int	CS_IDX_INITIALIZE
protected static final ObjectMarshal	DEFAULT_OBJECT_MARSHAL
protected ObjectMarshal	marshal
protected final Ruby	runtime

Fields inherited from class org.jruby.RubyModule

baseName, BUILTIN_CONSTANT, cachedMethods, CACHEPROXY_F, classIndex, generation, generationObject, id, INCLUDED_INTO_REFINEMENT, includingHierarchies, index, IS_OVERLAID_F, kindOf, methodInvalidator, methodLocation, methods, MODULE_ALLOCATOR, NEEDSIMPL_F, NormalCacheEntryFactory, OMOD_SHARED, parent, REFINED_MODULE_F, SCOPE_CAPTURING_METHODS, superClass, TEMPORARY_NAME

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, metaClass, NEVER, NIL_F, STAMP_OFFSET, TAINTED_F, UNDEF, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RubyClass(Ruby runtime)	used by CLASS_ALLOCATOR (any Class' class will be a Class!) also used to bootstrap Object class
protected	RubyClass(Ruby runtime, RubyClass superClazz)	rb_class_boot (for plain Classes) also used to bootstrap Module and Class classes
protected	RubyClass(Ruby runtime, RubyClass superClass, boolean objectSpace)	separate path for MetaClass and IncludedModuleWrapper construction (rb_class_boot version for MetaClasses) no marshal, allocator initialization and addSubclass(this) here!
protected	RubyClass(Ruby runtime, RubyClass superClass, RubyClass Class)	This is an internal API only used by Ruby constructor before ThreadContext exists.
protected	RubyClass(Ruby runtime, RubyClass superClazz, CallSite[] extraCallSites)	A constructor which allows passing in an array of supplementary call sites.

Method Summary

Modifier and Type	Method	Description
void	addClassAnnotation(Class<?> annotation, Map fields)
void	addFieldAnnotation(String fieldName, Class<?> annotation, Map fields)
void	addFieldSignature(String fieldName, Class<?> type)
void	addMethodAnnotation(String methodName, Class<?> annotation, Map fields)
void	addMethodSignature(String methodName, Class<?>[] types)
void	addParameterAnnotation(String method, int i, Class<?> annoClass, Map<String,Object> value)
void	addSubclass(RubyClass subclass)	Add a new subclass to the weak set of subclasses.
IRubyObject	allocate()	Deprecated.
IRubyObject	allocate(ThreadContext context)
<T extends RubyClass> T	allocator(ObjectAllocator allocator)	Define an allocator for this class (usually this is part of Define.defineClass(ThreadContext, String, RubyClass, ObjectAllocator)).
IRubyObject	attached_object(ThreadContext context)
void	becomeSynchronized()	make this class and all subclasses sync
static void	checkInheritable(IRubyObject superClass)	Deprecated.
static void	checkInheritable(ThreadContext context, IRubyObject superClass)
boolean	checkMethodBasicDefinition(String name)
static RubyClass	createBootstrapClass(Ruby runtime, String name, RubyClass superClass, ObjectAllocator allocator)	boot_defclass Create an initial Object meta class before Module and Kernel dependencies have squirreled themselves together.
static void	finishClassClass(Ruby runtime, RubyClass Class)
static void	finishCreateClassClass(ThreadContext context, RubyClass Class)
IRubyObject	finvoke(ThreadContext context, IRubyObject self, String name)
IRubyObject	finvoke(ThreadContext context, IRubyObject self, String name, Block block)
IRubyObject	finvoke(ThreadContext context, IRubyObject self, String name, IRubyObject arg)
IRubyObject	finvoke(ThreadContext context, IRubyObject self, String name, IRubyObject[] args)
IRubyObject	finvoke(ThreadContext context, IRubyObject self, String name, IRubyObject[] args, Block block)
IRubyObject	finvoke(ThreadContext context, IRubyObject self, String name, IRubyObject arg, Block block)
IRubyObject	finvoke(ThreadContext context, IRubyObject self, String name, IRubyObject arg0, IRubyObject arg1)
IRubyObject	finvoke(ThreadContext context, IRubyObject self, String name, IRubyObject arg0, IRubyObject arg1, Block block)
IRubyObject	finvoke(ThreadContext context, IRubyObject self, String name, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)
IRubyObject	finvoke(ThreadContext context, IRubyObject self, String name, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)
final IRubyObject	finvokeChecked(ThreadContext context, IRubyObject self, String name)	Safely attempt to invoke the given method name on self, using respond_to? and method_missing as appropriate.
final IRubyObject	finvokeChecked(ThreadContext context, IRubyObject self, String name, IRubyObject... args)	Safely attempt to invoke the given method name on self, using respond_to? and method_missing as appropriate.
final IRubyObject	finvokeChecked(ThreadContext context, IRubyObject self, JavaSites.CheckedSites sites)	Safely attempt to invoke the given method name on self, using respond_to? and method_missing as appropriate.
final IRubyObject	finvokeChecked(ThreadContext context, IRubyObject self, JavaSites.CheckedSites sites, IRubyObject... args)	Safely attempt to invoke the given method name on self, using respond_to? and method_missing as appropriate.
IRubyObject	finvokeWithRefinements(ThreadContext context, IRubyObject self, StaticScope staticScope, String name, Block block)
IRubyObject	finvokeWithRefinements(ThreadContext context, IRubyObject self, StaticScope staticScope, String name, IRubyObject[] args, Block block)
IRubyObject	finvokeWithRefinements(ThreadContext context, IRubyObject self, StaticScope staticScope, String name, IRubyObject arg, Block block)
IRubyObject	finvokeWithRefinements(ThreadContext context, IRubyObject self, StaticScope staticScope, String name, IRubyObject arg0, IRubyObject arg1, Block block)
IRubyObject	finvokeWithRefinements(ThreadContext context, IRubyObject self, StaticScope staticScope, String name, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)
Map<String,List<Class<?>[]>>	getAllMethodSignatures()
ObjectAllocator	getAllocator()
CallSite	getBaseCallSite(int idx)
CallSite[]	getBaseCallSites()
Map<Class<?>,Map<String,Object>>	getClassAnnotations()
JavaClassConfiguration	getClassConfig()
final Ruby	getClassRuntime()
CallSite[]	getExtraCallSites()
VariableAccessorField	getFFIHandleAccessorField()	Deprecated.
VariableAccessor	getFFIHandleAccessorForRead()
VariableAccessor	getFFIHandleAccessorForWrite()
Map<String,Map<Class<?>,Map<String,Object>>>	getFieldAnnotations()
Map<String,Class<?>>	getFieldSignatures()
Boolean	getIsReifiedExtendedJavaClass()	If the current class is reified (null otherwise) and if it extends java
final ObjectMarshal	getMarshal()
Map<String,Map<Class<?>,Map<String,Object>>>	getMethodAnnotations()
Map<String,Class<?>[]>	getMethodSignatures()
ClassIndex	getNativeClassIndex()	This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
VariableAccessorField	getObjectGroupAccessorField()	Deprecated.
VariableAccessor	getObjectGroupAccessorForRead()
VariableAccessor	getObjectGroupAccessorForWrite()
VariableAccessorField	getObjectIdAccessorField()	Deprecated.
Map<String,List<Map<Class<?>,Map<String,Object>>>>	getParameterAnnotations()
PositionAware	getPositionOrDefault(DynamicMethod method)
final RubyClass	getRealClass()	Get the "real" class, either the current one or the nearest ancestor that is not a singleton or include wrapper.
RubyModule	getRealModule()	Equivalent to getRealClass().
Class<? extends Reified>	getReifiedClass()	Deprecated. Use reifiedClass() instead.
Class<? extends ReifiedJavaProxy>	getReifiedJavaClass()	Gets a reified Java class.
Class<? extends IRubyObject>	getReifiedRubyClass()	Gets a reified Ruby class.
org.jruby.RubyClass.RubyClassSet	getSubclassesForRead()
VariableAccessor	getVariableAccessorForRead(String name)
VariableAccessor	getVariableAccessorForWrite(String name)
Map<String,VariableAccessor>	getVariableAccessorsForRead()
String[]	getVariableNames()	Get an array of all the known instance variable names.
Map<String,VariableAccessor>	getVariableTableCopy()
VariableTableManager	getVariableTableManager()
int	getVariableTableSize()
int	getVariableTableSizeWithExtras()
boolean	hasObjectID()
void	inherit(RubyClass superClazz)	Deprecated.
IRubyObject	inherited(ThreadContext context, IRubyObject arg)
IRubyObject	initialize(ThreadContext context, Block block)	rb_class_initialize
IRubyObject	initialize(ThreadContext context, IRubyObject superObject, Block block)
IRubyObject	initialize_copy(ThreadContext context, IRubyObject original)	rb_class_init_copy
void	invalidateCacheDescendants(ThreadContext context)	Invalidate all subclasses of this class by walking the set of all subclasses and asking them to invalidate themselves.
IRubyObject	invoke(ThreadContext context, IRubyObject self, int methodIndex, String name, IRubyObject[] args, CallType callType, Block block)	Deprecated.
IRubyObject	invoke(ThreadContext context, IRubyObject self, String name, IRubyObject[] args, CallType callType)	Deprecated. Use finvoke if you do not want visibility-checking or invokeFrom if you do.
IRubyObject	invoke(ThreadContext context, IRubyObject self, String name, IRubyObject[] args, CallType callType, Block block)	Deprecated. Use finvoke if you do not want visibility-checking or invokeFrom if you do.
IRubyObject	invoke(ThreadContext context, IRubyObject self, String name, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, CallType callType)	Deprecated. Use finvoke if you do not want visibility-checking or invokeFrom if you do.
IRubyObject	invoke(ThreadContext context, IRubyObject self, String name, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, CallType callType, Block block)	Deprecated. Use finvoke if you do not want visibility-checking or invokeFrom if you do.
IRubyObject	invoke(ThreadContext context, IRubyObject self, String name, IRubyObject arg0, IRubyObject arg1, CallType callType)	Deprecated. Use finvoke if you do not want visibility-checking or invokeFrom if you do.
IRubyObject	invoke(ThreadContext context, IRubyObject self, String name, IRubyObject arg0, IRubyObject arg1, CallType callType, Block block)	Deprecated. Use finvoke if you do not want visibility-checking or invokeFrom if you do.
IRubyObject	invoke(ThreadContext context, IRubyObject self, String name, IRubyObject arg, CallType callType)	Deprecated. Use finvoke if you do not want visibility-checking or invokeFrom if you do.
IRubyObject	invoke(ThreadContext context, IRubyObject self, String name, IRubyObject arg, CallType callType, Block block)	Deprecated. Use finvoke if you do not want visibility-checking or invokeFrom if you do.
IRubyObject	invoke(ThreadContext context, IRubyObject self, String name, CallType callType)	Deprecated. Use finvoke if you do not want visibility-checking or invokeFrom if you do.
IRubyObject	invoke(ThreadContext context, IRubyObject self, String name, CallType callType, Block block)	Deprecated. Use finvoke if you do not want visibility-checking or invokeFrom if you do.
IRubyObject	invokeFrom(ThreadContext context, CallType callType, IRubyObject caller, IRubyObject self, String name)	Deprecated.
IRubyObject	invokeFrom(ThreadContext context, CallType callType, IRubyObject caller, IRubyObject self, String name, Block block)	Deprecated.
IRubyObject	invokeFrom(ThreadContext context, CallType callType, IRubyObject caller, IRubyObject self, String name, IRubyObject arg)	Deprecated.
IRubyObject	invokeFrom(ThreadContext context, CallType callType, IRubyObject caller, IRubyObject self, String name, IRubyObject[] args)	Deprecated.
IRubyObject	invokeFrom(ThreadContext context, CallType callType, IRubyObject caller, IRubyObject self, String name, IRubyObject[] args, Block block)	Deprecated.
IRubyObject	invokeFrom(ThreadContext context, CallType callType, IRubyObject caller, IRubyObject self, String name, IRubyObject arg, Block block)	Deprecated.
IRubyObject	invokeFrom(ThreadContext context, CallType callType, IRubyObject caller, IRubyObject self, String name, IRubyObject arg0, IRubyObject arg1)	Deprecated.
IRubyObject	invokeFrom(ThreadContext context, CallType callType, IRubyObject caller, IRubyObject self, String name, IRubyObject arg0, IRubyObject arg1, Block block)	Deprecated.
IRubyObject	invokeFrom(ThreadContext context, CallType callType, IRubyObject caller, IRubyObject self, String name, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2)	Deprecated.
IRubyObject	invokeFrom(ThreadContext context, CallType callType, IRubyObject caller, IRubyObject self, String name, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)	Deprecated.
IRubyObject	invokeInherited(ThreadContext context, IRubyObject self, IRubyObject subclass)
IRubyObject	invokePublic(ThreadContext context, IRubyObject self, String name, IRubyObject arg)	MRI: rb_funcallv_public
boolean	isClass()	Specifically polymorphic method that are meant to be overridden by classes to specify that they are classes in an easy way.
boolean	isModule()	Specifically polymorphic method that are meant to be overridden by modules to specify that they are modules in an easy way.
boolean	isReifiable(boolean[] java)	Whether this class can be reified into a Java class.
boolean	isSingleton()
final void	marshal(Object obj, MarshalStream marshalStream)	Deprecated, for removal: This API element is subject to removal in a future version.
final void	marshal(ThreadContext context, RubyOutputStream out, Object obj, MarshalDumper marshalStream)
static void	marshalTo(RubyClass clazz, MarshalStream output)	Deprecated, for removal: This API element is subject to removal in a future version.
static void	marshalTo(ThreadContext context, RubyOutputStream out, RubyClass clazz, MarshalDumper output)
<T extends RubyClass> T	marshalWith(ObjectMarshal marshal)	Set what marshaller we use or generally use this to specify the typw cannot Marshal data.
static Class<?>	nearestReifiedClass(RubyClass klass)
static RubyClass	newClass(Ruby runtime, RubyClass superClass)	Deprecated.
static RubyClass	newClass(Ruby runtime, RubyClass superClass, String name, ObjectAllocator allocator, RubyModule parent, boolean setParent)	Deprecated.
static RubyClass	newClass(Ruby runtime, RubyClass superClass, String name, ObjectAllocator allocator, RubyModule parent, boolean setParent, String file, int line)	Deprecated.
static RubyClass	newClass(Ruby runtime, RubyClass superClass, String name, ObjectAllocator allocator, RubyModule parent, boolean setParent, CallSite[] extraCallSites)	Deprecated.
static RubyClass	newClass(Ruby runtime, RubyClass superClass, CallSite[] extraCallSites)	Deprecated.
static RubyClass	newClass(ThreadContext context, RubyClass superClass, String name, ObjectAllocator allocator, RubyModule parent, boolean setParent, String file, int line)
static RubyClass	newClass(ThreadContext context, RubyClass superClass, String name, ObjectAllocator allocator, RubyModule parent, boolean setParent, CallSite[] extraCallSites)	A variation on newClass that allows passing in an array of supplementary call sites to improve dynamic invocation performance.
static RubyClass	newClass(ThreadContext context, RubyClass superClass, CallSite[] extraCallSites)	A variation on newClass that allow passing in an array of supplementary call sites to improve dynamic invocation.
static RubyClass	newClassBootstrap(Ruby runtime, RubyClass Object, RubyClass Class, String name)	This is an internal API for bootstrapping a few classes before ThreadContext is available.
IRubyObject	newInstance(ThreadContext context, Block block)	rb_class_new_instance
IRubyObject	newInstance(ThreadContext context, IRubyObject arg0)
IRubyObject	newInstance(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	newInstance(ThreadContext context, IRubyObject arg0, Block block)
IRubyObject	newInstance(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
IRubyObject	newInstance(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)
Class<? extends Reified>	reifiedClass()	Gets a reified Ruby or Java class.
<T extends RubyClass> T	reifiedClass(Class<? extends IRubyObject> reifiedClass)	Sets reified class to use.
final void	reify()
final void	reify(boolean useChildLoader)
final void	reify(String classDumpDir)
void	reify(String classDumpDir, boolean useChildLoader)	Stand up a real Java class for the backing store of this object
void	reifyWithAncestors()
void	reifyWithAncestors(boolean useChildLoader)
void	reifyWithAncestors(String classDumpDir)
void	reifyWithAncestors(String classDumpDir, boolean useChildLoader)	Reify this class, first reifying all its ancestors.
void	removeSubclass(RubyClass subclass)	Remove a subclass from the weak set of subclasses.
void	replaceSubclass(RubyClass subclass, RubyClass newSubclass)	Replace an existing subclass with a new one.
void	setAllocator(ObjectAllocator allocator)	Deprecated. Use allocator(ObjectAllocator) instead.
void	setClassAllocator(Class<?> clazz)	Set a reflective allocator that calls a no-arg constructor on the given class.
void	setClassConfig(JavaClassConfiguration jcc)
final void	setMarshal(ObjectMarshal marshal)	Deprecated. Use marshalWith(ObjectMarshal) instead.
void	setReifiedClass(Class<? extends IRubyObject> reifiedClass)	Deprecated. Use reifiedClass(Class) instead.
void	setRubyClassAllocator(Class<? extends IRubyObject> clazz)	Set a reflective allocator that calls the "standard" Ruby object constructor (Ruby, RubyClass) on the given class.
void	setRubyStaticAllocator(Class<?> clazz)	Set a reflective allocator that calls the "standard" Ruby object constructor (Ruby, RubyClass) on the given class via a static __allocate__ method intermediate.
void	smartDump(MarshalStream stream, IRubyObject target)	Deprecated, for removal: This API element is subject to removal in a future version.
void	smartDump(ThreadContext context, RubyOutputStream out, MarshalDumper stream, IRubyObject target)
IRubyObject	smartLoadNewUser(IRubyObject target, IRubyObject data)	Load marshaled data into a blank target object using marshal_load, being "smart" and caching the mechanism for invoking marshal_load.
IRubyObject	smartLoadOldUser(IRubyObject data)	Load marshaled data into a blank target object using _load, being "smart" and caching the mechanism for invoking _load.
final Collection<RubyClass>	subclasses()
Collection<RubyClass>	subclasses(boolean includeDescendants)
IRubyObject	subclasses(ThreadContext context)
IRubyObject	superclass(ThreadContext context)	Return the real super class of this class.
<T> T	toJava(Class<T> target)	Convert the object to the specified Java class, if possible.
final Object	unmarshal(UnmarshalStream unmarshalStream)	Deprecated, for removal: This API element is subject to removal in a future version.
final Object	unmarshal(ThreadContext context, RubyInputStream in, MarshalLoader loader)
static RubyClass	unmarshalFrom(UnmarshalStream input)	Deprecated, for removal: This API element is subject to removal in a future version.
static RubyClass	unmarshalFrom(ThreadContext context, RubyInputStream in, MarshalLoader input)

Methods inherited from class org.jruby.RubyModule

_module_function, _private, _protected, _public, addClassProvider, addIncludingHierarchy, addMethod, addMethod, addMethodInternal, addMethodInternal, addMethodSymbols, addMethodSymbols, addModuleFunction, addReadAttribute, addReadWriteAttribute, addToCache, addToCache, addWriteAttribute, alias_method, aliasMethod, ancestors, ancestors, append_features, append_features, attr, attr_accessor, attr_accessor, attr_reader, attr_reader, attr_writer, autoload, autoload_p, autoload_p, autoloadingValue, autoloadingValue, baseName, checkForCyclicPrepend, checkFrozen, checkValidBindTargetFrom, class_variable_defined_p, class_variable_get, class_variable_get, class_variable_get19, class_variable_set, class_variable_set, class_variable_set19, class_variables, class_variables, classIndex, cloneMethods, cloneMethods, const_added, const_defined_p, const_defined_p, const_get, const_get, const_get, const_get, const_get_1_9, const_get_2_0, const_missing, const_set, const_set, const_source_location, constantEntryFetch, constants, constants, constantsCommon, constantsCommon, constantTableContains, constantTableFetch, constantTableRemove, constantTableStore, constantTableStore, constantTableStore, constantTableStore, constDefined, constDefined, constDefinedAt, constDefinedAt, constDefinedFrom, constDefinedFrom, define_method, define_method, define_method, defineAlias, defineAlias, defineAliases, defineAnnotatedConstant, defineAnnotatedConstants, defineAnnotatedMethod, defineAnnotatedMethod, defineAnnotatedMethod, defineAnnotatedMethod, defineAnnotatedMethod, defineAnnotatedMethods, defineAnnotatedMethodsIndividually, defineAutoload, defineAutoload, defineClassUnder, defineClassUnder, defineClassUnder, defineConstant, defineConstant, defineConstant, defineConstantBootstrap, defineConstants, defineConstantsFrom, defineMethodFromBlock, defineMethodFromCallable, defineMethods, defineModuleUnder, defineModuleUnder, defineOrGetClassUnder, defineOrGetClassUnder, defineOrGetClassUnder, defineOrGetClassUnder, defineOrGetModuleUnder, defineOrGetModuleUnder, defineOrGetModuleUnder, deleteClassVariable, deleteConstant, deleteConstant, deprecate_constant, deprecate_constant, deprecateConstant, deprecateConstant, discoverInstanceVariables, ensureClassVariablesSettable, ensureConstantsSettable, equals, exportMethod, extend_object, extend_object, extended, fastFetchClassVariable, fastFetchConstant, fastGetClass, fastGetClassVar, fastGetConstant, fastGetConstant, fastGetConstantAt, fastGetConstantFrom, fastGetConstantFromConstMissing, fastGetConstantFromNoConstMissing, fastHasClassVariable, fastHasConstant, fastIsClassVarDefined, fastIsConstantDefined, fastSetClassVar, fastSetConstant, fastStoreClassVariable, fastStoreConstant, fetchClassVariable, fetchConstant, fetchConstant, fetchConstant, fetchConstant, fetchConstantEntry, fetchConstantEntry, findImplementer, finishAutoload, finishAutoload, finishCreateModuleClass, finishModuleClass, finishRefinementClass, freeze, getAncestorList, getAutoloadConstant, getAutoloadConstant, getAutoloadConstant, getAutoloadConstant, getAutoloadFile, getAutoloadMap, getAutoloadMapForWrite, getBaseName, getCachedMethods, getCacheProxy, getCacheToken, getClass, getClass, getClassIndex, getClassVar, getClassVar, getClassVar, getClassVar, getClassVariableNameList, getClassVariables, getClassVariablesForRead, getClassVarQuiet, getConstant, getConstant, getConstant, getConstant, getConstant, getConstant, getConstantAt, getConstantAt, getConstantAt, getConstantAt, getConstantAtSpecial, getConstantAtSpecial, getConstantFrom, getConstantFrom, getConstantFromConstMissing, getConstantFromConstMissing, getConstantFromNoConstMissing, getConstantFromNoConstMissing, getConstantFromNoConstMissing, getConstantFromNoConstMissing, getConstantMap, getConstantMapForWrite, getConstantNames, getConstantNames, getConstantNoConstMissing, getConstantNoConstMissing, getConstantNoConstMissing, getConstantNoConstMissing, getConstantNoConstMissing, getConstantNoConstMissing, getConstantNoConstMissingSkipAutoload, getConstantNoConstMissingSkipAutoload, getConstantNoConstMissingSKipAutoload, getConstantSourceLocation, getConstantSourceLocation, getConstantWithAutoload, getConstantWithAutoload, getDelegate, getGeneration, getGenerationObject, getIdTest, getIncludingHierarchiesForWrite, getInvalidator, getJavaProxy, getMethodLocation, getMethods, getMethodsForWrite, getModule, getModule, getName, getName, getNonIncludedClass, getOrigin, getParent, getRefinements, getRefinementsForWrite, getSimpleName, getSimpleName, getStoredConstantList, getStoredConstantNameList, getSuperClass, hasAncestor, hasAutoload, hasClassVariable, hasConstant, hash, hashCode, hasInternalModuleVariable, hasModuleInHierarchy, hasModuleInPrepends, hasPrepends, include, include, include, include, include_p, included, included_modules, includeModule, includeModule, initialize, instance_method, instance_method, instance_methods, instance_methods, instance_methods19, instanceMethods, instanceMethods, instanceMethods, invalidateCacheDescendants, invalidateConstantCache, invalidateConstantCache, invalidateConstantCaches, invalidateCoreClasses, isClassVarDefined, isConstantDefined, isConstantDefined, isConstantDefined, isIncluded, isIncludedIntoRefinement, isInstance, isKindOfModule, isMethodBound, isMethodBound, isMethodBuiltin, isPrepended, isRefinement, isSame, isSameOrigin, isSynchronized, isValidConstantName, isValidConstantPath, kindOf, loadPopulatorFor, marshalTo, marshalTo, method_added, method_defined_p, method_defined_p, method_removed, method_undefined, methodAdded, mix, mix, module_eval, module_eval, module_eval, module_eval, module_eval, module_exec, module_exec, module_function, name, name, needsImplementer, nesting, newActivatedRefinementsMap, newIdTest, newIncludeClass, newMethod, newMethod, newMethod, newMethod, newMethod, newMethod, newMethod, newModule, newModule, newModule, newModule, newModuleBootstrap, newRefinementsMap, newRefinementsMap, op_cmp, op_cmp, op_eqq, op_equal, op_ge, op_ge, op_gt, op_gt, op_le, op_le, op_lt, op_lt, prepend, prepend_features, prepend_features, prepended, prependModule, prependModule, prependModule, private_class_method, private_class_method, private_constant, private_constant, private_instance_methods, private_instance_methods, private_method_defined, private_method_defined, protected_instance_methods, protected_instance_methods, protected_method_defined, protected_method_defined, public_class_method, public_class_method, public_constant, public_constant, public_instance_method, public_instance_method, public_instance_methods, public_instance_methods, public_instance_methods19, public_method_defined, public_method_defined, publicConstDefinedFrom, publicConstDefinedFrom, putAlias, putAlias, putAlias, putAlias, putMethod, putMethod, rbPrivate, rbProtected, rbPublic, refine, refined_class, refinements, remove_class_variable, remove_class_variable19, remove_const, remove_method, removeClassProvider, removeClassVariable, removeClassVariable, removeMethod, resolveRefinedMethod, resolveUndefConstant, respondsToMethod, respondsToMethod, retrieveMethod, ruby2_keywords, rubyBaseName, rubyBaseName, rubyName, rubyName, searchAncestor, searchInternalModuleVariable, searchMethod, searchMethodCommon, searchMethodEntryInner, searchMethodInner, searchMethodLateral, searchWithCache, searchWithCache, searchWithRefinements, set_temporary_name, setBaseName, setCacheProxy, setClassVar, setClassVar, setConstant, setConstant, setConstant, setConstant, setConstant, setConstant, setConstantQuiet, setConstantQuiet, setConstantVisibility, setConstantVisibility, setInternalModuleVariable, setJavaProxy, setMethodLocation, setMethodVisibility, setMethodVisibility, setParent, setRefinements, setSuperClass, singleton_class_p, storeClassVariable, storeClassVariable, storeConstant, storeConstant, storeConstant, storeConstant, storeConstant, superClass, superClass, symbolName, symbolName, syncClassVariables, syncConstants, tap, target, testModuleMatch, to_s, to_s, undef, undef_method, undefined_instance_method, undefinedMethodMessage, undefineMethod, undefMethods, updateGeneration, used_modules, used_refinements, using, usingModule, usingTemporaryName, validateClassVariable, validateClassVariable, validateClassVariable, validateClassVariable, validateConstant, validateConstant, validateConstant

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, dig, dig1, dig2, eqlInternal, equalInternal, finishObjectClass, inspect, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkStringType, cloneSetup, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql, eql_p, eql_p, equal_p, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMarshalVariableList, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize_copy, inspect, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval, instance_exec, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, isBuiltin, isFalse, isFrozen, isImmediate, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, methods, nil_p, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_match, op_not, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, singletonClass, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, trust, type, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jruby.runtime.builtin.IRubyObject

checkStringType19, dup, marshalLiveVariables

Field Details

CLASS_ALLOCATOR

public static final ObjectAllocator CLASS_ALLOCATOR

DEFAULT_OBJECT_MARSHAL

protected static final ObjectMarshal DEFAULT_OBJECT_MARSHAL

runtime

protected final Ruby runtime

marshal

protected ObjectMarshal marshal

CS_IDX_INITIALIZE

public static final int CS_IDX_INITIALIZE

See Also:

• Constant Field Values

Constructor Details

RubyClass

protected RubyClass(Ruby runtime,
 RubyClass superClass,
 boolean objectSpace)

separate path for MetaClass and IncludedModuleWrapper construction (rb_class_boot version for MetaClasses) no marshal, allocator initialization and addSubclass(this) here!

RubyClass

protected RubyClass(Ruby runtime,
 RubyClass superClass,
 RubyClass Class)

This is an internal API only used by Ruby constructor before ThreadContext exists.

Parameters:

runtime -

superClass -

Class -

RubyClass

protected RubyClass(Ruby runtime)

used by CLASS_ALLOCATOR (any Class' class will be a Class!) also used to bootstrap Object class

RubyClass

protected RubyClass(Ruby runtime,
 RubyClass superClazz)

rb_class_boot (for plain Classes) also used to bootstrap Module and Class classes

RubyClass

protected RubyClass(Ruby runtime,
 RubyClass superClazz,
 CallSite[] extraCallSites)

A constructor which allows passing in an array of supplementary call sites.

Method Details

finishClassClass

public static void finishClassClass(Ruby runtime,
 RubyClass Class)

finishCreateClassClass

public static void finishCreateClassClass(ThreadContext context,
 RubyClass Class)

getAllocator

public ObjectAllocator getAllocator()

setAllocator

@Deprecated(since="10.0")
public void setAllocator(ObjectAllocator allocator)

Deprecated.

Use allocator(ObjectAllocator) instead.

Parameters:

allocator -

allocator

public <T extends RubyClass> T allocator(ObjectAllocator allocator)

Define an allocator for this class (usually this is part of Define.defineClass(ThreadContext, String, RubyClass, ObjectAllocator)).

Parameters:

allocator - to use

Returns:

itself for a composable API

marshalWith

public <T extends RubyClass> T marshalWith(ObjectMarshal marshal)

Set what marshaller we use or generally use this to specify the typw cannot Marshal data.

Parameters:

marshal - the marshaller

Returns:

itself for composable API

reifiedClass

public <T extends RubyClass> T reifiedClass(Class<? extends IRubyObject> reifiedClass)

Sets reified class to use.

Parameters:

reifiedClass - the java type to use

Returns:

itself for composable API

setClassAllocator

public void setClassAllocator(Class<?> clazz)

Set a reflective allocator that calls a no-arg constructor on the given class.

Parameters:

clazz - The class on which to call the default constructor to allocate

setRubyClassAllocator

public void setRubyClassAllocator(Class<? extends IRubyObject> clazz)

Set a reflective allocator that calls the "standard" Ruby object constructor (Ruby, RubyClass) on the given class.

Parameters:

clazz - The class from which to grab a standard Ruby constructor

setRubyStaticAllocator

public void setRubyStaticAllocator(Class<?> clazz)

Set a reflective allocator that calls the "standard" Ruby object constructor (Ruby, RubyClass) on the given class via a static __allocate__ method intermediate.

Parameters:

clazz - The class from which to grab a standard Ruby __allocate__ method.

Note: Used with `jrubyc --java` generated (interoperability) class files.

Note: Used with new concrete extension.

allocate

@Deprecated(since="10.0")
public IRubyObject allocate()

Deprecated.

allocate

public IRubyObject allocate(ThreadContext context)

getBaseCallSite

public CallSite getBaseCallSite(int idx)

getBaseCallSites

public CallSite[] getBaseCallSites()

getExtraCallSites

public CallSite[] getExtraCallSites()

getVariableTableManager

public VariableTableManager getVariableTableManager()

hasObjectID

public boolean hasObjectID()

getVariableAccessorsForRead

public Map<String,VariableAccessor> getVariableAccessorsForRead()

getVariableAccessorForWrite

public VariableAccessor getVariableAccessorForWrite(String name)

getVariableAccessorForRead

public VariableAccessor getVariableAccessorForRead(String name)

getFFIHandleAccessorForRead

public VariableAccessor getFFIHandleAccessorForRead()

getFFIHandleAccessorForWrite

public VariableAccessor getFFIHandleAccessorForWrite()

getObjectGroupAccessorForRead

public VariableAccessor getObjectGroupAccessorForRead()

getObjectGroupAccessorForWrite

public VariableAccessor getObjectGroupAccessorForWrite()

getVariableTableSize

public int getVariableTableSize()

getVariableTableSizeWithExtras

public int getVariableTableSizeWithExtras()

getVariableNames

public String[] getVariableNames()

Get an array of all the known instance variable names. The offset into the array indicates the offset of the variable's value in the per-object variable array.

Returns:

a copy of the array of known instance variable names

getVariableTableCopy

public Map<String,VariableAccessor> getVariableTableCopy()

getNativeClassIndex

public ClassIndex getNativeClassIndex()

Description copied from class: RubyObject

This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are. Will generally return a value from org.jruby.runtime.ClassIndex

Specified by:

getNativeClassIndex in interface CoreObjectType

Overrides:

getNativeClassIndex in class RubyModule

Returns:

the ClassIndex of the native type this object was constructed from

See Also:

• ClassIndex

isModule

public boolean isModule()

Description copied from class: RubyBasicObject

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

Specified by:

isModule in interface IRubyObject

Overrides:

isModule in class RubyModule

Returns:

true if an object is Ruby Module instance (note that it will return false for Ruby Classes).

isClass

public boolean isClass()

Description copied from class: RubyBasicObject

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

Specified by:

isClass in interface IRubyObject

Overrides:

isClass in class RubyModule

Returns:

true if an object is Ruby Class instance (note that it will return false for Ruby singleton classes).

isSingleton

public boolean isSingleton()

Overrides:

isSingleton in class RubyModule

createBootstrapClass

public static RubyClass createBootstrapClass(Ruby runtime,
 String name,
 RubyClass superClass,
 ObjectAllocator allocator)

boot_defclass Create an initial Object meta class before Module and Kernel dependencies have squirreled themselves together.

Parameters:

runtime - we need it

Returns:

a half-baked meta class for object

newClass

@Deprecated(since="10.0")
public static RubyClass newClass(Ruby runtime,
 RubyClass superClass)

Deprecated.

Construct a new class with the given name scoped under Object (global) and with Object as its immediate superclass. Corresponds to rb_class_new in MRI.

newClass

@Deprecated(since="10.0")
public static RubyClass newClass(Ruby runtime,
 RubyClass superClass,
 CallSite[] extraCallSites)

Deprecated.

newClass

public static RubyClass newClass(ThreadContext context,
 RubyClass superClass,
 CallSite[] extraCallSites)

A variation on newClass that allow passing in an array of supplementary call sites to improve dynamic invocation.

newClass

@Deprecated(since="10.0")
public static RubyClass newClass(Ruby runtime,
 RubyClass superClass,
 String name,
 ObjectAllocator allocator,
 RubyModule parent,
 boolean setParent)

Deprecated.

Construct a new class with the given name, allocator, parent class, and containing class. If setParent is true, the class's parent will be explicitly set to the provided parent (rather than the new class just being assigned to a constant in that parent). Corresponds to rb_class_new/rb_define_class_id/rb_name_class/rb_set_class_path in MRI.

newClass

@Deprecated(since="10.0")
public static RubyClass newClass(Ruby runtime,
 RubyClass superClass,
 String name,
 ObjectAllocator allocator,
 RubyModule parent,
 boolean setParent,
 String file,
 int line)

Deprecated.

newClass

public static RubyClass newClass(ThreadContext context,
 RubyClass superClass,
 String name,
 ObjectAllocator allocator,
 RubyModule parent,
 boolean setParent,
 String file,
 int line)

newClass

@Deprecated(since="10.0")
public static RubyClass newClass(Ruby runtime,
 RubyClass superClass,
 String name,
 ObjectAllocator allocator,
 RubyModule parent,
 boolean setParent,
 CallSite[] extraCallSites)

Deprecated.

newClass

public static RubyClass newClass(ThreadContext context,
 RubyClass superClass,
 String name,
 ObjectAllocator allocator,
 RubyModule parent,
 boolean setParent,
 CallSite[] extraCallSites)

A variation on newClass that allows passing in an array of supplementary call sites to improve dynamic invocation performance.

newClassBootstrap

public static RubyClass newClassBootstrap(Ruby runtime,
 RubyClass Object,
 RubyClass Class,
 String name)

This is an internal API for bootstrapping a few classes before ThreadContext is available. The API is intentionally limited/obtuse so no one is tempted to try and use it.

Parameters:

runtime - the runtime

Object - reference to Object which is superclass and parent for new type

name - the name of the new class

Returns:

the new class.

finvoke

public IRubyObject finvoke(ThreadContext context,
 IRubyObject self,
 String name,
 Block block)

finvokeWithRefinements

public IRubyObject finvokeWithRefinements(ThreadContext context,
 IRubyObject self,
 StaticScope staticScope,
 String name,
 Block block)

finvoke

public IRubyObject finvoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject[] args,
 Block block)

finvokeWithRefinements

public IRubyObject finvokeWithRefinements(ThreadContext context,
 IRubyObject self,
 StaticScope staticScope,
 String name,
 IRubyObject[] args,
 Block block)

finvoke

public IRubyObject finvoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject arg,
 Block block)

finvokeWithRefinements

public IRubyObject finvokeWithRefinements(ThreadContext context,
 IRubyObject self,
 StaticScope staticScope,
 String name,
 IRubyObject arg,
 Block block)

finvoke

public IRubyObject finvoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject arg0,
 IRubyObject arg1,
 Block block)

finvokeWithRefinements

public IRubyObject finvokeWithRefinements(ThreadContext context,
 IRubyObject self,
 StaticScope staticScope,
 String name,
 IRubyObject arg0,
 IRubyObject arg1,
 Block block)

finvoke

public IRubyObject finvoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2,
 Block block)

finvokeWithRefinements

public IRubyObject finvokeWithRefinements(ThreadContext context,
 IRubyObject self,
 StaticScope staticScope,
 String name,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2,
 Block block)

finvoke

public IRubyObject finvoke(ThreadContext context,
 IRubyObject self,
 String name)

invokePublic

public IRubyObject invokePublic(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject arg)

MRI: rb_funcallv_public

finvokeChecked

public final IRubyObject finvokeChecked(ThreadContext context,
 IRubyObject self,
 String name)

Safely attempt to invoke the given method name on self, using respond_to? and method_missing as appropriate. MRI: rb_check_funcall

finvokeChecked

public final IRubyObject finvokeChecked(ThreadContext context,
 IRubyObject self,
 JavaSites.CheckedSites sites)

Safely attempt to invoke the given method name on self, using respond_to? and method_missing as appropriate. MRI: rb_check_funcall

finvokeChecked

public final IRubyObject finvokeChecked(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject... args)

Safely attempt to invoke the given method name on self, using respond_to? and method_missing as appropriate. MRI: rb_check_funcall

finvokeChecked

public final IRubyObject finvokeChecked(ThreadContext context,
 IRubyObject self,
 JavaSites.CheckedSites sites,
 IRubyObject... args)

Safely attempt to invoke the given method name on self, using respond_to? and method_missing as appropriate. MRI: rb_check_funcall

finvoke

public IRubyObject finvoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject[] args)

finvoke

public IRubyObject finvoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject arg)

finvoke

public IRubyObject finvoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject arg0,
 IRubyObject arg1)

finvoke

public IRubyObject finvoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

checkMethodBasicDefinition

public boolean checkMethodBasicDefinition(String name)

invokeInherited

public IRubyObject invokeInherited(ThreadContext context,
 IRubyObject self,
 IRubyObject subclass)

newInstance

public IRubyObject newInstance(ThreadContext context,
 Block block)

rb_class_new_instance

newInstance

public IRubyObject newInstance(ThreadContext context,
 IRubyObject arg0,
 Block block)

newInstance

public IRubyObject newInstance(ThreadContext context,
 IRubyObject arg0)

newInstance

public IRubyObject newInstance(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 Block block)

newInstance

public IRubyObject newInstance(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2,
 Block block)

newInstance

public IRubyObject newInstance(ThreadContext context,
 IRubyObject[] args,
 Block block)

initialize

public IRubyObject initialize(ThreadContext context,
 Block block)

rb_class_initialize

Overrides:

initialize in class RubyModule

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject superObject,
 Block block)

initialize_copy

public IRubyObject initialize_copy(ThreadContext context,
 IRubyObject original)

rb_class_init_copy

Overrides:

initialize_copy in class RubyModule

Parameters:

context - the thread context

original - the original

Returns:

a copy unless the same thing

subclasses

public IRubyObject subclasses(ThreadContext context)

subclasses

public final Collection<RubyClass> subclasses()

subclasses

public Collection<RubyClass> subclasses(boolean includeDescendants)

getSubclassesForRead

public org.jruby.RubyClass.RubyClassSet getSubclassesForRead()

addSubclass

public void addSubclass(RubyClass subclass)

Add a new subclass to the weak set of subclasses. This version always constructs a new set to avoid having to synchronize against the set when iterating it for invalidation in invalidateCacheDescendants.

Parameters:

subclass - The subclass to add

removeSubclass

public void removeSubclass(RubyClass subclass)

Remove a subclass from the weak set of subclasses.

Parameters:

subclass - The subclass to remove

replaceSubclass

public void replaceSubclass(RubyClass subclass,
 RubyClass newSubclass)

Replace an existing subclass with a new one.

Parameters:

subclass - The subclass to remove

newSubclass - The subclass to replace it with

becomeSynchronized

public void becomeSynchronized()

make this class and all subclasses sync

Overrides:

becomeSynchronized in class RubyModule

invalidateCacheDescendants

public void invalidateCacheDescendants(ThreadContext context)

Invalidate all subclasses of this class by walking the set of all subclasses and asking them to invalidate themselves. Note that this version works against a reference to the current set of subclasses, which could be replaced by the time this iteration is complete. In theory, there may be a path by which invalidation would miss a class added during the invalidation process, but the exposure is minimal if it exists at all. The only way to prevent it would be to synchronize both invalidation and subclass set modification against a global lock, which we would like to avoid.

Overrides:

invalidateCacheDescendants in class RubyModule

getClassRuntime

public final Ruby getClassRuntime()

getRealClass

public final RubyClass getRealClass()

Get the "real" class, either the current one or the nearest ancestor that is not a singleton or include wrapper.

Returns:

the nearest non-singleton non-include class

getRealModule

public RubyModule getRealModule()

Equivalent to getRealClass().

Overrides:

getRealModule in class RubyModule

Returns:

the nearest non-singleton non-include class

inherited

public IRubyObject inherited(ThreadContext context,
 IRubyObject arg)

inherit

@Deprecated(since="10.0")
public void inherit(RubyClass superClazz)

Deprecated.

rb_class_inherited (reversed semantics!)

superclass

public IRubyObject superclass(ThreadContext context)

Return the real super class of this class. rb_class_superclass

attached_object

public IRubyObject attached_object(ThreadContext context)

checkInheritable

@Deprecated
public static void checkInheritable(IRubyObject superClass)

Deprecated.

rb_check_inheritable

checkInheritable

public static void checkInheritable(ThreadContext context,
 IRubyObject superClass)

getMarshal

public final ObjectMarshal getMarshal()

setMarshal

@Deprecated(since="10.0")
public final void setMarshal(ObjectMarshal marshal)

Deprecated.

Use marshalWith(ObjectMarshal) instead.

Parameters:

marshal -

marshal

@Deprecated(since="10.0",
            forRemoval=true)
public final void marshal(Object obj,
 MarshalStream marshalStream)
                   throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IOException

marshal

public final void marshal(ThreadContext context,
 RubyOutputStream out,
 Object obj,
 MarshalDumper marshalStream)

unmarshal

@Deprecated(since="10.0",
            forRemoval=true)
public final Object unmarshal(UnmarshalStream unmarshalStream)
                       throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IOException

unmarshal

public final Object unmarshal(ThreadContext context,
 RubyInputStream in,
 MarshalLoader loader)

marshalTo

@Deprecated(since="10.0",
            forRemoval=true)
public static void marshalTo(RubyClass clazz,
 MarshalStream output)
                      throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IOException

marshalTo

public static void marshalTo(ThreadContext context,
 RubyOutputStream out,
 RubyClass clazz,
 MarshalDumper output)

unmarshalFrom

@Deprecated(since="10.0",
            forRemoval=true)
public static RubyClass unmarshalFrom(UnmarshalStream input)
                               throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IOException

unmarshalFrom

public static RubyClass unmarshalFrom(ThreadContext context,
 RubyInputStream in,
 MarshalLoader input)

isReifiable

public boolean isReifiable(boolean[] java)

Whether this class can be reified into a Java class. Currently only objects that descend from Object (or descend from Ruby-based classes that descend from Object) can be reified.

Parameters:

java - If reified from java (out param)

Returns:

true if the class can be reified, false otherwise. The out param indicate if it is java concrete reification

reifyWithAncestors

public void reifyWithAncestors()

reifyWithAncestors

public void reifyWithAncestors(String classDumpDir)

reifyWithAncestors

public void reifyWithAncestors(boolean useChildLoader)

reifyWithAncestors

public void reifyWithAncestors(String classDumpDir,
 boolean useChildLoader)

Reify this class, first reifying all its ancestors. This causes the reified class and all ancestors' reified classes to come into existence, so any future changes will not be reflected. This form also accepts a string argument indicating a path in which to dump the intermediate reified class bytes.

Parameters:

classDumpDir - the path in which to dump reified class bytes

useChildLoader - whether to load the class into its own child classloader

reify

public final void reify()

reify

public final void reify(String classDumpDir)

reify

public final void reify(boolean useChildLoader)

reify

public void reify(String classDumpDir,
 boolean useChildLoader)

Stand up a real Java class for the backing store of this object

Parameters:

classDumpDir - Directory to save reified java class

getPositionOrDefault

public PositionAware getPositionOrDefault(DynamicMethod method)

setReifiedClass

@Deprecated(since="10.0")
public void setReifiedClass(Class<? extends IRubyObject> reifiedClass)

Deprecated.

Use reifiedClass(Class) instead.

Parameters:

reifiedClass -

getReifiedClass

@Deprecated(since="10.0")
public Class<? extends Reified> getReifiedClass()

Deprecated.

Use reifiedClass() instead.

Returns:

reifiedClass

public Class<? extends Reified> reifiedClass()

Gets a reified Ruby or Java class. To ensure a specific type, see getReifiedRubyClass() or getReifiedJavaClass()

getReifiedRubyClass

public Class<? extends IRubyObject> getReifiedRubyClass()

Gets a reified Ruby class. Throws if this is a Java class

getReifiedJavaClass

public Class<? extends ReifiedJavaProxy> getReifiedJavaClass()

Gets a reified Java class. Throws if this is a Ruby class

getIsReifiedExtendedJavaClass

public Boolean getIsReifiedExtendedJavaClass()

If the current class is reified (null otherwise) and if it extends java

Returns:

Null if not reified, true if a concrete extension class, and false if a ruby class

nearestReifiedClass

public static Class<?> nearestReifiedClass(RubyClass klass)

getParameterAnnotations

public Map<String,List<Map<Class<?>,Map<String,Object>>>> getParameterAnnotations()

addParameterAnnotation

public void addParameterAnnotation(String method,
 int i,
 Class<?> annoClass,
 Map<String,Object> value)

getMethodAnnotations

public Map<String,Map<Class<?>,Map<String,Object>>> getMethodAnnotations()

getFieldAnnotations

public Map<String,Map<Class<?>,Map<String,Object>>> getFieldAnnotations()

addMethodAnnotation

public void addMethodAnnotation(String methodName,
 Class<?> annotation,
 Map fields)

addFieldAnnotation

public void addFieldAnnotation(String fieldName,
 Class<?> annotation,
 Map fields)

getMethodSignatures

public Map<String,Class<?>[]> getMethodSignatures()

getAllMethodSignatures

public Map<String,List<Class<?>[]>> getAllMethodSignatures()

getFieldSignatures

public Map<String,Class<?>> getFieldSignatures()

addMethodSignature

public void addMethodSignature(String methodName,
 Class<?>[] types)

addFieldSignature

public void addFieldSignature(String fieldName,
 Class<?> type)

getClassAnnotations

public Map<Class<?>,Map<String,Object>> getClassAnnotations()

addClassAnnotation

public void addClassAnnotation(Class<?> annotation,
 Map fields)

getClassConfig

public JavaClassConfiguration getClassConfig()

setClassConfig

public void setClassConfig(JavaClassConfiguration jcc)

toJava

public <T> T toJava(Class<T> target)

Description copied from interface: IRubyObject

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

Specified by:

toJava in interface IRubyObject

Overrides:

toJava in class RubyModule

Type Parameters:

T - type

Parameters:

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

Returns:

java type

See Also:

• IRubyObject.toJava(java.lang.Class<T>)

smartDump

@Deprecated(since="10.0",
            forRemoval=true)
public void smartDump(MarshalStream stream,
 IRubyObject target)
               throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Marshal the given object to the marshaling stream, being "smart" and caching how to do that marshaling. If the class defines a custom "respond_to?" method, then the behavior of dumping could vary without our class structure knowing it. As a result, we do only the slow-path classic behavior. If the class defines a real "marshal_dump" method, we cache and use that. If the class defines a real "_dump" method, we cache and use that. If the class neither defines none of the above methods, we use a fast path directly to the default dumping logic.

Parameters:

stream - The stream to which to marshal the data

target - The object whose data should be marshaled

Throws:

IOException - If there is an IO exception while writing to the stream.

smartDump

public void smartDump(ThreadContext context,
 RubyOutputStream out,
 MarshalDumper stream,
 IRubyObject target)

smartLoadNewUser

public IRubyObject smartLoadNewUser(IRubyObject target,
 IRubyObject data)

Load marshaled data into a blank target object using marshal_load, being "smart" and caching the mechanism for invoking marshal_load. If the class implements a custom respond_to?, cache nothing and go slow path invocation of respond_to? and marshal_load every time. Raise error if respond_to? :marshal_load returns true and no :marshal_load is defined. If the class implements marshal_load, cache and use that. Otherwise, error, since marshal_load is not present.

Parameters:

target - The blank target object into which marshal_load will deserialize the given data

data - The marshaled data

Returns:

The fully-populated target object

smartLoadOldUser

public IRubyObject smartLoadOldUser(IRubyObject data)

Load marshaled data into a blank target object using _load, being "smart" and caching the mechanism for invoking _load. If the metaclass implements custom respond_to?, cache nothing and go slow path invocation of respond_to? and _load every time. Raise error if respond_to? :_load returns true and no :_load is defined. If the metaclass implements _load, cache and use that. Otherwise, error, since _load is not present.

Parameters:

data - The marshaled data, to be reconstituted into an object by _load

Returns:

The fully-populated target object

invoke

@Deprecated
public IRubyObject invoke(ThreadContext context,
 IRubyObject self,
 int methodIndex,
 String name,
 IRubyObject[] args,
 CallType callType,
 Block block)

Deprecated.

invoke

@Deprecated(since="9.4-")
public IRubyObject invoke(ThreadContext context,
 IRubyObject self,
 String name,
 CallType callType,
 Block block)

Deprecated.

Use finvoke if you do not want visibility-checking or invokeFrom if you do.

This method is deprecated because it depends on having a Ruby frame pushed for checking method visibility, and there's no way to enforce that. Most users of this method probably don't need to check visibility. See https://github.com/jruby/jruby/issues/4134

invoke

@Deprecated(since="9.4-")
public IRubyObject invoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject[] args,
 CallType callType,
 Block block)

Deprecated.

Use finvoke if you do not want visibility-checking or invokeFrom if you do.

This method is deprecated because it depends on having a Ruby frame pushed for checking method visibility, and there's no way to enforce that. Most users of this method probably don't need to check visibility. See https://github.com/jruby/jruby/issues/4134

invoke

@Deprecated(since="9.4-")
public IRubyObject invoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject arg,
 CallType callType,
 Block block)

Deprecated.

Use finvoke if you do not want visibility-checking or invokeFrom if you do.

This method is deprecated because it depends on having a Ruby frame pushed for checking method visibility, and there's no way to enforce that. Most users of this method probably don't need to check visibility. See https://github.com/jruby/jruby/issues/4134

invoke

@Deprecated(since="9.4-")
public IRubyObject invoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject arg0,
 IRubyObject arg1,
 CallType callType,
 Block block)

Deprecated.

Use finvoke if you do not want visibility-checking or invokeFrom if you do.

This method is deprecated because it depends on having a Ruby frame pushed for checking method visibility, and there's no way to enforce that. Most users of this method probably don't need to check visibility. See https://github.com/jruby/jruby/issues/4134

invoke

@Deprecated(since="9.4-")
public IRubyObject invoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2,
 CallType callType,
 Block block)

Deprecated.

Use finvoke if you do not want visibility-checking or invokeFrom if you do.

This method is deprecated because it depends on having a Ruby frame pushed for checking method visibility, and there's no way to enforce that. Most users of this method probably don't need to check visibility. See https://github.com/jruby/jruby/issues/4134

invoke

@Deprecated(since="9.4-")
public IRubyObject invoke(ThreadContext context,
 IRubyObject self,
 String name,
 CallType callType)

Deprecated.

Use finvoke if you do not want visibility-checking or invokeFrom if you do.

This method is deprecated because it depends on having a Ruby frame pushed for checking method visibility, and there's no way to enforce that. Most users of this method probably don't need to check visibility. See https://github.com/jruby/jruby/issues/4134

invoke

@Deprecated(since="9.4-")
public IRubyObject invoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject[] args,
 CallType callType)

Deprecated.

Use finvoke if you do not want visibility-checking or invokeFrom if you do.

This method is deprecated because it depends on having a Ruby frame pushed for checking method visibility, and there's no way to enforce that. Most users of this method probably don't need to check visibility. See https://github.com/jruby/jruby/issues/4134

invoke

@Deprecated(since="9.4-")
public IRubyObject invoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject arg,
 CallType callType)

Deprecated.

Use finvoke if you do not want visibility-checking or invokeFrom if you do.

This method is deprecated because it depends on having a Ruby frame pushed for checking method visibility, and there's no way to enforce that. Most users of this method probably don't need to check visibility. See https://github.com/jruby/jruby/issues/4134

invoke

@Deprecated(since="9.4-")
public IRubyObject invoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject arg0,
 IRubyObject arg1,
 CallType callType)

Deprecated.

Use finvoke if you do not want visibility-checking or invokeFrom if you do.

This method is deprecated because it depends on having a Ruby frame pushed for checking method visibility, and there's no way to enforce that. Most users of this method probably don't need to check visibility. See https://github.com/jruby/jruby/issues/4134

invoke

@Deprecated(since="9.4-")
public IRubyObject invoke(ThreadContext context,
 IRubyObject self,
 String name,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2,
 CallType callType)

Deprecated.

Use finvoke if you do not want visibility-checking or invokeFrom if you do.

This method is deprecated because it depends on having a Ruby frame pushed for checking method visibility, and there's no way to enforce that. Most users of this method probably don't need to check visibility. See https://github.com/jruby/jruby/issues/4134

getObjectIdAccessorField

@Deprecated(since="9.4-")
public VariableAccessorField getObjectIdAccessorField()

Deprecated.

getFFIHandleAccessorField

@Deprecated(since="9.4-")
public VariableAccessorField getFFIHandleAccessorField()

Deprecated.

getObjectGroupAccessorField

@Deprecated(since="9.4-")
public VariableAccessorField getObjectGroupAccessorField()

Deprecated.

invokeFrom

@Deprecated
public IRubyObject invokeFrom(ThreadContext context,
 CallType callType,
 IRubyObject caller,
 IRubyObject self,
 String name,
 Block block)

Deprecated.

invokeFrom

@Deprecated
public IRubyObject invokeFrom(ThreadContext context,
 CallType callType,
 IRubyObject caller,
 IRubyObject self,
 String name,
 IRubyObject[] args,
 Block block)

Deprecated.

invokeFrom

@Deprecated
public IRubyObject invokeFrom(ThreadContext context,
 CallType callType,
 IRubyObject caller,
 IRubyObject self,
 String name,
 IRubyObject arg,
 Block block)

Deprecated.

invokeFrom

@Deprecated
public IRubyObject invokeFrom(ThreadContext context,
 CallType callType,
 IRubyObject caller,
 IRubyObject self,
 String name,
 IRubyObject arg0,
 IRubyObject arg1,
 Block block)

Deprecated.

invokeFrom

@Deprecated
public IRubyObject invokeFrom(ThreadContext context,
 CallType callType,
 IRubyObject caller,
 IRubyObject self,
 String name,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2,
 Block block)

Deprecated.

invokeFrom

@Deprecated
public IRubyObject invokeFrom(ThreadContext context,
 CallType callType,
 IRubyObject caller,
 IRubyObject self,
 String name)

Deprecated.

invokeFrom

@Deprecated
public IRubyObject invokeFrom(ThreadContext context,
 CallType callType,
 IRubyObject caller,
 IRubyObject self,
 String name,
 IRubyObject[] args)

Deprecated.

invokeFrom

@Deprecated
public IRubyObject invokeFrom(ThreadContext context,
 CallType callType,
 IRubyObject caller,
 IRubyObject self,
 String name,
 IRubyObject arg)

Deprecated.

invokeFrom

@Deprecated
public IRubyObject invokeFrom(ThreadContext context,
 CallType callType,
 IRubyObject caller,
 IRubyObject self,
 String name,
 IRubyObject arg0,
 IRubyObject arg1)

Deprecated.

invokeFrom

@Deprecated
public IRubyObject invokeFrom(ThreadContext context,
 CallType callType,
 IRubyObject caller,
 IRubyObject self,
 String name,
 IRubyObject arg0,
 IRubyObject arg1,
 IRubyObject arg2)

Deprecated.