Package org.jruby

Class RubyModule

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyModule

All Implemented Interfaces:

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

Direct Known Subclasses:

JavaPackage, RubyClass

public class RubyModule
extends RubyObject

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	RubyModule.Autoload	Objects for holding autoload state for the defined constant.
static interface	RubyModule.AutoloadMethod	Deprecated.
protected static class	RubyModule.CacheEntryFactory
static class	RubyModule.ConstantEntry	Represents a constant value, possibly hidden (private).
static class	RubyModule.InvalidatorList<T>
static final class	RubyModule.JavaClassKindOf
static class	RubyModule.KindOf
static final class	RubyModule.MethodClumper
static class	RubyModule.ModuleKernelMethods	Deprecated.
protected static class	RubyModule.ProfilingCacheEntryFactory
static class	RubyModule.RefinementMethods
static class	RubyModule.RespondToMissingMethod
static interface	RubyModule.SourceLocation
protected static class	RubyModule.SynchronizedCacheEntryFactory
protected static class	RubyModule.WrapperCacheEntryFactory	A wrapper CacheEntryFactory, for delegating cache entry creation along a chain.

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
protected String	baseName	The base name of this class/module, excluding nesting.
static final String	BUILTIN_CONSTANT
protected Map<String,CacheEntry>	cachedMethods
static final int	CACHEPROXY_F
protected ClassIndex	classIndex
protected int	generation
protected Integer	generationObject
final int	id
static final int	INCLUDED_INTO_REFINEMENT
protected org.jruby.RubyClass.RubyClassSet	includingHierarchies
int	index	Deprecated. use RubyModule#getClassIndex()
static final int	IS_OVERLAID_F
RubyModule.KindOf	kindOf
protected final Invalidator	methodInvalidator
protected RubyModule	methodLocation	Where are the methods of this module/class located? This only happens as a result of prepend (see PrependedModule) where it moves all methods to a PrependedModule which will be beneath the actual module which was prepended.
protected Map<String,DynamicMethod>	methods
static final ObjectAllocator	MODULE_ALLOCATOR
static final int	NEEDSIMPL_F
protected static final RubyModule.CacheEntryFactory	NormalCacheEntryFactory
static final int	OMOD_SHARED
RubyModule	parent	The class/module within whose namespace this class/module resides.
static final int	REFINED_MODULE_F
static final Set<String>	SCOPE_CAPTURING_METHODS	Deprecated.
protected RubyClass	superClass
static final int	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
	RubyModule(Ruby runtime)	standard path for Module construction
protected	RubyModule(Ruby runtime, RubyClass metaClass)	used by MODULE_ALLOCATOR and RubyClass constructors
protected	RubyModule(Ruby runtime, RubyClass metaClass, boolean objectSpace)	separate path for MetaClass construction

Method Summary

Modifier and Type	Method	Description
IRubyObject	_module_function(ThreadContext context, IRubyObject[] args)	rb_mod_modfunc
IRubyObject	_private(ThreadContext context, IRubyObject[] args)	rb_mod_private
IRubyObject	_protected(ThreadContext context, IRubyObject[] args)	rb_mod_protected
IRubyObject	_public(ThreadContext context, IRubyObject[] args)	rb_mod_public
final void	addClassProvider(ClassProvider provider)
void	addIncludingHierarchy(IncludedModule hierarchy)
void	addMethod(String id, DynamicMethod method)	Deprecated.
void	addMethod(ThreadContext context, String id, DynamicMethod method)
final void	addMethodInternal(String name, DynamicMethod method)	Deprecated.
final void	addMethodInternal(ThreadContext context, String name, DynamicMethod method)
protected void	addMethodSymbols(Ruby runtime, Set<String> seen, RubyArray ary, boolean not, Visibility visibility)	Deprecated.
protected void	addMethodSymbols(ThreadContext context, Set<String> seen, RubyArray ary, boolean not, Visibility visibility)
void	addModuleFunction(String name, DynamicMethod method)	Deprecated.
void	addReadAttribute(ThreadContext context, String name)
void	addReadWriteAttribute(ThreadContext context, String name)
protected CacheEntry	addToCache(String id, DynamicMethod method, RubyModule sourceModule, int token)
protected CacheEntry	addToCache(String id, CacheEntry entry)
void	addWriteAttribute(ThreadContext context, String name)
RubyModule	alias_method(ThreadContext context, IRubyObject newId, IRubyObject oldId)	Old version of aliasMethod(ThreadContext, IRubyObject, IRubyObject) that returns this module.
IRubyObject	aliasMethod(ThreadContext context, IRubyObject newId, IRubyObject oldId)	Add an alias under the name newId pointing at the method under the name oldId.
RubyArray	ancestors()	Deprecated.
RubyArray	ancestors(ThreadContext context)	rb_mod_ancestors
RubyModule	append_features(IRubyObject include)	Deprecated.
RubyModule	append_features(ThreadContext context, IRubyObject include)	rb_mod_append_features
IRubyObject	attr(ThreadContext context, IRubyObject[] args)	rb_mod_attr
IRubyObject	attr_accessor(IRubyObject[] args)	Deprecated.
IRubyObject	attr_accessor(ThreadContext context, IRubyObject[] args)	rb_mod_attr_accessor Note: this method should not be called from Java in most cases, since it depends on Ruby frame state for visibility.
IRubyObject	attr_reader(IRubyObject[] args)	Deprecated.
IRubyObject	attr_reader(ThreadContext context, IRubyObject[] args)	rb_mod_attr_reader
IRubyObject	attr_writer(ThreadContext context, IRubyObject[] args)	rb_mod_attr_writer
IRubyObject	autoload(ThreadContext context, IRubyObject symbol, IRubyObject file)
IRubyObject	autoload_p(ThreadContext context, IRubyObject symbol)
IRubyObject	autoload_p(ThreadContext context, IRubyObject symbol, IRubyObject inherit)
boolean	autoloadingValue(Ruby runtime, String name)	Deprecated.
boolean	autoloadingValue(ThreadContext context, String name)
<T extends RubyModule> T	baseName(String name)	Set the base name of the class.
void	becomeSynchronized()
protected void	checkForCyclicPrepend(ThreadContext context, RubyModule m)
final void	checkFrozen()	The actual method that checks frozen with the default frozen message from MRI.
void	checkValidBindTargetFrom(ThreadContext context, RubyModule originModule, boolean fromBind)
IRubyObject	class_variable_defined_p(ThreadContext context, IRubyObject var)
IRubyObject	class_variable_get(IRubyObject name)	Deprecated.
IRubyObject	class_variable_get(ThreadContext context, IRubyObject name)	rb_mod_cvar_get
IRubyObject	class_variable_get19(IRubyObject name)	Deprecated.
IRubyObject	class_variable_set(IRubyObject name, IRubyObject value)	Deprecated.
IRubyObject	class_variable_set(ThreadContext context, IRubyObject name, IRubyObject value)	rb_mod_cvar_set
IRubyObject	class_variable_set19(IRubyObject name, IRubyObject value)	Deprecated.
RubyArray	class_variables(ThreadContext context)
RubyArray	class_variables(ThreadContext context, IRubyObject inherit)
<T extends RubyModule> T	classIndex(ClassIndex classIndex)	Sets the ClassIndex for this type
protected final IRubyObject	cloneMethods(RubyModule clone)	Deprecated.
protected final IRubyObject	cloneMethods(ThreadContext context, RubyModule clone)
IRubyObject	const_added(ThreadContext context, IRubyObject _newConstant)
RubyBoolean	const_defined_p(ThreadContext context, IRubyObject name)	rb_mod_const_defined
RubyBoolean	const_defined_p(ThreadContext context, IRubyObject name, IRubyObject recurse)
IRubyObject	const_get(IRubyObject symbol)	Deprecated.
IRubyObject	const_get(ThreadContext context, IRubyObject arg0)
IRubyObject	const_get(ThreadContext context, IRubyObject... args)	Deprecated.
IRubyObject	const_get(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
IRubyObject	const_get_1_9(ThreadContext context, IRubyObject[] args)	Deprecated.
IRubyObject	const_get_2_0(ThreadContext context, IRubyObject[] args)	Deprecated.
IRubyObject	const_missing(ThreadContext context, IRubyObject rubyName, Block block)	Base implementation of Module#const_missing, throws NameError for specific missing constant.
IRubyObject	const_set(IRubyObject name, IRubyObject value)	Deprecated.
IRubyObject	const_set(ThreadContext context, IRubyObject name, IRubyObject value)	rb_mod_const_set
IRubyObject	const_source_location(ThreadContext context, IRubyObject[] args)
protected RubyModule.ConstantEntry	constantEntryFetch(String name)
RubyArray	constants(ThreadContext context)
RubyArray	constants(ThreadContext context, IRubyObject allConstants)
Collection<String>	constantsCommon(Ruby runtime, boolean replaceModule, boolean allConstants)	rb_mod_constants
Collection<String>	constantsCommon(Ruby runtime, boolean replaceModule, boolean allConstants, boolean includePrivate)
protected boolean	constantTableContains(String name)
protected IRubyObject	constantTableFetch(String name)
protected IRubyObject	constantTableRemove(String name)
protected IRubyObject	constantTableStore(String name, IRubyObject value)
protected IRubyObject	constantTableStore(String name, IRubyObject value, boolean hidden)
protected IRubyObject	constantTableStore(String name, IRubyObject value, boolean hidden, boolean deprecated)
protected IRubyObject	constantTableStore(String name, IRubyObject value, boolean hidden, boolean deprecated, String file, int line)
boolean	constDefined(String name)	Deprecated.
boolean	constDefined(ThreadContext context, String name)
boolean	constDefinedAt(String name)	Deprecated.
boolean	constDefinedAt(ThreadContext context, String name)
boolean	constDefinedFrom(String name)	Deprecated.
boolean	constDefinedFrom(ThreadContext context, String name)
IRubyObject	define_method(ThreadContext context, IRubyObject[] args, Block block)	Deprecated.
IRubyObject	define_method(ThreadContext context, IRubyObject arg0, Block block)
IRubyObject	define_method(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
void	defineAlias(String name, String oldName)	Deprecated. Use aliasMethod(ThreadContext, IRubyObject, IRubyObject) instead
<T extends RubyModule> T	defineAlias(ThreadContext context, String name, String oldName)	Define an alias on this module/class.
void	defineAliases(List<String> aliases, String oldId)	Deprecated.
final boolean	defineAnnotatedConstant(Field field)	Deprecated. Use defineAnnotatedConstant(ThreadContext, Field) instead.
final void	defineAnnotatedConstants(Class clazz)	Deprecated. Use defineConstants(ThreadContext, Class) instead.
void	defineAnnotatedMethod(Class clazz, String name)	Deprecated. Use defineMethods(ThreadContext, Class[]) and organize your method definitions where you only specify the .class and not needing to add a name as a discriminator.
final boolean	defineAnnotatedMethod(Method method, MethodFactory methodFactory)	Deprecated.
final boolean	defineAnnotatedMethod(String name, List<JavaMethodDescriptor> methods, MethodFactory methodFactory)	Deprecated. Use defineMethods(ThreadContext, Class[]) instead and organize your code around all JRubyMethod annotations in that .class being defined.
final boolean	defineAnnotatedMethod(String name, JavaMethodDescriptor desc, MethodFactory methodFactory)	Deprecated.
final void	defineAnnotatedMethod(ThreadContext context, String name, List<JavaMethodDescriptor> methods, MethodFactory methodFactory)	This is an internal API used by the type populator.
void	defineAnnotatedMethods(Class clazz)	Deprecated. Use defineMethods(ThreadContext, Class[]) instead.
final void	defineAnnotatedMethodsIndividually(Class clazz)	Deprecated.
protected final void	defineAutoload(String symbol, RubyString path)	Deprecated.
protected final void	defineAutoload(ThreadContext context, String symbol, RubyString path)	Define an autoload.
RubyClass	defineClassUnder(String name, RubyClass superClass, ObjectAllocator allocator)	Deprecated. Use defineClassUnder(ThreadContext, String, RubyClass, ObjectAllocator) instead.
<T extends RubyClass> T	defineClassUnder(ThreadContext context, String name, RubyClass superClass, ObjectAllocator allocator)	Define a Class under this Class/Module.
RubyClass	defineClassUnder(ThreadContext context, String name, RubyClass superClazz, ObjectAllocator allocator, String file, int line)	Internal API only used by our IR runtime helpers in setting up Ruby-defined classes or re-accessing them if they already exist.
void	defineConstant(String name, IRubyObject value)	Deprecated.
<T extends RubyModule> T	defineConstant(ThreadContext context, String name, IRubyObject value)	Define a constant when you are defining your Ruby class/module.
<T extends RubyModule> T	defineConstant(ThreadContext context, String name, IRubyObject value, boolean hidden)	Define a constant when you are defining your Ruby class/module.
void	defineConstantBootstrap(String name, IRubyObject value)	This is an internal API which is only used during runtime creation but BEFORE the first ThreadContext is created.
<T extends RubyModule> T	defineConstants(ThreadContext context, Class constantSource)	Define constant for your module/class with the supplied Class which contains @JRubyMethod annotations.
<C extends Enum<C> & jnr.constants.Constant, T extends RubyModule> T	defineConstantsFrom(ThreadContext context, Class<C> enumClass)	Define all constants from the given jnr-constants enum which are defined on the current platform.
IRubyObject	defineMethodFromBlock(ThreadContext context, IRubyObject arg0, Block block, Visibility visibility)
IRubyObject	defineMethodFromCallable(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Visibility visibility)
<T extends RubyModule> T	defineMethods(ThreadContext context, Class... methodSources)	Define methods for your module/class with the supplied Class which contains @JRubyMethod annotations.
RubyModule	defineModuleUnder(String name)	Deprecated.
RubyModule	defineModuleUnder(ThreadContext context, String name)	Define a module under this module.
RubyClass	defineOrGetClassUnder(String name, RubyClass superClazz)	Deprecated.
RubyClass	defineOrGetClassUnder(String name, RubyClass superClazz, String file, int line)	Deprecated.
RubyClass	defineOrGetClassUnder(String name, RubyClass superClazz, ObjectAllocator allocator)	Deprecated.
RubyClass	defineOrGetClassUnder(String name, RubyClass superClazz, ObjectAllocator allocator, String file, int line)	Deprecated.
RubyModule	defineOrGetModuleUnder(String name)	Deprecated.
RubyModule	defineOrGetModuleUnder(String name, String file, int line)	Deprecated.
RubyModule	defineOrGetModuleUnder(ThreadContext context, String name, String file, int line)
IRubyObject	deleteClassVariable(String name)	Deprecated.
IRubyObject	deleteConstant(String name)	Deprecated.
IRubyObject	deleteConstant(ThreadContext context, String name)
IRubyObject	deprecate_constant(ThreadContext context, IRubyObject name)
IRubyObject	deprecate_constant(ThreadContext context, IRubyObject[] names)
void	deprecateConstant(Ruby runtime, String name)	Deprecated.
void	deprecateConstant(ThreadContext context, String name)	Mark the named constant as deprecated.
Set<String>	discoverInstanceVariables()
protected final void	ensureClassVariablesSettable()	Deprecated.
protected final void	ensureConstantsSettable()	Deprecated.
boolean	equals(Object other)	We override equals here to provide a faster path, since equality for modules is pretty cut and dried.
void	exportMethod(String name, Visibility visibility)	Deprecated.
IRubyObject	extend_object(IRubyObject obj)	Deprecated.
IRubyObject	extend_object(ThreadContext context, IRubyObject obj)	rb_mod_extend_object
IRubyObject	extended(ThreadContext context, IRubyObject other, Block block)
IRubyObject	fastFetchClassVariable(String internedName)	Deprecated.
IRubyObject	fastFetchConstant(String internedName)	Deprecated.
RubyClass	fastGetClass(String internedName)	Deprecated.
IRubyObject	fastGetClassVar(String internedName)	Deprecated.
IRubyObject	fastGetConstant(String internedName)	Deprecated.
IRubyObject	fastGetConstant(String internedName, boolean inherit)	Deprecated.
IRubyObject	fastGetConstantAt(String internedName)	Deprecated.
IRubyObject	fastGetConstantFrom(String internedName)	Deprecated.
IRubyObject	fastGetConstantFromConstMissing(String internedName)	Deprecated.
IRubyObject	fastGetConstantFromNoConstMissing(String internedName)	Deprecated.
boolean	fastHasClassVariable(String internedName)	Deprecated.
boolean	fastHasConstant(String internedName)	Deprecated.
boolean	fastIsClassVarDefined(String internedName)	Deprecated.
boolean	fastIsConstantDefined(String internedName)	Deprecated.
IRubyObject	fastSetClassVar(String internedName, IRubyObject value)	Deprecated.
IRubyObject	fastSetConstant(String internedName, IRubyObject value)	Deprecated.
IRubyObject	fastStoreClassVariable(String internedName, IRubyObject value)	Deprecated.
IRubyObject	fastStoreConstant(String internedName, IRubyObject value)	Deprecated.
IRubyObject	fetchClassVariable(String name)
IRubyObject	fetchConstant(String name)	Deprecated.
IRubyObject	fetchConstant(String name, boolean includePrivate)	Deprecated.
IRubyObject	fetchConstant(ThreadContext context, String name)
IRubyObject	fetchConstant(ThreadContext context, String name, boolean includePrivate)
RubyModule.ConstantEntry	fetchConstantEntry(String name, boolean includePrivate)	Deprecated.
RubyModule.ConstantEntry	fetchConstantEntry(ThreadContext context, String name, boolean includePrivate)	The equivalent for fetchConstant but is useful for extra state like whether the constant is private or not.
RubyModule	findImplementer(RubyModule clazz)	Find the given class in this hierarchy, considering modules along the way.
protected final IRubyObject	finishAutoload(String name)	Deprecated.
protected final IRubyObject	finishAutoload(ThreadContext context, String name)	Extract an Object which is defined by autoload thread from autoloadMap and define it as a constant.
static void	finishCreateModuleClass(ThreadContext context, RubyClass Module)
static void	finishModuleClass(RubyClass Module)
static void	finishRefinementClass(ThreadContext context, RubyClass Refinement)
final IRubyObject	freeze(ThreadContext context)	rb_mod_freeze
List<IRubyObject>	getAncestorList()
final IRubyObject	getAutoloadConstant(String name)	Deprecated.
protected IRubyObject	getAutoloadConstant(String name, boolean loadConstant)	Deprecated.
final IRubyObject	getAutoloadConstant(ThreadContext context, String name)	Get autoload constant.
protected IRubyObject	getAutoloadConstant(ThreadContext context, String name, boolean loadConstant)
protected RubyString	getAutoloadFile(String name)
protected Map<String,RubyModule.Autoload>	getAutoloadMap()	AutoloadMap must be accessed after checking ConstantMap.
protected Map<String,RubyModule.Autoload>	getAutoloadMapForWrite()
String	getBaseName()	Get the base name of this class, or null if it is an anonymous class.
protected final Map<String,CacheEntry>	getCachedMethods()
boolean	getCacheProxy()	Get whether this Java proxy class should try to keep its instances idempotent and alive using the ObjectProxyCache.
final int	getCacheToken()	Deprecated.
RubyClass	getClass(String name)	Deprecated.
RubyClass	getClass(ThreadContext context, String name)	Finds a class that is within the current module/class.
ClassIndex	getClassIndex()	Get the ClassIndex for this class.
IRubyObject	getClassVar(String name)	Deprecated.
IRubyObject	getClassVar(IRubyObject nameObject, String name)	Deprecated.
IRubyObject	getClassVar(ThreadContext context, String name)	Retrieve the specified class variable, searching through this module, included modules, and supermodules.
IRubyObject	getClassVar(ThreadContext context, IRubyObject nameObject, String name)
List<String>	getClassVariableNameList()
protected Map<String,IRubyObject>	getClassVariables()
protected Map<String,IRubyObject>	getClassVariablesForRead()
IRubyObject	getClassVarQuiet(String name)	Deprecated.
IRubyObject	getConstant(String name)	Deprecated.
IRubyObject	getConstant(String name, boolean inherit)	Deprecated.
IRubyObject	getConstant(String name, boolean inherit, boolean includeObject)	Deprecated.
IRubyObject	getConstant(ThreadContext context, String name)	Retrieve the named constant, invoking 'const_missing' should that be appropriate.
IRubyObject	getConstant(ThreadContext context, String name, boolean inherit)
IRubyObject	getConstant(ThreadContext context, String name, boolean inherit, boolean includeObject)
IRubyObject	getConstantAt(String name)	Deprecated.
IRubyObject	getConstantAt(String name, boolean includePrivate)	Deprecated.
IRubyObject	getConstantAt(ThreadContext context, String name)
IRubyObject	getConstantAt(ThreadContext context, String name, boolean includePrivate)
IRubyObject	getConstantAtSpecial(String name)	Deprecated.
IRubyObject	getConstantAtSpecial(ThreadContext context, String name)	This version searches superclasses if we're starting with Object.
IRubyObject	getConstantFrom(String name)	Deprecated.
IRubyObject	getConstantFrom(ThreadContext context, String name)
IRubyObject	getConstantFromConstMissing(String name)	Deprecated.
IRubyObject	getConstantFromConstMissing(ThreadContext context, String name)
IRubyObject	getConstantFromNoConstMissing(String name)	Deprecated.
IRubyObject	getConstantFromNoConstMissing(String name, boolean includePrivate)	Deprecated.
IRubyObject	getConstantFromNoConstMissing(ThreadContext context, String name)
IRubyObject	getConstantFromNoConstMissing(ThreadContext context, String name, boolean includePrivate)
Map<String,RubyModule.ConstantEntry>	getConstantMap()
Map<String,RubyModule.ConstantEntry>	getConstantMapForWrite()
Collection<String>	getConstantNames()
Collection<String>	getConstantNames(boolean includePrivate)
IRubyObject	getConstantNoConstMissing(String name)	Deprecated.
IRubyObject	getConstantNoConstMissing(String name, boolean inherit)	Deprecated.
IRubyObject	getConstantNoConstMissing(String name, boolean inherit, boolean includeObject)	Deprecated.
IRubyObject	getConstantNoConstMissing(ThreadContext context, String name)
IRubyObject	getConstantNoConstMissing(ThreadContext context, String name, boolean inherit)
IRubyObject	getConstantNoConstMissing(ThreadContext context, String name, boolean inherit, boolean includeObject)
final IRubyObject	getConstantNoConstMissingSkipAutoload(String name)	Deprecated.
final IRubyObject	getConstantNoConstMissingSkipAutoload(ThreadContext context, String name)
IRubyObject	getConstantNoConstMissingSKipAutoload(String name)	Deprecated.
RubyModule.SourceLocation	getConstantSourceLocation(String name, boolean inherit, boolean includeObject)	Deprecated.
RubyModule.SourceLocation	getConstantSourceLocation(ThreadContext context, String name, boolean inherit, boolean includeObject)
IRubyObject	getConstantWithAutoload(String name, IRubyObject failedAutoloadValue, boolean includePrivate)	Deprecated.
IRubyObject	getConstantWithAutoload(ThreadContext context, String name, IRubyObject failedAutoloadValue, boolean includePrivate)	Search just this class for a constant value, or trigger autoloading.
RubyModule	getDelegate()
final int	getGeneration()
final Integer	getGenerationObject()
final MethodHandle	getIdTest()
protected org.jruby.RubyClass.RubyClassSet	getIncludingHierarchiesForWrite()
Invalidator	getInvalidator()
boolean	getJavaProxy()	Get whether this class is associated with (i.e.
RubyModule	getMethodLocation()
Map<String,DynamicMethod>	getMethods()
Map<String,DynamicMethod>	getMethodsForWrite()
RubyModule	getModule(String name)	Deprecated.
RubyModule	getModule(ThreadContext context, String name)	Finds a module that is within the current module (or class).
String	getName()	Deprecated.
String	getName(ThreadContext context)	Generate a fully-qualified class name or a #-style name for anonymous and singleton classes.
ClassIndex	getNativeClassIndex()	This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
RubyModule	getNonIncludedClass()	Deprecated.
RubyModule	getOrigin()	In an included or prepended module what is the ACTUAL module it represents?
RubyModule	getParent()
RubyModule	getRealModule()	Get the "real" module, either the current one or the nearest ancestor that is not a singleton or include wrapper.
Map<RubyModule,RubyModule>	getRefinements()
Map<RubyModule,RubyModule>	getRefinementsForWrite()
String	getSimpleName()	Deprecated.
String	getSimpleName(ThreadContext context)	Get the "simple" name for the class, which is either the "base" name or the "anonymous" class name.
List<Variable<IRubyObject>>	getStoredConstantList()	Deprecated.
List<String>	getStoredConstantNameList()	Deprecated.
RubyClass	getSuperClass()	Getter for property superClass.
boolean	hasAncestor(RubyModule type)
IRubyObject	hasAutoload(ThreadContext context, String idString, boolean inherit)
boolean	hasClassVariable(String name)
boolean	hasConstant(String name)
RubyFixnum	hash(ThreadContext context)	Will return the hash code of this object.
int	hashCode()	This override does not do "checked" dispatch since Object usually has #hash defined.
boolean	hasInternalModuleVariable(String name)	Behaves similarly to getClassVar(ThreadContext, String).
boolean	hasModuleInHierarchy(RubyModule type)
boolean	hasModuleInPrepends(RubyModule type)
boolean	hasPrepends()
RubyModule	include(IRubyObject[] modules)	Deprecated.
<T extends RubyModule> T	include(ThreadContext context, RubyModule module)	In Defining this type include a module.
RubyModule	include(ThreadContext context, IRubyObject module)
RubyModule	include(ThreadContext context, IRubyObject[] modules)	rb_mod_include
IRubyObject	include_p(ThreadContext context, IRubyObject arg)
IRubyObject	included(ThreadContext context, IRubyObject other)
RubyArray	included_modules(ThreadContext context)	rb_mod_included_modules
void	includeModule(IRubyObject arg)	Deprecated.
void	includeModule(ThreadContext context, IRubyObject arg)	Include a new module in this module or class.
IRubyObject	initialize(Block block)	Deprecated.
IRubyObject	initialize(ThreadContext context, Block block)	rb_mod_initialize
IRubyObject	initialize_copy(ThreadContext context, IRubyObject original)	mri: rb_mod_init_copy
IRubyObject	instance_method(IRubyObject symbol)	Deprecated.
IRubyObject	instance_method(ThreadContext context, IRubyObject symbol)
RubyArray<?>	instance_methods(IRubyObject[] args)	Deprecated.
RubyArray	instance_methods(ThreadContext context, IRubyObject[] args)
RubyArray<?>	instance_methods19(IRubyObject[] args)	Deprecated.
RubyArray	instanceMethods(IRubyObject[] args, Visibility visibility, boolean obj, boolean not)	Deprecated.
RubyArray	instanceMethods(ThreadContext context, IRubyObject[] args, Visibility visibility, boolean obj, boolean not)
RubyArray	instanceMethods(Visibility visibility, boolean includeSuper, boolean obj, boolean not)	Deprecated.
void	invalidateCacheDescendants()	Deprecated.
void	invalidateCacheDescendants(ThreadContext context)
protected void	invalidateConstantCache(String constantName)	Deprecated.
protected void	invalidateConstantCache(ThreadContext context, String constantName)
protected void	invalidateConstantCaches(Set<String> constantNames)	Deprecated.
protected void	invalidateCoreClasses()	Deprecated.
boolean	isClass()	Specifically polymorphic method that are meant to be overridden by classes to specify that they are classes in an easy way.
boolean	isClassVarDefined(String name)	Is class var defined? Ruby C equivalent = "rb_cvar_defined"
boolean	isConstantDefined(String name)	Deprecated.
boolean	isConstantDefined(String name, boolean inherit)	Deprecated.
boolean	isConstantDefined(ThreadContext context, String name)
boolean	isIncluded()	Is this module one that in an included one (e.g.
boolean	isIncludedIntoRefinement()
boolean	isInstance(IRubyObject object)
boolean	isKindOfModule(RubyModule type)
boolean	isMethodBound(String name, boolean checkVisibility)	MRI: rb_method_boundp
boolean	isMethodBound(String name, boolean checkVisibility, boolean checkRespondTo)	Deprecated.
boolean	isMethodBuiltin(String methodName)	Return true if the given method is defined on this class and is a builtin, i.e.
boolean	isModule()	Specifically polymorphic method that are meant to be overridden by modules to specify that they are modules in an easy way.
boolean	isPrepended()
boolean	isRefinement()
protected boolean	isSame(RubyModule module)
protected boolean	isSameOrigin(RubyModule other)
boolean	isSingleton()
boolean	isSynchronized()
static boolean	isValidConstantName(ByteList bytelist, int start, int end)
static boolean	isValidConstantPath(RubyString str)
<T extends RubyModule> T	kindOf(RubyModule.KindOf kindOf)	Set the method for determining whether an Object is a kind of the supplied type.
static TypePopulator	loadPopulatorFor(Class<?> type)
static void	marshalTo(RubyModule module, MarshalStream output)	Deprecated, for removal: This API element is subject to removal in a future version.
static void	marshalTo(ThreadContext context, RubyOutputStream out, RubyModule module, MarshalDumper output)
IRubyObject	method_added(ThreadContext context, IRubyObject nothing)
RubyBoolean	method_defined_p(ThreadContext context, IRubyObject symbol)
RubyBoolean	method_defined_p(ThreadContext context, IRubyObject symbol, IRubyObject includeSuper)
IRubyObject	method_removed(ThreadContext context, IRubyObject nothing)
IRubyObject	method_undefined(ThreadContext context, IRubyObject nothing)
protected void	methodAdded(ThreadContext context, RubySymbol identifier)
IRubyObject	mix(ThreadContext context, IRubyObject modArg)
IRubyObject	mix(ThreadContext context, IRubyObject modArg, IRubyObject hash0)
IRubyObject	module_eval(ThreadContext context, Block block)
IRubyObject	module_eval(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	module_eval(ThreadContext context, IRubyObject arg0, Block block)
IRubyObject	module_eval(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Block block)
IRubyObject	module_eval(ThreadContext context, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block)
IRubyObject	module_exec(ThreadContext context, Block block)
IRubyObject	module_exec(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	module_function(ThreadContext context, IRubyObject[] args)
IRubyObject	name()	Deprecated.
IRubyObject	name(ThreadContext context)
boolean	needsImplementer()
static RubyArray	nesting(ThreadContext context, IRubyObject recv, Block block)	Return an array of nested modules or classes.
static Map<RubyModule,IncludedModule>	newActivatedRefinementsMap()
protected final MethodHandle	newIdTest()
IncludedModuleWrapper	newIncludeClass(RubyClass superClazz)	Deprecated.
final IRubyObject	newMethod(IRubyObject receiver, String methodName, boolean bound, Visibility visibility)	Deprecated.
final IRubyObject	newMethod(IRubyObject receiver, String methodName, boolean bound, Visibility visibility, boolean respondToMissing)	Deprecated.
IRubyObject	newMethod(IRubyObject receiver, String methodName, boolean bound, Visibility visibility, boolean respondToMissing, boolean priv)	Deprecated.
final IRubyObject	newMethod(IRubyObject receiver, String methodName, StaticScope refinedScope, boolean bound, Visibility visibility)	Deprecated.
final IRubyObject	newMethod(IRubyObject receiver, String methodName, StaticScope scope, boolean bound, Visibility visibility, boolean respondToMissing)	Deprecated.
IRubyObject	newMethod(IRubyObject receiver, String methodName, StaticScope scope, boolean bound, Visibility visibility, boolean respondToMissing, boolean priv)	Deprecated.
protected IRubyObject	newMethod(ThreadContext context, IRubyObject receiver, String methodName, StaticScope scope, boolean bound, Visibility visibility, boolean respondToMissing, boolean priv)
static RubyModule	newModule(Ruby runtime)	Deprecated.
static RubyModule	newModule(Ruby runtime, String name, RubyModule parent, boolean setParent)	Deprecated.
static RubyModule	newModule(Ruby runtime, String name, RubyModule parent, boolean setParent, String file, int line)	Deprecated.
static RubyModule	newModule(ThreadContext context, String name, RubyModule parent, boolean setParent, String file, int line)	rb_module_new/rb_define_module_id/rb_name_class/rb_set_class_path This is used by IR to define a new module.
static RubyModule	newModuleBootstrap(Ruby runtime, String name, RubyModule parent)
static Map<RubyModule,RubyModule>	newRefinementsMap()
static Map<RubyModule,RubyModule>	newRefinementsMap(Map<RubyModule,RubyModule> refinements)
IRubyObject	op_cmp(IRubyObject obj)	Deprecated.
IRubyObject	op_cmp(ThreadContext context, IRubyObject obj)	rb_mod_cmp
RubyBoolean	op_eqq(ThreadContext context, IRubyObject obj)	rb_mod_eqq
IRubyObject	op_equal(ThreadContext context, IRubyObject other)	rb_obj_equal Will by default use identity equality to compare objects.
IRubyObject	op_ge(IRubyObject obj)	Deprecated.
IRubyObject	op_ge(ThreadContext context, IRubyObject obj)	rb_mod_ge
IRubyObject	op_gt(IRubyObject obj)	Deprecated.
IRubyObject	op_gt(ThreadContext context, IRubyObject obj)	rb_mod_gt
IRubyObject	op_le(IRubyObject arg)	Deprecated.
IRubyObject	op_le(ThreadContext context, IRubyObject arg)	MRI: rb_class_inherited_p
IRubyObject	op_lt(IRubyObject obj)	Deprecated.
IRubyObject	op_lt(ThreadContext context, IRubyObject obj)	rb_mod_lt
IRubyObject	prepend(ThreadContext context, IRubyObject[] modules)
RubyModule	prepend_features(IRubyObject include)	Deprecated.
RubyModule	prepend_features(ThreadContext context, IRubyObject include)	rb_mod_prepend_features
IRubyObject	prepended(ThreadContext context, IRubyObject other)
void	prependModule(RubyModule module)	Deprecated.
void	prependModule(IRubyObject arg)	Deprecated.
void	prependModule(ThreadContext context, RubyModule module)	Prepend a new module to this module or class.
RubyModule	private_class_method(IRubyObject[] args)	Deprecated.
RubyModule	private_class_method(ThreadContext context, IRubyObject[] args)
IRubyObject	private_constant(ThreadContext context, IRubyObject name)
IRubyObject	private_constant(ThreadContext context, IRubyObject[] rubyNames)
RubyArray	private_instance_methods(IRubyObject[] args)	Deprecated.
RubyArray	private_instance_methods(ThreadContext context, IRubyObject[] args)	rb_class_private_instance_methods
IRubyObject	private_method_defined(ThreadContext context, IRubyObject symbol)
IRubyObject	private_method_defined(ThreadContext context, IRubyObject symbol, IRubyObject includeSuper)
RubyArray	protected_instance_methods(IRubyObject[] args)	Deprecated.
RubyArray	protected_instance_methods(ThreadContext context, IRubyObject[] args)	rb_class_protected_instance_methods
IRubyObject	protected_method_defined(ThreadContext context, IRubyObject symbol)
IRubyObject	protected_method_defined(ThreadContext context, IRubyObject symbol, IRubyObject includeSuper)
RubyModule	public_class_method(IRubyObject[] args)	Deprecated.
RubyModule	public_class_method(ThreadContext context, IRubyObject[] args)
IRubyObject	public_constant(ThreadContext context, IRubyObject name)
IRubyObject	public_constant(ThreadContext context, IRubyObject[] rubyNames)
IRubyObject	public_instance_method(IRubyObject symbol)	Deprecated.
IRubyObject	public_instance_method(ThreadContext context, IRubyObject symbol)
RubyArray<?>	public_instance_methods(IRubyObject[] args)	Deprecated.
RubyArray	public_instance_methods(ThreadContext context, IRubyObject[] args)
RubyArray<?>	public_instance_methods19(IRubyObject[] args)	Deprecated.
IRubyObject	public_method_defined(ThreadContext context, IRubyObject symbol)
IRubyObject	public_method_defined(ThreadContext context, IRubyObject symbol, IRubyObject includeSuper)
boolean	publicConstDefinedFrom(String name)	Deprecated.
boolean	publicConstDefinedFrom(ThreadContext context, String name)
void	putAlias(String id, DynamicMethod method, String oldName)	Deprecated.
void	putAlias(String id, CacheEntry entry, String oldName)	Deprecated.
void	putAlias(ThreadContext context, String id, DynamicMethod method, String oldName)	Note: Internal API - only public as its used by generated code!
void	putAlias(ThreadContext context, String id, CacheEntry entry, String oldName)	Alias the method contained in the given CacheEntry as a new entry in this module.
DynamicMethod	putMethod(Ruby runtime, String id, DynamicMethod method)	Deprecated.
DynamicMethod	putMethod(ThreadContext context, String id, DynamicMethod method)	Note: Internal API - only public as its used by generated code!
IRubyObject	rbPrivate(ThreadContext context, IRubyObject[] args)	Deprecated.
IRubyObject	rbProtected(ThreadContext context, IRubyObject[] args)	Deprecated.
IRubyObject	rbPublic(ThreadContext context, IRubyObject[] args)	Deprecated.
IRubyObject	refine(ThreadContext context, IRubyObject klass, Block block)
IRubyObject	refined_class(ThreadContext context)	Deprecated.
IRubyObject	refinements(ThreadContext context)
IRubyObject	remove_class_variable(ThreadContext context, IRubyObject name)	rb_mod_remove_cvar
IRubyObject	remove_class_variable19(ThreadContext context, IRubyObject name)	Deprecated.
IRubyObject	remove_const(ThreadContext context, IRubyObject rubyName)
RubyModule	remove_method(ThreadContext context, IRubyObject[] args)
final void	removeClassProvider(ClassProvider provider)
IRubyObject	removeClassVariable(String name)	Deprecated.
IRubyObject	removeClassVariable(ThreadContext context, String name)
void	removeMethod(ThreadContext context, String id)
CacheEntry	resolveRefinedMethod(RubyModule overlay, CacheEntry entry, String id, boolean cacheUndef)
final IRubyObject	resolveUndefConstant(String name)	Deprecated.
boolean	respondsToMethod(String name, boolean checkVisibility)
boolean	respondsToMethod(String name, boolean checkVisibility, StaticScope scope)
DynamicMethod	retrieveMethod(String name)	Search through this module and supermodules for method definitions.
IRubyObject	ruby2_keywords(ThreadContext context, IRubyObject[] args)
RubyString	rubyBaseName()	Deprecated.
RubyString	rubyBaseName(ThreadContext context)
RubyString	rubyName()	Deprecated.
RubyString	rubyName(ThreadContext context)	Generate a fully-qualified class name or a #-style name for anonymous and singleton classes which is properly encoded.
protected RubyModule	searchAncestor(RubyModule c)
IRubyObject	searchInternalModuleVariable(String name)	Behaves similarly to getClassVar(ThreadContext, String).
final DynamicMethod	searchMethod(String name)	Search through this module and supermodules for method definitions.
protected DynamicMethod	searchMethodCommon(String id)
CacheEntry	searchMethodEntryInner(String id)
DynamicMethod	searchMethodInner(String id)
DynamicMethod	searchMethodLateral(String id)	Deprecated.
CacheEntry	searchWithCache(String name)	Search for the named method in this class and in superclasses, and if found return the CacheEntry representing the method and this class's serial number.
final CacheEntry	searchWithCache(String id, boolean cacheUndef)	Search through this module and supermodules for method definitions.
CacheEntry	searchWithRefinements(String name, StaticScope refinedScope)	Search for the named method in this class and in superclasses applying refinements from the given scope.
IRubyObject	set_temporary_name(ThreadContext context, IRubyObject arg)
void	setBaseName(String name)	Deprecated. Use baseName(String) instead.
void	setCacheProxy(boolean cacheProxy)	Set whether this Java proxy class should try to keep its instances idempotent and alive using the ObjectProxyCache.
IRubyObject	setClassVar(String name, IRubyObject value)	Deprecated.
IRubyObject	setClassVar(ThreadContext context, String name, IRubyObject value)	Set the named class variable to the given value, provided freeze allows setting it.
IRubyObject	setConstant(String name, IRubyObject value)	Deprecated.
IRubyObject	setConstant(String name, IRubyObject value, boolean hidden)	Deprecated.
IRubyObject	setConstant(String name, IRubyObject value, String file, int line)	Deprecated.
IRubyObject	setConstant(ThreadContext context, String name, IRubyObject value)	Set the named constant on this module.
IRubyObject	setConstant(ThreadContext context, String name, IRubyObject value, boolean hidden)
IRubyObject	setConstant(ThreadContext context, String name, IRubyObject value, String file, int line)
IRubyObject	setConstantQuiet(String name, IRubyObject value)	Deprecated.
IRubyObject	setConstantQuiet(ThreadContext context, String name, IRubyObject value)	Set the named constant on this module.
final void	setConstantVisibility(Ruby runtime, String name, boolean hidden)	Deprecated.
final void	setConstantVisibility(ThreadContext context, String name, boolean hidden)
void	setInternalModuleVariable(String name, IRubyObject value)	Behaves similarly to setClassVar(ThreadContext, String, IRubyObject).
void	setJavaProxy(boolean javaProxy)	Set whether this class is associated with (i.e.
void	setMethodLocation(RubyModule module)
void	setMethodVisibility(IRubyObject[] methods, Visibility visibility)	Deprecated.
void	setMethodVisibility(ThreadContext context, IRubyObject[] methods, Visibility visibility)	set_method_visibility
void	setParent(RubyModule parent)
void	setRefinements(Map<RubyModule,RubyModule> refinements)
void	setSuperClass(RubyClass superClass)	Deprecated. Use superClass(RubyClass) instead.
IRubyObject	singleton_class_p(ThreadContext context)
IRubyObject	storeClassVariable(String name, IRubyObject value)	Deprecated.
IRubyObject	storeClassVariable(ThreadContext context, String name, IRubyObject value)
IRubyObject	storeConstant(String name, IRubyObject value)	Deprecated.
IRubyObject	storeConstant(String name, IRubyObject value, boolean hidden)	Deprecated.
IRubyObject	storeConstant(String name, IRubyObject value, boolean hidden, String file, int line)	Deprecated.
IRubyObject	storeConstant(ThreadContext context, String name, IRubyObject value)
IRubyObject	storeConstant(ThreadContext context, String name, IRubyObject value, boolean hidden, String file, int line)
RubyClass	superClass()	Get this module/class super class.
<T extends RubyModule> T	superClass(RubyClass superClass)	Set this module/class super class.
RubySymbol	symbolName()	Deprecated.
RubySymbol	symbolName(ThreadContext context)	Generate a fully-qualified class name or a #-style name as a Symbol.
void	syncClassVariables(RubyModule other)
void	syncConstants(RubyModule other)
<T extends RubyModule> T	tap(Consumer<T> consumer)	Provide itself to a lambda then return itself.
IRubyObject	target(ThreadContext context)
static boolean	testModuleMatch(ThreadContext context, IRubyObject arg0, int id)
RubyString	to_s()
IRubyObject	to_s(ThreadContext context)	rb_mod_to_s
<T> T	toJava(Class<T> target)	Convert the object to the specified Java class, if possible.
void	undef(ThreadContext context, String name)	rb_undef
RubyModule	undef_method(ThreadContext context, IRubyObject[] args)
IRubyObject	undefined_instance_method(ThreadContext context)
static String	undefinedMethodMessage(Ruby runtime, IRubyObject name, IRubyObject modName, boolean isModule)
void	undefineMethod(String name)	Deprecated. Use undefMethods(ThreadContext, String...) instead.
<T extends RubyModule> T	undefMethods(ThreadContext context, String... names)	Undefine a method from this type.
static RubyModule	unmarshalFrom(UnmarshalStream input)	Deprecated, for removal: This API element is subject to removal in a future version.
static RubyModule	unmarshalFrom(ThreadContext context, RubyInputStream in, MarshalLoader input)
void	updateGeneration()
IRubyObject	used_modules(ThreadContext context)
IRubyObject	used_refinements(ThreadContext context)
IRubyObject	using(ThreadContext context, IRubyObject refinedModule)
static void	usingModule(ThreadContext context, RubyModule cref, IRubyObject refinedModule)
boolean	usingTemporaryName()
protected final String	validateClassVariable(String name)	Deprecated.
protected String	validateClassVariable(Ruby runtime, IRubyObject object)	Deprecated.
protected final String	validateClassVariable(IRubyObject nameObj, String name)	Deprecated.
protected String	validateClassVariable(ThreadContext context, IRubyObject object)
protected final String	validateConstant(String name, IRubyObject errorName)	Deprecated.
protected final String	validateConstant(IRubyObject name)	Deprecated.
protected final String	validateConstant(ThreadContext context, IRubyObject name)	Validates name is a valid constant name and returns its id string.

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

CACHEPROXY_F

public static final int CACHEPROXY_F

NEEDSIMPL_F

public static final int NEEDSIMPL_F

REFINED_MODULE_F

public static final int REFINED_MODULE_F

IS_OVERLAID_F

public static final int IS_OVERLAID_F

OMOD_SHARED

public static final int OMOD_SHARED

INCLUDED_INTO_REFINEMENT

public static final int INCLUDED_INTO_REFINEMENT

TEMPORARY_NAME

public static final int TEMPORARY_NAME

BUILTIN_CONSTANT

public static final String BUILTIN_CONSTANT

See Also:

• Constant Field Values

MODULE_ALLOCATOR

public static final ObjectAllocator MODULE_ALLOCATOR

NormalCacheEntryFactory

protected static final RubyModule.CacheEntryFactory NormalCacheEntryFactory

kindOf

public RubyModule.KindOf kindOf

id

public final int id

parent

public RubyModule parent

The class/module within whose namespace this class/module resides.

baseName

protected String baseName

The base name of this class/module, excluding nesting. If null, this is an anonymous class.

methods

protected volatile Map<String,DynamicMethod> methods

cachedMethods

protected Map<String,CacheEntry> cachedMethods

generation

protected int generation

generationObject

protected Integer generationObject

includingHierarchies

protected volatile org.jruby.RubyClass.RubyClassSet includingHierarchies

methodLocation

protected volatile RubyModule methodLocation

Where are the methods of this module/class located? This only happens as a result of prepend (see PrependedModule) where it moves all methods to a PrependedModule which will be beneath the actual module which was prepended.

superClass

protected RubyClass superClass

index

@Deprecated
public int index

Deprecated.

use RubyModule#getClassIndex()

The index of this class in the ClassIndex. Only non-zero for native JRuby classes that have a corresponding entry in ClassIndex.

See Also:

• ClassIndex

SCOPE_CAPTURING_METHODS

@Deprecated
public static final Set<String> SCOPE_CAPTURING_METHODS

Deprecated.

classIndex

protected ClassIndex classIndex

methodInvalidator

protected final Invalidator methodInvalidator

Constructor Details

RubyModule

protected RubyModule(Ruby runtime,
 RubyClass metaClass,
 boolean objectSpace)

separate path for MetaClass construction

RubyModule

protected RubyModule(Ruby runtime,
 RubyClass metaClass)

used by MODULE_ALLOCATOR and RubyClass constructors

RubyModule

public RubyModule(Ruby runtime)

standard path for Module construction

Method Details

finishModuleClass

public static void finishModuleClass(RubyClass Module)

finishCreateModuleClass

public static void finishCreateModuleClass(ThreadContext context,
 RubyClass Module)

checkValidBindTargetFrom

public void checkValidBindTargetFrom(ThreadContext context,
 RubyModule originModule,
 boolean fromBind)
                              throws RaiseException

Throws:

RaiseException

getClassIndex

public ClassIndex getClassIndex()

Get the ClassIndex for this class. Will be NO_CLASS for non-core types.

autoload

public IRubyObject autoload(ThreadContext context,
 IRubyObject symbol,
 IRubyObject file)

autoload_p

public IRubyObject autoload_p(ThreadContext context,
 IRubyObject symbol)

autoload_p

public IRubyObject autoload_p(ThreadContext context,
 IRubyObject symbol,
 IRubyObject inherit)

hasAutoload

public IRubyObject hasAutoload(ThreadContext context,
 String idString,
 boolean inherit)

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 RubyObject

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 RubyBasicObject

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 RubyBasicObject

Returns:

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

isSingleton

public boolean isSingleton()

isInstance

public boolean isInstance(IRubyObject object)

hasAncestor

public boolean hasAncestor(RubyModule type)

getConstantMap

public Map<String,RubyModule.ConstantEntry> getConstantMap()

getConstantMapForWrite

public Map<String,RubyModule.ConstantEntry> getConstantMapForWrite()

getAutoloadMap

protected Map<String,RubyModule.Autoload> getAutoloadMap()

AutoloadMap must be accessed after checking ConstantMap. Checking UNDEF value in constantMap works as a guard. For looking up constant, check constantMap first then try to get an Autoload object from autoloadMap. For setting constant, update constantMap first and remove an Autoload object from autoloadMap.

getAutoloadMapForWrite

protected Map<String,RubyModule.Autoload> getAutoloadMapForWrite()

getIncludingHierarchiesForWrite

protected org.jruby.RubyClass.RubyClassSet getIncludingHierarchiesForWrite()

addIncludingHierarchy

public void addIncludingHierarchy(IncludedModule hierarchy)

getIdTest

public final MethodHandle getIdTest()

newIdTest

protected final MethodHandle newIdTest()

needsImplementer

public boolean needsImplementer()

newModule

@Deprecated(since="10.0")
public static RubyModule newModule(Ruby runtime)

Deprecated.

rb_module_new

newModule

@Deprecated(since="10.0")
public static RubyModule newModule(Ruby runtime,
 String name,
 RubyModule parent,
 boolean setParent,
 String file,
 int line)

Deprecated.

newModule

public static RubyModule newModule(ThreadContext context,
 String name,
 RubyModule parent,
 boolean setParent,
 String file,
 int line)

rb_module_new/rb_define_module_id/rb_name_class/rb_set_class_path This is used by IR to define a new module.

newModule

@Deprecated(since="10.0")
public static RubyModule newModule(Ruby runtime,
 String name,
 RubyModule parent,
 boolean setParent)

Deprecated.

newModuleBootstrap

public static RubyModule newModuleBootstrap(Ruby runtime,
 String name,
 RubyModule parent)

addClassProvider

public final void addClassProvider(ClassProvider provider)

removeClassProvider

public final void removeClassProvider(ClassProvider provider)

checkForCyclicPrepend

protected void checkForCyclicPrepend(ThreadContext context,
 RubyModule m)
                              throws RaiseException

Throws:

RaiseException

getSuperClass

public RubyClass getSuperClass()

Getter for property superClass.

Returns:

Value of property superClass.

setSuperClass

@Deprecated(since="10.0")
public void setSuperClass(RubyClass superClass)

Deprecated.

Use superClass(RubyClass) instead.

Parameters:

superClass -

getParent

public RubyModule getParent()

setParent

public void setParent(RubyModule parent)

getMethodLocation

public RubyModule getMethodLocation()

setMethodLocation

public void setMethodLocation(RubyModule module)

getMethods

public Map<String,DynamicMethod> getMethods()

getMethodsForWrite

public Map<String,DynamicMethod> getMethodsForWrite()

putMethod

@Deprecated(since="10.0")
public DynamicMethod putMethod(Ruby runtime,
 String id,
 DynamicMethod method)

Deprecated.

putMethod

public DynamicMethod putMethod(ThreadContext context,
 String id,
 DynamicMethod method)

Note: Internal API - only public as its used by generated code!

Parameters:

context - the current thread context

id - identifier string (8859_1). Matching entry in symbol table.

method -

Returns:

method

isIncluded

public boolean isIncluded()

Is this module one that in an included one (e.g. an IncludedModuleWrapper).

See Also:

• IncludedModule

isPrepended

public boolean isPrepended()

getOrigin

public RubyModule getOrigin()

In an included or prepended module what is the ACTUAL module it represents?

Returns:

the actual module of an included/prepended module.

getNonIncludedClass

@Deprecated
public RubyModule getNonIncludedClass()

Deprecated.

getDelegate

public RubyModule getDelegate()

getRealModule

public RubyModule getRealModule()

Get the "real" module, either the current one or the nearest ancestor that is not a singleton or include wrapper. See RubyClass.getRealClass().

Returns:

the nearest non-singleton non-include module in the hierarchy

getBaseName

public String getBaseName()

Get the base name of this class, or null if it is an anonymous class.

Returns:

base name of the class

setBaseName

@Deprecated(since="10.0")
public void setBaseName(String name)

Deprecated.

Use baseName(String) instead.

Set the base name of the class. If null, the class effectively becomes anonymous (though constants elsewhere may reference it).

Parameters:

name - the new base name of the class

getName

@Deprecated(since="10.0")
public String getName()

Deprecated.

getName

public String getName(ThreadContext context)

Generate a fully-qualified class name or a #-style name for anonymous and singleton classes. Ruby C equivalent = "classname"

Returns:

The generated class name

rubyName

@Deprecated(since="10.0")
public RubyString rubyName()

Deprecated.

rubyName

public RubyString rubyName(ThreadContext context)

Generate a fully-qualified class name or a #-style name for anonymous and singleton classes which is properly encoded. The returned string is always frozen.

Returns:

a properly encoded class name. Note: getId() is only really valid for ASCII values. This should be favored over using it.

symbolName

@Deprecated(since="10.0")
public RubySymbol symbolName()

Deprecated.

symbolName

public RubySymbol symbolName(ThreadContext context)

Generate a fully-qualified class name or a #-style name as a Symbol. If any element of the path is anonymous, returns null.

Returns:

a properly encoded non-anonymous class path as a Symbol, or null.

rubyBaseName

@Deprecated(since="10.0")
public RubyString rubyBaseName()

Deprecated.

rubyBaseName

public RubyString rubyBaseName(ThreadContext context)

getSimpleName

@Deprecated(since="10.0")
public String getSimpleName()

Deprecated.

getSimpleName

public String getSimpleName(ThreadContext context)

Get the "simple" name for the class, which is either the "base" name or the "anonymous" class name.

Returns:

the "simple" name of the class

set_temporary_name

public IRubyObject set_temporary_name(ThreadContext context,
 IRubyObject arg)

refine

public IRubyObject refine(ThreadContext context,
 IRubyObject klass,
 Block block)

using

public IRubyObject using(ThreadContext context,
 IRubyObject refinedModule)

usingModule

public static void usingModule(ThreadContext context,
 RubyModule cref,
 IRubyObject refinedModule)

newRefinementsMap

public static Map<RubyModule,RubyModule> newRefinementsMap(Map<RubyModule,RubyModule> refinements)

newRefinementsMap

public static Map<RubyModule,RubyModule> newRefinementsMap()

newActivatedRefinementsMap

public static Map<RubyModule,IncludedModule> newActivatedRefinementsMap()

used_modules

public IRubyObject used_modules(ThreadContext context)

newIncludeClass

@Deprecated
public IncludedModuleWrapper newIncludeClass(RubyClass superClazz)

Deprecated.

Create a wrapper to use for including the specified module into this one. Ruby C equivalent = "include_class_new"

Returns:

The module wrapper

getModule

@Deprecated(since="10.0")
public RubyModule getModule(String name)

Deprecated.

getModule

public RubyModule getModule(ThreadContext context,
 String name)

Finds a module that is within the current module (or class).

Parameters:

name - to be found in this module (or class)

Returns:

the module or null if no such module

Since:

9.2

getClass

@Deprecated(since="10.0")
public RubyClass getClass(String name)

Deprecated.

getClass

public RubyClass getClass(ThreadContext context,
 String name)

Finds a class that is within the current module/class. Also consider using the various methods in Access when they are core types to avoid a hash lookup.

Parameters:

context - the current thread context

name - to be found in this module (or class)

Returns:

the class or null if no such class

fastGetClass

@Deprecated
public RubyClass fastGetClass(String internedName)

Deprecated.

prependModule

@Deprecated(since="10.0")
public void prependModule(RubyModule module)

Deprecated.

prependModule

public void prependModule(ThreadContext context,
 RubyModule module)

Prepend a new module to this module or class. MRI: rb_prepend_module

Parameters:

module - The module to include

prependModule

@Deprecated
public void prependModule(IRubyObject arg)

Deprecated.

includeModule

@Deprecated(since="10.0")
public void includeModule(IRubyObject arg)

Deprecated.

includeModule

public void includeModule(ThreadContext context,
 IRubyObject arg)

Include a new module in this module or class.

Parameters:

arg - The module to include

defineAnnotatedMethod

@Deprecated(since="10.0")
public void defineAnnotatedMethod(Class clazz,
 String name)

Deprecated.

Use defineMethods(ThreadContext, Class[]) and organize your method definitions where you only specify the .class and not needing to add a name as a discriminator. This method is fairly inefficient since it is rescanning the class for all methods to find a single version.

Parameters:

clazz -

name -

defineAnnotatedConstants

@Deprecated(since="10.0")
public final void defineAnnotatedConstants(Class clazz)

Deprecated.

Use defineConstants(ThreadContext, Class) instead.

Parameters:

clazz -

defineAnnotatedConstant

@Deprecated(since="10.0")
public final boolean defineAnnotatedConstant(Field field)

Deprecated.

Use defineAnnotatedConstant(ThreadContext, Field) instead.

Parameters:

field -

Returns:

""

defineAnnotatedMethods

@Deprecated(since="10.0")
public void defineAnnotatedMethods(Class clazz)

Deprecated.

Use defineMethods(ThreadContext, Class[]) instead.

Parameters:

clazz -

loadPopulatorFor

public static TypePopulator loadPopulatorFor(Class<?> type)

defineAnnotatedMethodsIndividually

@Deprecated(since="10.0")
public final void defineAnnotatedMethodsIndividually(Class clazz)

Deprecated.

defineAnnotatedMethod

@Deprecated(since="10.0")
public final boolean defineAnnotatedMethod(String name,
 List<JavaMethodDescriptor> methods,
 MethodFactory methodFactory)

Deprecated.

Use defineMethods(ThreadContext, Class[]) instead and organize your code around all JRubyMethod annotations in that .class being defined.

Note: it is your responsibility to only pass methods which are annotated with @JRubyMethod. It will perform this check when only a single method is passed in but has never checked when more than one.

defineAnnotatedMethod

public final void defineAnnotatedMethod(ThreadContext context,
 String name,
 List<JavaMethodDescriptor> methods,
 MethodFactory methodFactory)

This is an internal API used by the type populator. This method takes a list of overloads for a static or non-static method and generates the

Parameters:

context - the current method context

name -

methods -

methodFactory -

defineAnnotatedMethod

@Deprecated(since="10.0")
public final boolean defineAnnotatedMethod(Method method,
 MethodFactory methodFactory)

Deprecated.

defineAnnotatedMethod

@Deprecated(since="10.0")
public final boolean defineAnnotatedMethod(String name,
 JavaMethodDescriptor desc,
 MethodFactory methodFactory)

Deprecated.

baseName

public <T extends RubyModule> T baseName(String name)

Set the base name of the class. If null, the class effectively becomes anonymous (though constants elsewhere may reference it).

Parameters:

name - the new base name of the class

Returns:

itself for a composable API.

classIndex

public <T extends RubyModule> T classIndex(ClassIndex classIndex)

Sets the ClassIndex for this type

Parameters:

classIndex - to be set

Returns:

itself for composable API

defineClassUnder

public <T extends RubyClass> T defineClassUnder(ThreadContext context,
 String name,
 RubyClass superClass,
 ObjectAllocator allocator)

Define a Class under this Class/Module.

Parameters:

context - the current thread context

name - name of the new class

superClass - superclass of this new class

allocator - how to allocate an instance of this class

Returns:

the new class

defineConstants

public <T extends RubyModule> T defineConstants(ThreadContext context,
 Class constantSource)

Define constant for your module/class with the supplied Class which contains @JRubyMethod annotations.

Parameters:

context -

constantSource - class containing the method annotations

Returns:

itself for composable API

defineConstantsFrom

public <C extends Enum<C> & jnr.constants.Constant,
T extends RubyModule>
T defineConstantsFrom(ThreadContext context,
 Class<C> enumClass)

Define all constants from the given jnr-constants enum which are defined on the current platform.

Type Parameters:

C - the enum type, which must implement Constant.

Parameters:

context - the current thread context

enumClass - the enum class of the constants to define

Returns:

itself for composable API

defineModuleUnder

public RubyModule defineModuleUnder(ThreadContext context,
 String name)

Define a module under this module.

Parameters:

context -

name -

Returns:

itself for a composable API

defineMethods

public <T extends RubyModule> T defineMethods(ThreadContext context,
 Class... methodSources)

Define methods for your module/class with the supplied Class which contains @JRubyMethod annotations.

Parameters:

context -

methodSources - class containing the method annotations

Returns:

itself for composable API

include

public <T extends RubyModule> T include(ThreadContext context,
 RubyModule module)

In Defining this type include a module. Note: This is for defining native extensions and differs from method of same name which is live include while executing Ruby code.

Parameters:

context -

module - to be included

Returns:

itself for composable API

kindOf

public <T extends RubyModule> T kindOf(RubyModule.KindOf kindOf)

Set the method for determining whether an Object is a kind of the supplied type.

Type Parameters:

T - class or module types

Parameters:

kindOf - method to determine kind-of status

Returns:

itself for composblae API

superClass

public RubyClass superClass()

Get this module/class super class.

Returns:

the super class

superClass

public <T extends RubyModule> T superClass(RubyClass superClass)

Set this module/class super class.

Type Parameters:

T - class or module type

Parameters:

superClass - to be set

Returns:

itself for composable API

tap

public <T extends RubyModule> T tap(Consumer<T> consumer)

Provide itself to a lambda then return itself.

Type Parameters:

T - A module or class

Parameters:

consumer - to be given this

Returns:

this

undefMethods

public <T extends RubyModule> T undefMethods(ThreadContext context,
 String... names)

Undefine a method from this type.

Parameters:

context -

names - the methods to undefine

Returns:

this type for composable API

undefineMethod

@Deprecated(since="10.0")
public void undefineMethod(String name)

Deprecated.

Use undefMethods(ThreadContext, String...) instead.

undef

public void undef(ThreadContext context,
 String name)

rb_undef

include_p

public IRubyObject include_p(ThreadContext context,
 IRubyObject arg)

singleton_class_p

public IRubyObject singleton_class_p(ThreadContext context)

addMethod

@Deprecated(since="10.0")
public void addMethod(String id,
 DynamicMethod method)

Deprecated.

addMethod

public void addMethod(ThreadContext context,
 String id,
 DynamicMethod method)

addMethodInternal

@Deprecated(since="10.0")
public final void addMethodInternal(String name,
 DynamicMethod method)

Deprecated.

addMethodInternal

public final void addMethodInternal(ThreadContext context,
 String name,
 DynamicMethod method)

removeMethod

public void removeMethod(ThreadContext context,
 String id)

searchMethod

public final DynamicMethod searchMethod(String name)

Search through this module and supermodules for method definitions. Cache superclass definitions in this class.

Parameters:

name - The name of the method to search for

Returns:

The method, or UndefinedMethod if not found

searchWithCache

public CacheEntry searchWithCache(String name)

Search for the named method in this class and in superclasses, and if found return the CacheEntry representing the method and this class's serial number. MRI: method_entry_get

Parameters:

name - the method name

Returns:

the CacheEntry corresponding to the method and this class's serial number

searchWithRefinements

public CacheEntry searchWithRefinements(String name,
 StaticScope refinedScope)

Search for the named method in this class and in superclasses applying refinements from the given scope. If found return the method; otherwise, return UndefinedMethod.

Parameters:

name - the method name

refinedScope - the scope containing refinements to search

Returns:

the method or UndefinedMethod

searchWithCache

public final CacheEntry searchWithCache(String id,
 boolean cacheUndef)

Search through this module and supermodules for method definitions. Cache superclass definitions in this class. MRI: method_entry_get

Parameters:

id - The name of the method to search for

cacheUndef - Flag for caching UndefinedMethod. This should normally be true.

Returns:

The method, or UndefinedMethod if not found

getCacheToken

@Deprecated
public final int getCacheToken()

Deprecated.

getGeneration

public final int getGeneration()

getGenerationObject

public final Integer getGenerationObject()

getCachedMethods

protected final Map<String,CacheEntry> getCachedMethods()

becomeSynchronized

public void becomeSynchronized()

isSynchronized

public boolean isSynchronized()

addToCache

protected CacheEntry addToCache(String id,
 DynamicMethod method,
 RubyModule sourceModule,
 int token)

addToCache

protected CacheEntry addToCache(String id,
 CacheEntry entry)

searchMethodInner

public DynamicMethod searchMethodInner(String id)

searchMethodEntryInner

public CacheEntry searchMethodEntryInner(String id)

searchMethodLateral

@Deprecated
public DynamicMethod searchMethodLateral(String id)

Deprecated.

Searches for a method up until the superclass, but include modules.

resolveRefinedMethod

public CacheEntry resolveRefinedMethod(RubyModule overlay,
 CacheEntry entry,
 String id,
 boolean cacheUndef)

searchMethodCommon

protected DynamicMethod searchMethodCommon(String id)

invalidateCacheDescendants

@Deprecated(since="10.0")
public void invalidateCacheDescendants()

Deprecated.

invalidateCacheDescendants

public void invalidateCacheDescendants(ThreadContext context)

invalidateCoreClasses

@Deprecated(since="10.0")
protected void invalidateCoreClasses()

Deprecated.

getInvalidator

public Invalidator getInvalidator()

updateGeneration

public void updateGeneration()

invalidateConstantCache

@Deprecated(since="10.0")
protected void invalidateConstantCache(String constantName)

Deprecated.

invalidateConstantCache

protected void invalidateConstantCache(ThreadContext context,
 String constantName)

invalidateConstantCaches

@Deprecated(since="10.0")
protected void invalidateConstantCaches(Set<String> constantNames)

Deprecated.

retrieveMethod

public DynamicMethod retrieveMethod(String name)

Search through this module and supermodules for method definitions. Cache superclass definitions in this class.

Parameters:

name - The name of the method to search for

Returns:

The method, or UndefinedMethod if not found

findImplementer

public RubyModule findImplementer(RubyModule clazz)

Find the given class in this hierarchy, considering modules along the way.

Parameters:

clazz - the class to find

Returns:

The method, or UndefinedMethod if not found

addModuleFunction

@Deprecated(since="10.0")
public void addModuleFunction(String name,
 DynamicMethod method)

Deprecated.

defineAlias

@Deprecated(since="10.0")
public void defineAlias(String name,
 String oldName)

Deprecated.

Use aliasMethod(ThreadContext, IRubyObject, IRubyObject) instead

Parameters:

name -

oldName -

putAlias

@Deprecated(since="10.0")
public void putAlias(String id,
 DynamicMethod method,
 String oldName)

Deprecated.

putAlias

public void putAlias(ThreadContext context,
 String id,
 DynamicMethod method,
 String oldName)

Note: Internal API - only public as its used by generated code!

Note: Used by AnnotationBinder.

Note: Not safe for target methods that super, since the frame class will not reflect original source.

Parameters:

id -

method -

oldName -

putAlias

@Deprecated(since="10.0")
public void putAlias(String id,
 CacheEntry entry,
 String oldName)

Deprecated.

putAlias

public void putAlias(ThreadContext context,
 String id,
 CacheEntry entry,
 String oldName)

Alias the method contained in the given CacheEntry as a new entry in this module.

Parameters:

id -

entry -

oldName -

defineOrGetClassUnder

@Deprecated(since="10.0")
public RubyClass defineOrGetClassUnder(String name,
 RubyClass superClazz)

Deprecated.

defineOrGetClassUnder

@Deprecated(since="10.0")
public RubyClass defineOrGetClassUnder(String name,
 RubyClass superClazz,
 String file,
 int line)

Deprecated.

defineOrGetClassUnder

@Deprecated(since="10.0")
public RubyClass defineOrGetClassUnder(String name,
 RubyClass superClazz,
 ObjectAllocator allocator)

Deprecated.

defineOrGetClassUnder

@Deprecated(since="10.0")
public RubyClass defineOrGetClassUnder(String name,
 RubyClass superClazz,
 ObjectAllocator allocator,
 String file,
 int line)

Deprecated.

defineClassUnder

public RubyClass defineClassUnder(ThreadContext context,
 String name,
 RubyClass superClazz,
 ObjectAllocator allocator,
 String file,
 int line)

Internal API only used by our IR runtime helpers in setting up Ruby-defined classes or re-accessing them if they already exist. Look at defineClassUnder(ThreadContext, String, RubyClass, ObjectAllocator) for native extensions.

Parameters:

name - to be defined

superClazz - the super class of this new class

allocator - how to allocate it

file - location where it was defined from

line - location where it was defined from

Returns:

the new class.

defineOrGetModuleUnder

@Deprecated(since="10.0")
public RubyModule defineOrGetModuleUnder(String name)

Deprecated.

this method should be used only by interpreter or compiler

defineOrGetModuleUnder

@Deprecated(since="10.0")
public RubyModule defineOrGetModuleUnder(String name,
 String file,
 int line)

Deprecated.

defineOrGetModuleUnder

public RubyModule defineOrGetModuleUnder(ThreadContext context,
 String name,
 String file,
 int line)

defineClassUnder

@Deprecated(since="10.0")
public RubyClass defineClassUnder(String name,
 RubyClass superClass,
 ObjectAllocator allocator)

Deprecated.

Use defineClassUnder(ThreadContext, String, RubyClass, ObjectAllocator) instead.

Parameters:

name -

superClass -

allocator -

Returns:

""

defineModuleUnder

@Deprecated
public RubyModule defineModuleUnder(String name)

Deprecated.

methodAdded

protected void methodAdded(ThreadContext context,
 RubySymbol identifier)

setMethodVisibility

@Deprecated(since="10.0")
public void setMethodVisibility(IRubyObject[] methods,
 Visibility visibility)

Deprecated.

setMethodVisibility

public void setMethodVisibility(ThreadContext context,
 IRubyObject[] methods,
 Visibility visibility)

set_method_visibility

exportMethod

@Deprecated(since="10.0")
public void exportMethod(String name,
 Visibility visibility)

Deprecated.

undefinedMethodMessage

public static String undefinedMethodMessage(Ruby runtime,
 IRubyObject name,
 IRubyObject modName,
 boolean isModule)

isMethodBound

public boolean isMethodBound(String name,
 boolean checkVisibility)

MRI: rb_method_boundp

respondsToMethod

public boolean respondsToMethod(String name,
 boolean checkVisibility,
 StaticScope scope)

respondsToMethod

public boolean respondsToMethod(String name,
 boolean checkVisibility)

isMethodBound

@Deprecated
public boolean isMethodBound(String name,
 boolean checkVisibility,
 boolean checkRespondTo)

Deprecated.

newMethod

@Deprecated(since="10.0")
public final IRubyObject newMethod(IRubyObject receiver,
 String methodName,
 boolean bound,
 Visibility visibility)

Deprecated.

newMethod

@Deprecated(since="10.0")
public final IRubyObject newMethod(IRubyObject receiver,
 String methodName,
 StaticScope refinedScope,
 boolean bound,
 Visibility visibility)

Deprecated.

newMethod

@Deprecated(since="10.0")
public final IRubyObject newMethod(IRubyObject receiver,
 String methodName,
 boolean bound,
 Visibility visibility,
 boolean respondToMissing)

Deprecated.

newMethod

@Deprecated(since="10.0")
public final IRubyObject newMethod(IRubyObject receiver,
 String methodName,
 StaticScope scope,
 boolean bound,
 Visibility visibility,
 boolean respondToMissing)

Deprecated.

newMethod

@Deprecated(since="10.0")
public IRubyObject newMethod(IRubyObject receiver,
 String methodName,
 boolean bound,
 Visibility visibility,
 boolean respondToMissing,
 boolean priv)

Deprecated.

newMethod

@Deprecated(since="10.0")
public IRubyObject newMethod(IRubyObject receiver,
 String methodName,
 StaticScope scope,
 boolean bound,
 Visibility visibility,
 boolean respondToMissing,
 boolean priv)

Deprecated.

newMethod

protected IRubyObject newMethod(ThreadContext context,
 IRubyObject receiver,
 String methodName,
 StaticScope scope,
 boolean bound,
 Visibility visibility,
 boolean respondToMissing,
 boolean priv)

define_method

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

defineMethodFromBlock

public IRubyObject defineMethodFromBlock(ThreadContext context,
 IRubyObject arg0,
 Block block,
 Visibility visibility)

define_method

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

defineMethodFromCallable

public IRubyObject defineMethodFromCallable(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1,
 Visibility visibility)

define_method

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

Deprecated.

name

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

Deprecated.

name

public IRubyObject name(ThreadContext context)

cloneMethods

@Deprecated(since="10.0")
protected final IRubyObject cloneMethods(RubyModule clone)

Deprecated.

cloneMethods

protected final IRubyObject cloneMethods(ThreadContext context,
 RubyModule clone)

initialize_copy

public IRubyObject initialize_copy(ThreadContext context,
 IRubyObject original)

mri: rb_mod_init_copy

Overrides:

initialize_copy in class RubyBasicObject

Parameters:

context - the thread context

original - the original

Returns:

a copy unless the same thing

syncConstants

public void syncConstants(RubyModule other)

syncClassVariables

public void syncClassVariables(RubyModule other)

included_modules

public RubyArray included_modules(ThreadContext context)

rb_mod_included_modules

hasPrepends

public boolean hasPrepends()

ancestors

public RubyArray ancestors(ThreadContext context)

rb_mod_ancestors

ancestors

@Deprecated(since="10.0")
public RubyArray ancestors()

Deprecated.

getAncestorList

public List<IRubyObject> getAncestorList()

hasModuleInPrepends

public boolean hasModuleInPrepends(RubyModule type)

hasModuleInHierarchy

public boolean hasModuleInHierarchy(RubyModule type)

hashCode

public int hashCode()

Description copied from class: RubyObject

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

Overrides:

hashCode in class RubyObject

Returns:

the hash code

See Also:

• RubyBasicObject.hashCode()

hash

public RubyFixnum hash(ThreadContext context)

Description copied from class: RubyBasicObject

Will return the hash code of this object. In comparison to MRI, this method will use the Java identity hash code instead of using rb_obj_id, since the usage of id in JRuby will incur the cost of some. ObjectSpace maintenance.

Overrides:

hash in class RubyBasicObject

Parameters:

context - the current thread context

Returns:

the hash value

to_s

public RubyString to_s()

Overrides:

to_s in class RubyBasicObject

Returns:

""

to_s

public IRubyObject to_s(ThreadContext context)

rb_mod_to_s

Overrides:

to_s in class RubyBasicObject

op_eqq

public RubyBoolean op_eqq(ThreadContext context,
 IRubyObject obj)

rb_mod_eqq

Specified by:

op_eqq in interface IRubyObject

Overrides:

op_eqq in class RubyObject

equals

public boolean equals(Object other)

We override equals here to provide a faster path, since equality for modules is pretty cut and dried.

Overrides:

equals in class RubyObject

Parameters:

other - The object to check for equality

Returns:

true if reference equality, false otherwise

See Also:

• RubyBasicObject.equals(Object)

op_equal

public IRubyObject op_equal(ThreadContext context,
 IRubyObject other)

Description copied from class: RubyBasicObject

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

Specified by:

op_equal in interface IRubyObject

Overrides:

op_equal in class RubyBasicObject

freeze

public final IRubyObject freeze(ThreadContext context)

rb_mod_freeze

Overrides:

freeze in class RubyBasicObject

op_le

@Deprecated(since="10.0")
public IRubyObject op_le(IRubyObject arg)

Deprecated.

op_le

public IRubyObject op_le(ThreadContext context,
 IRubyObject arg)

MRI: rb_class_inherited_p

searchAncestor

protected RubyModule searchAncestor(RubyModule c)

op_lt

@Deprecated(since="10.0")
public IRubyObject op_lt(IRubyObject obj)

Deprecated.

op_lt

public IRubyObject op_lt(ThreadContext context,
 IRubyObject obj)

rb_mod_lt

op_ge

@Deprecated(since="10.0")
public IRubyObject op_ge(IRubyObject obj)

Deprecated.

op_ge

public IRubyObject op_ge(ThreadContext context,
 IRubyObject obj)

rb_mod_ge

op_gt

@Deprecated(since="10.0")
public IRubyObject op_gt(IRubyObject obj)

Deprecated.

op_gt

public IRubyObject op_gt(ThreadContext context,
 IRubyObject obj)

rb_mod_gt

op_cmp

public IRubyObject op_cmp(ThreadContext context,
 IRubyObject obj)

rb_mod_cmp

Overrides:

op_cmp in class RubyBasicObject

op_cmp

@Deprecated
public IRubyObject op_cmp(IRubyObject obj)

Deprecated.

isKindOfModule

public boolean isKindOfModule(RubyModule type)

isSame

protected boolean isSame(RubyModule module)

isSameOrigin

protected boolean isSameOrigin(RubyModule other)

initialize

public IRubyObject initialize(ThreadContext context,
 Block block)

rb_mod_initialize

addReadWriteAttribute

public void addReadWriteAttribute(ThreadContext context,
 String name)

addReadAttribute

public void addReadAttribute(ThreadContext context,
 String name)

addWriteAttribute

public void addWriteAttribute(ThreadContext context,
 String name)

ruby2_keywords

public IRubyObject ruby2_keywords(ThreadContext context,
 IRubyObject[] args)

attr

public IRubyObject attr(ThreadContext context,
 IRubyObject[] args)

rb_mod_attr

attr_reader

@Deprecated
public IRubyObject attr_reader(IRubyObject[] args)

Deprecated.

attr_reader

public IRubyObject attr_reader(ThreadContext context,
 IRubyObject[] args)

rb_mod_attr_reader

attr_writer

public IRubyObject attr_writer(ThreadContext context,
 IRubyObject[] args)

rb_mod_attr_writer

attr_accessor

@Deprecated
public IRubyObject attr_accessor(IRubyObject[] args)

Deprecated.

attr_accessor

public IRubyObject attr_accessor(ThreadContext context,
 IRubyObject[] args)

rb_mod_attr_accessor Note: this method should not be called from Java in most cases, since it depends on Ruby frame state for visibility. Use add[Read/Write]Attribute instead.

instanceMethods

@Deprecated(since="10.0")
public RubyArray instanceMethods(IRubyObject[] args,
 Visibility visibility,
 boolean obj,
 boolean not)

Deprecated.

instanceMethods

public RubyArray instanceMethods(ThreadContext context,
 IRubyObject[] args,
 Visibility visibility,
 boolean obj,
 boolean not)

instanceMethods

@Deprecated(since="10.0")
public RubyArray instanceMethods(Visibility visibility,
 boolean includeSuper,
 boolean obj,
 boolean not)

Deprecated.

addMethodSymbols

@Deprecated(since="10.0")
protected void addMethodSymbols(Ruby runtime,
 Set<String> seen,
 RubyArray ary,
 boolean not,
 Visibility visibility)

Deprecated.

addMethodSymbols

protected void addMethodSymbols(ThreadContext context,
 Set<String> seen,
 RubyArray ary,
 boolean not,
 Visibility visibility)

instance_methods19

@Deprecated
public RubyArray<?> instance_methods19(IRubyObject[] args)

Deprecated.

instance_methods

@Deprecated
public RubyArray<?> instance_methods(IRubyObject[] args)

Deprecated.

instance_methods

public RubyArray instance_methods(ThreadContext context,
 IRubyObject[] args)

public_instance_methods19

@Deprecated
public RubyArray<?> public_instance_methods19(IRubyObject[] args)

Deprecated.

public_instance_methods

@Deprecated
public RubyArray<?> public_instance_methods(IRubyObject[] args)

Deprecated.

public_instance_methods

public RubyArray public_instance_methods(ThreadContext context,
 IRubyObject[] args)

instance_method

public IRubyObject instance_method(ThreadContext context,
 IRubyObject symbol)

instance_method

@Deprecated(since="10.0")
public IRubyObject instance_method(IRubyObject symbol)

Deprecated.

public_instance_method

@Deprecated(since="10.0")
public IRubyObject public_instance_method(IRubyObject symbol)

Deprecated.

public_instance_method

public IRubyObject public_instance_method(ThreadContext context,
 IRubyObject symbol)

protected_instance_methods

@Deprecated
public RubyArray protected_instance_methods(IRubyObject[] args)

Deprecated.

protected_instance_methods

public RubyArray protected_instance_methods(ThreadContext context,
 IRubyObject[] args)

rb_class_protected_instance_methods

private_instance_methods

@Deprecated
public RubyArray private_instance_methods(IRubyObject[] args)

Deprecated.

private_instance_methods

public RubyArray private_instance_methods(ThreadContext context,
 IRubyObject[] args)

rb_class_private_instance_methods

undefined_instance_method

public IRubyObject undefined_instance_method(ThreadContext context)

prepend_features

@Deprecated(since="10.0")
public RubyModule prepend_features(IRubyObject include)

Deprecated.

prepend_features

public RubyModule prepend_features(ThreadContext context,
 IRubyObject include)

rb_mod_prepend_features

append_features

@Deprecated(since="10.0")
public RubyModule append_features(IRubyObject include)

Deprecated.

append_features

public RubyModule append_features(ThreadContext context,
 IRubyObject include)

rb_mod_append_features

extend_object

@Deprecated(since="10.0")
public IRubyObject extend_object(IRubyObject obj)

Deprecated.

extend_object

public IRubyObject extend_object(ThreadContext context,
 IRubyObject obj)

rb_mod_extend_object

include

@Deprecated
public RubyModule include(IRubyObject[] modules)

Deprecated.

include

public RubyModule include(ThreadContext context,
 IRubyObject[] modules)

rb_mod_include

include

public RubyModule include(ThreadContext context,
 IRubyObject module)

included

public IRubyObject included(ThreadContext context,
 IRubyObject other)

extended

public IRubyObject extended(ThreadContext context,
 IRubyObject other,
 Block block)

mix

public IRubyObject mix(ThreadContext context,
 IRubyObject modArg)

mix

public IRubyObject mix(ThreadContext context,
 IRubyObject modArg,
 IRubyObject hash0)

_public

public IRubyObject _public(ThreadContext context,
 IRubyObject[] args)

rb_mod_public

rbPublic

@Deprecated
public IRubyObject rbPublic(ThreadContext context,
 IRubyObject[] args)

Deprecated.

_protected

public IRubyObject _protected(ThreadContext context,
 IRubyObject[] args)

rb_mod_protected

rbProtected

@Deprecated
public IRubyObject rbProtected(ThreadContext context,
 IRubyObject[] args)

Deprecated.

_private

public IRubyObject _private(ThreadContext context,
 IRubyObject[] args)

rb_mod_private

rbPrivate

@Deprecated
public IRubyObject rbPrivate(ThreadContext context,
 IRubyObject[] args)

Deprecated.

_module_function

public IRubyObject _module_function(ThreadContext context,
 IRubyObject[] args)

rb_mod_modfunc

module_function

public IRubyObject module_function(ThreadContext context,
 IRubyObject[] args)

const_added

public IRubyObject const_added(ThreadContext context,
 IRubyObject _newConstant)

method_added

public IRubyObject method_added(ThreadContext context,
 IRubyObject nothing)

method_removed

public IRubyObject method_removed(ThreadContext context,
 IRubyObject nothing)

method_undefined

public IRubyObject method_undefined(ThreadContext context,
 IRubyObject nothing)

method_defined_p

public RubyBoolean method_defined_p(ThreadContext context,
 IRubyObject symbol)

method_defined_p

public RubyBoolean method_defined_p(ThreadContext context,
 IRubyObject symbol,
 IRubyObject includeSuper)

public_method_defined

public IRubyObject public_method_defined(ThreadContext context,
 IRubyObject symbol)

public_method_defined

public IRubyObject public_method_defined(ThreadContext context,
 IRubyObject symbol,
 IRubyObject includeSuper)

protected_method_defined

public IRubyObject protected_method_defined(ThreadContext context,
 IRubyObject symbol)

protected_method_defined

public IRubyObject protected_method_defined(ThreadContext context,
 IRubyObject symbol,
 IRubyObject includeSuper)

private_method_defined

public IRubyObject private_method_defined(ThreadContext context,
 IRubyObject symbol)

private_method_defined

public IRubyObject private_method_defined(ThreadContext context,
 IRubyObject symbol,
 IRubyObject includeSuper)

public_class_method

@Deprecated(since="10.0")
public RubyModule public_class_method(IRubyObject[] args)

Deprecated.

public_class_method

public RubyModule public_class_method(ThreadContext context,
 IRubyObject[] args)

private_class_method

@Deprecated(since="10.0")
public RubyModule private_class_method(IRubyObject[] args)

Deprecated.

private_class_method

public RubyModule private_class_method(ThreadContext context,
 IRubyObject[] args)

aliasMethod

public IRubyObject aliasMethod(ThreadContext context,
 IRubyObject newId,
 IRubyObject oldId)

Add an alias under the name newId pointing at the method under the name oldId.

Parameters:

context - the current context

newId - the new name for the alias

oldId - the current name of the method

Returns:

the new name

alias_method

public RubyModule alias_method(ThreadContext context,
 IRubyObject newId,
 IRubyObject oldId)

Old version of aliasMethod(ThreadContext, IRubyObject, IRubyObject) that returns this module. The Ruby alias_method method was updated in 3.0 to return the new name.

Parameters:

context - the current context

newId - the new name for the alias

oldId - the current name of the method

Returns:

this module

undef_method

public RubyModule undef_method(ThreadContext context,
 IRubyObject[] args)

module_eval

public IRubyObject module_eval(ThreadContext context,
 Block block)

module_eval

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

module_eval

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

module_eval

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

module_eval

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

module_exec

public IRubyObject module_exec(ThreadContext context,
 Block block)

module_exec

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

remove_method

public RubyModule remove_method(ThreadContext context,
 IRubyObject[] args)

marshalTo

@Deprecated(since="10.0",
            forRemoval=true)
public static void marshalTo(RubyModule module,
 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,
 RubyModule module,
 MarshalDumper output)

unmarshalFrom

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

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

Throws:

IOException

unmarshalFrom

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

nesting

public static RubyArray nesting(ThreadContext context,
 IRubyObject recv,
 Block block)

Return an array of nested modules or classes.

class_variable_defined_p

public IRubyObject class_variable_defined_p(ThreadContext context,
 IRubyObject var)

class_variable_get19

@Deprecated
public IRubyObject class_variable_get19(IRubyObject name)

Deprecated.

class_variable_get

@Deprecated(since="10.0")
public IRubyObject class_variable_get(IRubyObject name)

Deprecated.

class_variable_get

public IRubyObject class_variable_get(ThreadContext context,
 IRubyObject name)

rb_mod_cvar_get

class_variable_set

@Deprecated(since="10.0")
public IRubyObject class_variable_set(IRubyObject name,
 IRubyObject value)

Deprecated.

class_variable_set

public IRubyObject class_variable_set(ThreadContext context,
 IRubyObject name,
 IRubyObject value)

rb_mod_cvar_set

class_variable_set19

@Deprecated
public IRubyObject class_variable_set19(IRubyObject name,
 IRubyObject value)

Deprecated.

remove_class_variable

public IRubyObject remove_class_variable(ThreadContext context,
 IRubyObject name)

rb_mod_remove_cvar

remove_class_variable19

@Deprecated
public IRubyObject remove_class_variable19(ThreadContext context,
 IRubyObject name)

Deprecated.

class_variables

public RubyArray class_variables(ThreadContext context)

class_variables

public RubyArray class_variables(ThreadContext context,
 IRubyObject inherit)

const_defined_p

public RubyBoolean const_defined_p(ThreadContext context,
 IRubyObject name)

rb_mod_const_defined

const_defined_p

public RubyBoolean const_defined_p(ThreadContext context,
 IRubyObject name,
 IRubyObject recurse)

const_get

public IRubyObject const_get(ThreadContext context,
 IRubyObject arg0)

const_get

public IRubyObject const_get(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

isValidConstantPath

public static boolean isValidConstantPath(RubyString str)

isValidConstantName

public static boolean isValidConstantName(ByteList bytelist,
 int start,
 int end)

const_source_location

public IRubyObject const_source_location(ThreadContext context,
 IRubyObject[] args)

const_set

@Deprecated(since="10.0")
public IRubyObject const_set(IRubyObject name,
 IRubyObject value)

Deprecated.

const_set

public IRubyObject const_set(ThreadContext context,
 IRubyObject name,
 IRubyObject value)

rb_mod_const_set

remove_const

public IRubyObject remove_const(ThreadContext context,
 IRubyObject rubyName)

const_missing

public IRubyObject const_missing(ThreadContext context,
 IRubyObject rubyName,
 Block block)

Base implementation of Module#const_missing, throws NameError for specific missing constant.

Parameters:

rubyName - The constant name which was found to be missing

Returns:

Nothing! Absolutely nothing! (though subclasses might choose to return something)

constants

public RubyArray constants(ThreadContext context)

constants

public RubyArray constants(ThreadContext context,
 IRubyObject allConstants)

constantsCommon

public Collection<String> constantsCommon(Ruby runtime,
 boolean replaceModule,
 boolean allConstants)

rb_mod_constants

constantsCommon

public Collection<String> constantsCommon(Ruby runtime,
 boolean replaceModule,
 boolean allConstants,
 boolean includePrivate)

deprecateConstant

@Deprecated(since="10.0")
public void deprecateConstant(Ruby runtime,
 String name)

Deprecated.

deprecateConstant

public void deprecateConstant(ThreadContext context,
 String name)

Mark the named constant as deprecated.

Parameters:

context - the current thread context

name - the name of the constant

deprecate_constant

public IRubyObject deprecate_constant(ThreadContext context,
 IRubyObject name)

deprecate_constant

public IRubyObject deprecate_constant(ThreadContext context,
 IRubyObject[] names)

private_constant

public IRubyObject private_constant(ThreadContext context,
 IRubyObject name)

private_constant

public IRubyObject private_constant(ThreadContext context,
 IRubyObject[] rubyNames)

public_constant

public IRubyObject public_constant(ThreadContext context,
 IRubyObject name)

public_constant

public IRubyObject public_constant(ThreadContext context,
 IRubyObject[] rubyNames)

prepend

public IRubyObject prepend(ThreadContext context,
 IRubyObject[] modules)

prepended

public IRubyObject prepended(ThreadContext context,
 IRubyObject other)

setConstantVisibility

@Deprecated(since="10.0")
public final void setConstantVisibility(Ruby runtime,
 String name,
 boolean hidden)

Deprecated.

setConstantVisibility

public final void setConstantVisibility(ThreadContext context,
 String name,
 boolean hidden)

refinements

public IRubyObject refinements(ThreadContext context)

refined_class

@Deprecated(since="10.0")
public IRubyObject refined_class(ThreadContext context)

Deprecated.

target

public IRubyObject target(ThreadContext context)

used_refinements

public IRubyObject used_refinements(ThreadContext context)

setClassVar

@Deprecated(since="10.0")
public IRubyObject setClassVar(String name,
 IRubyObject value)

Deprecated.

setClassVar

public IRubyObject setClassVar(ThreadContext context,
 String name,
 IRubyObject value)

Set the named class variable to the given value, provided freeze allows setting it. Ruby C equivalent = "rb_cvar_set"

Parameters:

name - The variable name to set

value - The value to set it to

fastSetClassVar

@Deprecated
public IRubyObject fastSetClassVar(String internedName,
 IRubyObject value)

Deprecated.

getClassVar

@Deprecated(since="10.0")
public IRubyObject getClassVar(String name)

Deprecated.

getClassVar

public IRubyObject getClassVar(ThreadContext context,
 String name)

Retrieve the specified class variable, searching through this module, included modules, and supermodules. Ruby C equivalent = "rb_cvar_get"

Parameters:

name - The name of the variable to retrieve

Returns:

The variable's value, or throws NameError if not found

getClassVar

@Deprecated(since="10.0")
public IRubyObject getClassVar(IRubyObject nameObject,
 String name)

Deprecated.

getClassVar

public IRubyObject getClassVar(ThreadContext context,
 IRubyObject nameObject,
 String name)

getClassVarQuiet

@Deprecated(since="10.0")
public IRubyObject getClassVarQuiet(String name)

Deprecated.

fastGetClassVar

@Deprecated
public IRubyObject fastGetClassVar(String internedName)

Deprecated.

isClassVarDefined

public boolean isClassVarDefined(String name)

Is class var defined? Ruby C equivalent = "rb_cvar_defined"

Parameters:

name - The class var to determine "is defined?"

Returns:

true if true, false if false

fastIsClassVarDefined

@Deprecated
public boolean fastIsClassVarDefined(String internedName)

Deprecated.

removeClassVariable

@Deprecated(since="10.0")
public IRubyObject removeClassVariable(String name)

Deprecated.

removeClassVariable

public IRubyObject removeClassVariable(ThreadContext context,
 String name)

getConstantAtSpecial

@Deprecated(since="10.0")
public IRubyObject getConstantAtSpecial(String name)

Deprecated.

getConstantAtSpecial

public IRubyObject getConstantAtSpecial(ThreadContext context,
 String name)

This version searches superclasses if we're starting with Object. This corresponds to logic in rb_const_defined_0 that recurses for Object only.

Parameters:

name - the constant name to find

Returns:

the constant, or null if it was not found

getConstantAt

@Deprecated(since="10.0")
public IRubyObject getConstantAt(String name)

Deprecated.

getConstantAt

public IRubyObject getConstantAt(ThreadContext context,
 String name)

getConstantAt

@Deprecated(since="10.0")
public IRubyObject getConstantAt(String name,
 boolean includePrivate)

Deprecated.

getConstantAt

public IRubyObject getConstantAt(ThreadContext context,
 String name,
 boolean includePrivate)

fastGetConstantAt

@Deprecated
public IRubyObject fastGetConstantAt(String internedName)

Deprecated.

getConstant

@Deprecated(since="10.0")
public IRubyObject getConstant(String name)

Deprecated.

getConstant

public IRubyObject getConstant(ThreadContext context,
 String name)

Retrieve the named constant, invoking 'const_missing' should that be appropriate.

Parameters:

name - The constant to retrieve

Returns:

The value for the constant, or null if not found

getConstant

@Deprecated(since="10.0")
public IRubyObject getConstant(String name,
 boolean inherit)

Deprecated.

getConstant

public IRubyObject getConstant(ThreadContext context,
 String name,
 boolean inherit)

getConstantSourceLocation

@Deprecated(since="10.0")
public RubyModule.SourceLocation getConstantSourceLocation(String name,
 boolean inherit,
 boolean includeObject)

Deprecated.

getConstantSourceLocation

public RubyModule.SourceLocation getConstantSourceLocation(ThreadContext context,
 String name,
 boolean inherit,
 boolean includeObject)

getConstant

@Deprecated(since="10.0")
public IRubyObject getConstant(String name,
 boolean inherit,
 boolean includeObject)

Deprecated.

getConstant

public IRubyObject getConstant(ThreadContext context,
 String name,
 boolean inherit,
 boolean includeObject)

fastGetConstant

@Deprecated
public IRubyObject fastGetConstant(String internedName)

Deprecated.

fastGetConstant

@Deprecated
public IRubyObject fastGetConstant(String internedName,
 boolean inherit)

Deprecated.

getConstantNoConstMissing

@Deprecated(since="10.0")
public IRubyObject getConstantNoConstMissing(String name)

Deprecated.

getConstantNoConstMissing

public IRubyObject getConstantNoConstMissing(ThreadContext context,
 String name)

getConstantNoConstMissing

@Deprecated(since="10.0")
public IRubyObject getConstantNoConstMissing(String name,
 boolean inherit)

Deprecated.

getConstantNoConstMissing

public IRubyObject getConstantNoConstMissing(ThreadContext context,
 String name,
 boolean inherit)

getConstantNoConstMissing

@Deprecated(since="10.0")
public IRubyObject getConstantNoConstMissing(String name,
 boolean inherit,
 boolean includeObject)

Deprecated.

getConstantNoConstMissing

public IRubyObject getConstantNoConstMissing(ThreadContext context,
 String name,
 boolean inherit,
 boolean includeObject)

getConstantNoConstMissingSkipAutoload

@Deprecated(since="10.0")
public final IRubyObject getConstantNoConstMissingSkipAutoload(String name)

Deprecated.

getConstantNoConstMissingSkipAutoload

public final IRubyObject getConstantNoConstMissingSkipAutoload(ThreadContext context,
 String name)

getConstantNoConstMissingSKipAutoload

@Deprecated
public IRubyObject getConstantNoConstMissingSKipAutoload(String name)

Deprecated.

getConstantFrom

@Deprecated(since="10.0")
public IRubyObject getConstantFrom(String name)

Deprecated.

getConstantFrom

public IRubyObject getConstantFrom(ThreadContext context,
 String name)

getConstantWithAutoload

@Deprecated(since="10.0")
public IRubyObject getConstantWithAutoload(String name,
 IRubyObject failedAutoloadValue,
 boolean includePrivate)

Deprecated.

getConstantWithAutoload

public IRubyObject getConstantWithAutoload(ThreadContext context,
 String name,
 IRubyObject failedAutoloadValue,
 boolean includePrivate)

Search just this class for a constant value, or trigger autoloading.

Parameters:

name -

Returns:

fastGetConstantFrom

@Deprecated
public IRubyObject fastGetConstantFrom(String internedName)

Deprecated.

getConstantFromNoConstMissing

@Deprecated(since="10.0")
public IRubyObject getConstantFromNoConstMissing(String name)

Deprecated.

getConstantFromNoConstMissing

public IRubyObject getConstantFromNoConstMissing(ThreadContext context,
 String name)

getConstantFromNoConstMissing

@Deprecated(since="10.0")
public IRubyObject getConstantFromNoConstMissing(String name,
 boolean includePrivate)

Deprecated.

getConstantFromNoConstMissing

public IRubyObject getConstantFromNoConstMissing(ThreadContext context,
 String name,
 boolean includePrivate)

fastGetConstantFromNoConstMissing

@Deprecated
public IRubyObject fastGetConstantFromNoConstMissing(String internedName)

Deprecated.

getConstantFromConstMissing

@Deprecated(since="10.0")
public IRubyObject getConstantFromConstMissing(String name)

Deprecated.

getConstantFromConstMissing

public IRubyObject getConstantFromConstMissing(ThreadContext context,
 String name)

fastGetConstantFromConstMissing

@Deprecated
public IRubyObject fastGetConstantFromConstMissing(String internedName)

Deprecated.

resolveUndefConstant

@Deprecated(since="10.0")
public final IRubyObject resolveUndefConstant(String name)

Deprecated.

setConstantQuiet

@Deprecated(since="10.0")
public IRubyObject setConstantQuiet(String name,
 IRubyObject value)

Deprecated.

setConstantQuiet

public IRubyObject setConstantQuiet(ThreadContext context,
 String name,
 IRubyObject value)

Set the named constant on this module. Also, if the value provided is another Module and that module has not yet been named, assign it the specified name. This version does not warn if the constant has already been set.

Parameters:

name - The name to assign

value - The value to assign to it; if an unnamed Module, also set its basename to name

Returns:

The result of setting the variable.

setConstant

@Deprecated(since="10.0")
public IRubyObject setConstant(String name,
 IRubyObject value)

Deprecated.

setConstant

public IRubyObject setConstant(ThreadContext context,
 String name,
 IRubyObject value)

Set the named constant on this module. Also, if the value provided is another Module and that module has not yet been named, assign it the specified name.

Parameters:

name - The name to assign

value - The value to assign to it; if an unnamed Module, also set its basename to name

Returns:

The result of setting the variable.

setConstant

@Deprecated(since="10.0")
public IRubyObject setConstant(String name,
 IRubyObject value,
 String file,
 int line)

Deprecated.

setConstant

public IRubyObject setConstant(ThreadContext context,
 String name,
 IRubyObject value,
 String file,
 int line)

setConstant

@Deprecated(since="10.0")
public IRubyObject setConstant(String name,
 IRubyObject value,
 boolean hidden)

Deprecated.

setConstant

public IRubyObject setConstant(ThreadContext context,
 String name,
 IRubyObject value,
 boolean hidden)

fastSetConstant

@Deprecated(since="9.4-")
public IRubyObject fastSetConstant(String internedName,
 IRubyObject value)

Deprecated.

defineAlias

public <T extends RubyModule> T defineAlias(ThreadContext context,
 String name,
 String oldName)

Define an alias on this module/class.

Parameters:

context - the current thread context

name - the new alias name

oldName - the existing method name

Returns:

itself for composable API

defineConstant

public <T extends RubyModule> T defineConstant(ThreadContext context,
 String name,
 IRubyObject value)

Define a constant when you are defining your Ruby class/module.

Parameters:

context - the current thread context

name - the name of the constant

value - the value for the constant

Returns:

itself for a composable API

defineConstant

public <T extends RubyModule> T defineConstant(ThreadContext context,
 String name,
 IRubyObject value,
 boolean hidden)

Define a constant when you are defining your Ruby class/module.

Parameters:

context - the current thread context

name - the name of the constant

value - the value for the constant

hidden - should this be a hidden constant

Returns:

itself for a composable API

defineConstant

@Deprecated(since="10.0")
public void defineConstant(String name,
 IRubyObject value)

Deprecated.

rb_define_const

isConstantDefined

@Deprecated(since="10.0")
public boolean isConstantDefined(String name,
 boolean inherit)

Deprecated.

constDefined

@Deprecated(since="10.0")
public boolean constDefined(String name)

Deprecated.

constDefined

public boolean constDefined(ThreadContext context,
 String name)

constDefinedAt

@Deprecated(since="10.0")
public boolean constDefinedAt(String name)

Deprecated.

constDefinedAt

public boolean constDefinedAt(ThreadContext context,
 String name)

constDefinedFrom

@Deprecated(since="10.0")
public boolean constDefinedFrom(String name)

Deprecated.

constDefinedFrom

public boolean constDefinedFrom(ThreadContext context,
 String name)

publicConstDefinedFrom

@Deprecated(since="10.0")
public boolean publicConstDefinedFrom(String name)

Deprecated.

publicConstDefinedFrom

public boolean publicConstDefinedFrom(ThreadContext context,
 String name)

autoloadingValue

@Deprecated(since="10.0")
public boolean autoloadingValue(Ruby runtime,
 String name)

Deprecated.

autoloadingValue

public boolean autoloadingValue(ThreadContext context,
 String name)

isConstantDefined

@Deprecated(since="10.0")
public boolean isConstantDefined(String name)

Deprecated.

isConstantDefined

public boolean isConstantDefined(ThreadContext context,
 String name)

testModuleMatch

public static boolean testModuleMatch(ThreadContext context,
 IRubyObject arg0,
 int id)

hasInternalModuleVariable

public boolean hasInternalModuleVariable(String name)

Behaves similarly to getClassVar(ThreadContext, String). Searches this class/module and its ancestors for the specified internal variable.

Parameters:

name - the internal variable name

Returns:

the value of the specified internal variable if found, else null

See Also:

• setInternalModuleVariable(String, IRubyObject)

searchInternalModuleVariable

public IRubyObject searchInternalModuleVariable(String name)

Behaves similarly to getClassVar(ThreadContext, String). Searches this class/module and its ancestors for the specified internal variable.

Parameters:

name - the internal variable name

Returns:

the value of the specified internal variable if found, else null

See Also:

• setInternalModuleVariable(String, IRubyObject)

setInternalModuleVariable

public void setInternalModuleVariable(String name,
 IRubyObject value)

Behaves similarly to setClassVar(ThreadContext, String, IRubyObject). If the specified internal variable is found in this class/module or an ancestor, it is set where found. Otherwise it is set in this module.

Parameters:

name - the internal variable name

value - the internal variable value

See Also:

• searchInternalModuleVariable(String)

getClassVariables

protected Map<String,IRubyObject> getClassVariables()

getClassVariablesForRead

protected Map<String,IRubyObject> getClassVariablesForRead()

hasClassVariable

public boolean hasClassVariable(String name)

fastHasClassVariable

@Deprecated
public boolean fastHasClassVariable(String internedName)

Deprecated.

fetchClassVariable

public IRubyObject fetchClassVariable(String name)

fastFetchClassVariable

@Deprecated
public IRubyObject fastFetchClassVariable(String internedName)

Deprecated.

storeClassVariable

@Deprecated(since="10.0")
public IRubyObject storeClassVariable(String name,
 IRubyObject value)

Deprecated.

storeClassVariable

public IRubyObject storeClassVariable(ThreadContext context,
 String name,
 IRubyObject value)

fastStoreClassVariable

@Deprecated
public IRubyObject fastStoreClassVariable(String internedName,
 IRubyObject value)

Deprecated.

deleteClassVariable

@Deprecated(since="10.0")
public IRubyObject deleteClassVariable(String name)

Deprecated.

getClassVariableNameList

public List<String> getClassVariableNameList()

validateClassVariable

@Deprecated(since="10.0")
protected final String validateClassVariable(String name)

Deprecated.

validateClassVariable

@Deprecated(since="10.0")
protected final String validateClassVariable(IRubyObject nameObj,
 String name)

Deprecated.

validateClassVariable

@Deprecated(since="10.0")
protected String validateClassVariable(Ruby runtime,
 IRubyObject object)

Deprecated.

validateClassVariable

protected String validateClassVariable(ThreadContext context,
 IRubyObject object)

ensureClassVariablesSettable

@Deprecated(since="10.0")
protected final void ensureClassVariablesSettable()

Deprecated.

hasConstant

public boolean hasConstant(String name)

fastHasConstant

@Deprecated
public boolean fastHasConstant(String internedName)

Deprecated.

fetchConstant

@Deprecated(since="10.0")
public IRubyObject fetchConstant(String name)

Deprecated.

fetchConstant

public IRubyObject fetchConstant(ThreadContext context,
 String name)

fetchConstant

@Deprecated(since="10.0")
public IRubyObject fetchConstant(String name,
 boolean includePrivate)

Deprecated.

fetchConstant

public IRubyObject fetchConstant(ThreadContext context,
 String name,
 boolean includePrivate)

fetchConstantEntry

@Deprecated(since="10.0")
public RubyModule.ConstantEntry fetchConstantEntry(String name,
 boolean includePrivate)

Deprecated.

fetchConstantEntry

public RubyModule.ConstantEntry fetchConstantEntry(ThreadContext context,
 String name,
 boolean includePrivate)

The equivalent for fetchConstant but is useful for extra state like whether the constant is private or not.

Parameters:

name - of the constant.

includePrivate - include private/hidden constants

Returns:

the entry for the constant.

fastFetchConstant

@Deprecated
public IRubyObject fastFetchConstant(String internedName)

Deprecated.

storeConstant

@Deprecated(since="10.0")
public IRubyObject storeConstant(String name,
 IRubyObject value)

Deprecated.

storeConstant

public IRubyObject storeConstant(ThreadContext context,
 String name,
 IRubyObject value)

storeConstant

@Deprecated(since="10.0")
public IRubyObject storeConstant(String name,
 IRubyObject value,
 boolean hidden,
 String file,
 int line)

Deprecated.

storeConstant

public IRubyObject storeConstant(ThreadContext context,
 String name,
 IRubyObject value,
 boolean hidden,
 String file,
 int line)

storeConstant

@Deprecated(since="10.0")
public IRubyObject storeConstant(String name,
 IRubyObject value,
 boolean hidden)

Deprecated.

fastStoreConstant

@Deprecated
public IRubyObject fastStoreConstant(String internedName,
 IRubyObject value)

Deprecated.

deleteConstant

@Deprecated(since="10.0")
public IRubyObject deleteConstant(String name)

Deprecated.

deleteConstant

public IRubyObject deleteConstant(ThreadContext context,
 String name)

getStoredConstantList

@Deprecated
public List<Variable<IRubyObject>> getStoredConstantList()

Deprecated.

getStoredConstantNameList

@Deprecated
public List<String> getStoredConstantNameList()

Deprecated.

getConstantNames

public Collection<String> getConstantNames()

Returns:

a list of constant names that exists at time this was called

getConstantNames

public Collection<String> getConstantNames(boolean includePrivate)

validateConstant

@Deprecated(since="10.0")
protected final String validateConstant(IRubyObject name)

Deprecated.

validateConstant

protected final String validateConstant(ThreadContext context,
 IRubyObject name)

Validates name is a valid constant name and returns its id string.

Parameters:

name - object to verify as a valid constant.

Returns:

the id for this valid constant name.

validateConstant

@Deprecated(since="10.0")
protected final String validateConstant(String name,
 IRubyObject errorName)

Deprecated.

ensureConstantsSettable

@Deprecated(since="10.0")
protected final void ensureConstantsSettable()

Deprecated.

checkFrozen

public final void checkFrozen()

Description copied from class: RubyBasicObject

The actual method that checks frozen with the default frozen message from MRI. If possible, call this instead of RubyBasicObject.testFrozen(java.lang.String).

Overrides:

checkFrozen in class RubyBasicObject

constantTableContains

protected boolean constantTableContains(String name)

constantTableFetch

protected IRubyObject constantTableFetch(String name)

constantEntryFetch

protected RubyModule.ConstantEntry constantEntryFetch(String name)

constantTableStore

protected IRubyObject constantTableStore(String name,
 IRubyObject value)

constantTableStore

protected IRubyObject constantTableStore(String name,
 IRubyObject value,
 boolean hidden)

defineConstantBootstrap

public void defineConstantBootstrap(String name,
 IRubyObject value)

This is an internal API which is only used during runtime creation but BEFORE the first ThreadContext is created. Nothing other that a few constants in the Ruby constructor should be calling this. This method has no error checks. A secondary goal of this method is that it does not access Ruby or ThreadContext in any way.

Parameters:

name - of the constant

value - of the constant

constantTableStore

protected IRubyObject constantTableStore(String name,
 IRubyObject value,
 boolean hidden,
 boolean deprecated,
 String file,
 int line)

constantTableStore

protected IRubyObject constantTableStore(String name,
 IRubyObject value,
 boolean hidden,
 boolean deprecated)

constantTableRemove

protected IRubyObject constantTableRemove(String name)

defineAutoload

@Deprecated(since="10.0")
protected final void defineAutoload(String symbol,
 RubyString path)

Deprecated.

defineAutoload

protected final void defineAutoload(ThreadContext context,
 String symbol,
 RubyString path)

Define an autoload. ConstantMap holds UNDEF for the name as an autoload marker.

finishAutoload

@Deprecated(since="10.0")
protected final IRubyObject finishAutoload(String name)

Deprecated.

finishAutoload

protected final IRubyObject finishAutoload(ThreadContext context,
 String name)

Extract an Object which is defined by autoload thread from autoloadMap and define it as a constant.

getAutoloadConstant

@Deprecated(since="10.0")
public final IRubyObject getAutoloadConstant(String name)

Deprecated.

getAutoloadConstant

public final IRubyObject getAutoloadConstant(ThreadContext context,
 String name)

Get autoload constant. If it's first resolution for the constant, it tries to require the defined feature and returns the defined value. Multi-threaded accesses are blocked and processed sequentially except if the caller is the autoloading thread.

getAutoloadConstant

@Deprecated(since="10.0")
protected IRubyObject getAutoloadConstant(String name,
 boolean loadConstant)

Deprecated.

getAutoloadConstant

protected IRubyObject getAutoloadConstant(ThreadContext context,
 String name,
 boolean loadConstant)

getAutoloadFile

protected RubyString getAutoloadFile(String name)

initialize

@Deprecated
public IRubyObject initialize(Block block)

Deprecated.

setJavaProxy

public void setJavaProxy(boolean javaProxy)

Set whether this class is associated with (i.e. a proxy for) a normal Java class or interface.

getJavaProxy

public boolean getJavaProxy()

Get whether this class is associated with (i.e. a proxy for) a normal Java class or interface.

getCacheProxy

public boolean getCacheProxy()

Get whether this Java proxy class should try to keep its instances idempotent and alive using the ObjectProxyCache.

setCacheProxy

public void setCacheProxy(boolean cacheProxy)

Set whether this Java proxy class should try to keep its instances idempotent and alive using the ObjectProxyCache.

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 RubyBasicObject

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

discoverInstanceVariables

public Set<String> discoverInstanceVariables()

isRefinement

public boolean isRefinement()

usingTemporaryName

public boolean usingTemporaryName()

isIncludedIntoRefinement

public boolean isIncludedIntoRefinement()

isMethodBuiltin

public boolean isMethodBuiltin(String methodName)

Return true if the given method is defined on this class and is a builtin, i.e. a method built-in to JRuby and loaded during its core boot process.

Parameters:

methodName -

Returns:

getRefinements

public Map<RubyModule,RubyModule> getRefinements()

getRefinementsForWrite

public Map<RubyModule,RubyModule> getRefinementsForWrite()

setRefinements

public void setRefinements(Map<RubyModule,RubyModule> refinements)

finishRefinementClass

public static void finishRefinementClass(ThreadContext context,
 RubyClass Refinement)

fastIsConstantDefined

@Deprecated
public boolean fastIsConstantDefined(String internedName)

Deprecated.

defineAliases

@Deprecated
public void defineAliases(List<String> aliases,
 String oldId)

Deprecated.

const_get

@Deprecated
public IRubyObject const_get(IRubyObject symbol)

Deprecated.

const_get

@Deprecated
public IRubyObject const_get(ThreadContext context,
 IRubyObject... args)

Deprecated.

const_get_1_9

@Deprecated
public IRubyObject const_get_1_9(ThreadContext context,
 IRubyObject[] args)

Deprecated.

const_get_2_0

@Deprecated
public IRubyObject const_get_2_0(ThreadContext context,
 IRubyObject[] args)

Deprecated.