RubyModule (JRuby Core 9.0.5.0 API)

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:

RubyClass
```
public class RubyModule
extends RubyObject
```
Author:

jpetersen

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RubyModule.AutoloadMethod`
`protected static class`	`RubyModule.CacheEntryFactory`
`static class`	`RubyModule.ConstantEntry` Represents a constant value, possibly hidden (private).
`static class`	`RubyModule.JavaClassKindOf`
`static class`	`RubyModule.KindOf`
`static class`	`RubyModule.MethodClumper`
`static class`	`RubyModule.ModuleKernelMethods`
`protected static class`	`RubyModule.ProfilingCacheEntryFactory`
`static class`	`RubyModule.RespondToMissingMethod`
`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 and Description
`protected String`	`baseName` The base name of this class/module, excluding nesting.
`protected Map<String,CacheEntry>`	`cachedMethods`
`protected ClassIndex`	`classIndex`
`protected static String`	`ERR_INSECURE_SET_CONSTANT`
`protected int`	`generation`
`protected Integer`	`generationObject`
`int`	`id`
`protected Set<RubyClass>`	`includingHierarchies`
`int`	`index` Deprecated. use RubyModule#getClassIndex()
`RubyModule.KindOf`	`kindOf`
`protected Invalidator`	`methodInvalidator`
`protected RubyModule`	`methodLocation`
`protected Map<String,DynamicMethod>`	`methods`
`static ObjectAllocator`	`MODULE_ALLOCATOR`
`protected static RubyModule.CacheEntryFactory`	`NormalCacheEntryFactory`
`RubyModule`	`parent` The class/module within whose namespace this class/module resides.
`static Set<String>`	`SCOPE_CAPTURING_METHODS` Deprecated.
`protected RubyClass`	`superClass`

Fields inherited from class org.jruby.RubyObject
FIELD_ALLOCATED_CLASSES, FIELD_ALLOCATORS, IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, OBJECT_VAR0_ALLOCATOR, OBJECT_VAR1_ALLOCATOR, OBJECT_VAR2_ALLOCATOR, OBJECT_VAR3_ALLOCATOR, OBJECT_VAR4_ALLOCATOR, OBJECT_VAR5_ALLOCATOR, OBJECT_VAR6_ALLOCATOR, OBJECT_VAR7_ALLOCATOR, OBJECT_VAR8_ALLOCATOR, OBJECT_VAR9_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, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUST_F, 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 and Description
`protected`	`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

Methods
Modifier and Type	Method and Description
`void`	`addClassProvider(ClassProvider provider)`
`void`	`addIncludingHierarchy(IncludedModule hierarchy)`
`void`	`addMethod(String name, DynamicMethod method)`
`void`	`addMethodAtBootTimeOnly(String name, DynamicMethod method)` This method is not intended for use by normal users; it is a fast-path method that skips synchronization and hierarchy invalidation to speed boot-time method definition.
`void`	`addMethodInternal(String name, DynamicMethod method)`
`void`	`addModuleFunction(String name, DynamicMethod method)`
`void`	`addReadAttribute(ThreadContext context, String name)`
`void`	`addReadWriteAttribute(ThreadContext context, String name)`
`void`	`addWriteAttribute(ThreadContext context, String name)`
`RubyModule`	`alias_method(ThreadContext context, IRubyObject newId, IRubyObject oldId)`
`RubyArray`	`ancestors()` Deprecated.
`RubyArray`	`ancestors(ThreadContext context)` rb_mod_ancestors
`RubyModule`	`append_features(IRubyObject include)` rb_mod_append_features
`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`	`attr(ThreadContext context, IRubyObject[] args)` rb_mod_attr
`IRubyObject`	`attr19(ThreadContext context, IRubyObject[] args)`
`void`	`becomeSynchronized()`
`protected void`	`checkForCyclicPrepend(RubyModule m)`
`void`	`checkValidBindTargetFrom(ThreadContext context, RubyModule originModule)`
`IRubyObject`	`class_variable_defined_p(ThreadContext context, IRubyObject var)`
`IRubyObject`	`class_variable_get(IRubyObject var)` rb_mod_cvar_get
`IRubyObject`	`class_variable_get19(IRubyObject var)`
`IRubyObject`	`class_variable_set(IRubyObject var, IRubyObject value)` rb_mod_cvar_set
`IRubyObject`	`class_variable_set19(IRubyObject var, IRubyObject value)`
`RubyArray`	`class_variables(ThreadContext context)`
`RubyArray`	`class_variables(ThreadContext context, IRubyObject inherit)`
`RubyArray`	`class_variables19(ThreadContext context)` Deprecated.
`protected IRubyObject`	`cloneMethods(RubyModule clone)`
`RubyBoolean`	`const_defined_p(ThreadContext context, IRubyObject symbol)` rb_mod_const_defined
`RubyBoolean`	`const_defined_p19(ThreadContext context, IRubyObject[] args)`
`IRubyObject`	`const_get_1_9(ThreadContext context, IRubyObject[] args)`
`IRubyObject`	`const_get_2_0(ThreadContext context, IRubyObject[] args)`
`IRubyObject`	`const_get(IRubyObject symbol)` rb_mod_const_get
`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 symbol, IRubyObject value)` rb_mod_const_set
`protected RubyModule.ConstantEntry`	`constantEntryFetch(String name)`
`RubyArray`	`constants(ThreadContext context)`
`RubyArray`	`constants19(ThreadContext context)`
`RubyArray`	`constants19(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)`
`RubyArray`	`constantsCommon19(ThreadContext context, boolean replaceModule, boolean allConstants)`
`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)`
`static RubyClass`	`createModuleClass(Ruby runtime, RubyClass moduleClass)`
`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)` rb_alias
`void`	`defineAliases(List<String> aliases, String oldName)`
`boolean`	`defineAnnotatedConstant(Field field)`
`void`	`defineAnnotatedConstants(Class clazz)`
`void`	`defineAnnotatedMethod(Class clazz, String name)`
`boolean`	`defineAnnotatedMethod(Method method, MethodFactory methodFactory)`
`boolean`	`defineAnnotatedMethod(String name, JavaMethodDescriptor desc, MethodFactory methodFactory)`
`boolean`	`defineAnnotatedMethod(String name, List<JavaMethodDescriptor> methods, MethodFactory methodFactory)`
`void`	`defineAnnotatedMethods(Class clazz)`
`void`	`defineAnnotatedMethodsIndividually(Class clazz)`
`protected void`	`defineAutoload(String name, RubyModule.AutoloadMethod loadMethod)` Define an autoload.
`RubyClass`	`defineClassUnder(String name, RubyClass superClass, ObjectAllocator allocator)` rb_define_class_under this method should be used only as an API to define/open nested classes
`void`	`defineConstant(String name, IRubyObject value)` rb_define_const
`RubyModule`	`defineModuleUnder(String name)` rb_define_module_under this method should be used only as an API to define/open nested module
`RubyClass`	`defineOrGetClassUnder(String name, RubyClass superClazz)` this method should be used only by interpreter or compiler
`RubyModule`	`defineOrGetModuleUnder(String name)` this method should be used only by interpreter or compiler
`IRubyObject`	`deleteClassVariable(String name)`
`IRubyObject`	`deleteConstant(String name)`
`Set<String>`	`discoverInstanceVariables()`
`protected void`	`ensureClassVariablesSettable()`
`protected void`	`ensureConstantsSettable()`
`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)` rb_export_method
`IRubyObject`	`extend_object(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)`
`boolean`	`fastIsConstantDefined19(String internedName)`
`boolean`	`fastIsConstantDefined19(String internedName, boolean inherit)`
`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)`
`IRubyObject`	`fetchConstant(String name, boolean includePrivate)`
`RubyModule`	`findImplementer(RubyModule clazz)` Find the given class in this hierarchy, considering modules along the way.
`protected IRubyObject`	`finishAutoload(String name)` Extract an Object which is defined by autoload thread from autoloadMap and define it as a constant.
`IRubyObject`	`freeze(ThreadContext context)` rb_mod_freeze
`List<IRubyObject>`	`getAncestorList()`
`IRubyObject`	`getAutoloadConstant(String name)` Get autoload constant.
`protected IRubyObject`	`getAutoloadConstant(String name, boolean loadConstant)`
`protected RubyString`	`getAutoloadFile(String name)`
`String`	`getBaseName()` Get the base name of this class, or null if it is an anonymous class.
`boolean`	`getCacheProxy()` Get whether this Java proxy class should try to keep its instances idempotent and alive using the ObjectProxyCache.
`int`	`getCacheToken()` Deprecated.
`RubyClass`	`getClass(String name)` Finds a class that is within the current module (or class).
`ClassIndex`	`getClassIndex()` Get the ClassIndex for this class.
`IRubyObject`	`getClassVar(String name)` Retrieve the specified class variable, searching through this module, included modules, and supermodules.
`List<String>`	`getClassVariableNameList()`
`protected Map<String,IRubyObject>`	`getClassVariables()`
`protected Map<String,IRubyObject>`	`getClassVariablesForRead()`
`IRubyObject`	`getConstant(String name)` Retrieve the named constant, invoking 'const_missing' should that be appropriate.
`IRubyObject`	`getConstant(String name, boolean inherit)`
`IRubyObject`	`getConstant(String name, boolean inherit, boolean includeObject)`
`IRubyObject`	`getConstantAt(String name)`
`IRubyObject`	`getConstantAt(String name, boolean includePrivate)`
`IRubyObject`	`getConstantAtSpecial(String name)` This version searches superclasses if we're starting with Object.
`IRubyObject`	`getConstantFrom(String name)`
`IRubyObject`	`getConstantFromConstMissing(String name)`
`IRubyObject`	`getConstantFromNoConstMissing(String name)`
`IRubyObject`	`getConstantFromNoConstMissing(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)`
`IRubyObject`	`getConstantNoConstMissing(String name, boolean inherit)`
`IRubyObject`	`getConstantNoConstMissing(String name, boolean inherit, boolean includeObject)`
`RubyModule`	`getDelegate()`
`int`	`getGeneration()`
`Integer`	`getGenerationObject()`
`Invalidator`	`getInvalidator()`
`boolean`	`getJavaProxy()` Get whether this class is associated with (i.e.
`RubyModule`	`getMethodLocation()`
`Map<String,DynamicMethod>`	`getMethods()`
`Map<String,DynamicMethod>`	`getMethodsForWrite()`
`String`	`getName()` 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()`
`RubyModule`	`getNonPrependedClass()`
`RubyModule`	`getParent()`
`Map<RubyClass,RubyModule>`	`getRefinements()`
`String`	`getSimpleName()` 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`	`hasClassVariable(String name)`
`boolean`	`hasConstant(String name)`
`RubyFixnum`	`hash()` rb_obj_id 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(String)`.
`boolean`	`hasModuleInHierarchy(RubyModule type)`
`boolean`	`hasModuleInPrepends(RubyModule type)`
`boolean`	`hasPrepends()`
`IRubyObject`	`include_p(ThreadContext context, IRubyObject arg)`
`RubyModule`	`include(IRubyObject[] modules)` rb_mod_include
`RubyArray`	`included_modules(ThreadContext context)` rb_mod_included_modules
`IRubyObject`	`included(ThreadContext context, IRubyObject other)`
`void`	`includeModule(IRubyObject arg)` Include a new module in this module or class.
`IRubyObject`	`initialize_copy(IRubyObject original)` mri: rb_mod_init_copy
`IRubyObject`	`initialize(Block block)` Deprecated.
`IRubyObject`	`initialize(ThreadContext context, Block block)` rb_mod_initialize
`IRubyObject`	`instance_method(IRubyObject symbol)`
`RubyArray`	`instance_methods(IRubyObject[] args)`
`RubyArray`	`instance_methods19(IRubyObject[] args)`
`RubyArray`	`instanceMethods(IRubyObject[] args, Visibility visibility, boolean obj, boolean not)`
`RubyArray`	`instanceMethods(Visibility visibility, boolean includeSuper, boolean obj, boolean not)`
`void`	`invalidateCacheDescendants()`
`protected void`	`invalidateCacheDescendantsInner()` Deprecated.
`protected void`	`invalidateConstantCache(String constantName)`
`protected void`	`invalidateCoreClasses()`
`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)` rb_const_defined_at
`boolean`	`isIncluded()` Is this module one that in an included one (e.g.
`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)`
`boolean`	`isMethodBuiltin(String methodName)` Return true if the given method is defined on this class and is a builtin (defined in Java at boot).
`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)`
`boolean`	`isSingleton()`
`boolean`	`isSynchronized()`
`static void`	`marshalTo(RubyModule module, MarshalStream output)`
`IRubyObject`	`method_added(ThreadContext context, IRubyObject nothing)`
`RubyBoolean`	`method_defined_p(ThreadContext context, IRubyObject symbol)`
`IRubyObject`	`method_removed(ThreadContext context, IRubyObject nothing)`
`IRubyObject`	`method_undefined(ThreadContext context, IRubyObject nothing)`
`IRubyObject`	`mix(ThreadContext context, IRubyObject mod)`
`IRubyObject`	`mix(ThreadContext context, IRubyObject mod, IRubyObject hash0)`
`IRubyObject`	`module_eval(ThreadContext context, Block block)`
`IRubyObject`	`module_eval(ThreadContext context, IRubyObject[] args, Block block)` Deprecated.
`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)`
`RubyModule`	`module_function(ThreadContext context, IRubyObject[] args)` rb_mod_modfunc
`IRubyObject`	`name()`
`IRubyObject`	`name19()`
`boolean`	`needsImplementer()`
`static RubyArray`	`nesting(ThreadContext context, IRubyObject recv, Block block)` Return an array of nested modules or classes.
`IncludedModuleWrapper`	`newIncludeClass(RubyClass superClazz)` Deprecated.
`IRubyObject`	`newMethod(IRubyObject receiver, String methodName, boolean bound, Visibility visibility)`
`IRubyObject`	`newMethod(IRubyObject receiver, String methodName, boolean bound, Visibility visibility, boolean respondToMissing)`
`IRubyObject`	`newMethod(IRubyObject receiver, String methodName, boolean bound, Visibility visibility, boolean respondToMissing, boolean priv)`
`static RubyModule`	`newModule(Ruby runtime)` rb_module_new
`static RubyModule`	`newModule(Ruby runtime, String name, RubyModule parent, boolean setParent)` rb_module_new/rb_define_module_id/rb_name_class/rb_set_class_path
`IRubyObject`	`op_cmp(IRubyObject obj)` rb_mod_cmp
`RubyBoolean`	`op_eqq(ThreadContext context, IRubyObject obj)` rb_mod_eqq
`IRubyObject`	`op_equal(ThreadContext context, IRubyObject other)`
`IRubyObject`	`op_ge(IRubyObject obj)` rb_mod_ge
`IRubyObject`	`op_gt(IRubyObject obj)` rb_mod_gt
`IRubyObject`	`op_le(IRubyObject obj)` rb_mod_le
`IRubyObject`	`op_lt(IRubyObject obj)` rb_mod_lt
`void`	`populateInstanceMethodNames(Set<String> seen, RubyArray ary, Visibility visibility, boolean obj, boolean not, boolean recur)`
`RubyModule`	`prepend_features(IRubyObject include)` rb_mod_prepend_features
`IRubyObject`	`prepend(ThreadContext context, IRubyObject[] modules)`
`IRubyObject`	`prepended(ThreadContext context, IRubyObject other)`
`void`	`prependModule(IRubyObject arg)` Prepend a new module to this module or class.
`RubyModule`	`private_class_method(IRubyObject[] args)`
`IRubyObject`	`private_constant(ThreadContext context, IRubyObject rubyName)`
`IRubyObject`	`private_constant(ThreadContext context, IRubyObject[] rubyNames)`
`RubyArray`	`private_instance_methods(IRubyObject[] args)` rb_class_private_instance_methods
`RubyArray`	`private_instance_methods19(IRubyObject[] args)`
`IRubyObject`	`private_method_defined(ThreadContext context, IRubyObject symbol)`
`RubyArray`	`protected_instance_methods(IRubyObject[] args)` rb_class_protected_instance_methods
`RubyArray`	`protected_instance_methods19(IRubyObject[] args)`
`IRubyObject`	`protected_method_defined(ThreadContext context, IRubyObject symbol)`
`RubyModule`	`public_class_method(IRubyObject[] args)`
`IRubyObject`	`public_constant(ThreadContext context, IRubyObject rubyName)`
`IRubyObject`	`public_constant(ThreadContext context, IRubyObject[] rubyNames)`
`IRubyObject`	`public_instance_method(IRubyObject symbol)`
`RubyArray`	`public_instance_methods(IRubyObject[] args)`
`RubyArray`	`public_instance_methods19(IRubyObject[] args)`
`IRubyObject`	`public_method_defined(ThreadContext context, IRubyObject symbol)`
`RubyModule`	`rbPrivate(ThreadContext context, IRubyObject[] args)` rb_mod_private
`RubyModule`	`rbProtected(ThreadContext context, IRubyObject[] args)` rb_mod_protected
`RubyModule`	`rbPublic(ThreadContext context, IRubyObject[] args)` rb_mod_public
`IRubyObject`	`refine(ThreadContext context, IRubyObject classArg, Block block)`
`IRubyObject`	`remove_class_variable(ThreadContext context, IRubyObject name)` rb_mod_remove_cvar
`IRubyObject`	`remove_class_variable19(ThreadContext context, IRubyObject name)`
`IRubyObject`	`remove_const(ThreadContext context, IRubyObject rubyName)`
`RubyModule`	`remove_method(ThreadContext context, IRubyObject[] args)`
`void`	`removeClassProvider(ClassProvider provider)`
`IRubyObject`	`removeClassVariable(String name)`
`IRubyObject`	`removeCvar(IRubyObject name)` Deprecated. - use `removeClassVariable(String)`
`void`	`removeMethod(ThreadContext context, String name)`
`IRubyObject`	`resolveUndefConstant(String name)`
`DynamicMethod`	`retrieveMethod(String name)` Search through this module and supermodules for method definitions.
`IRubyObject`	`searchInternalModuleVariable(String name)` Behaves similarly to `getClassVar(String)`.
`DynamicMethod`	`searchMethod(String name)` Search through this module and supermodules for method definitions.
`protected DynamicMethod`	`searchMethodCommon(String name)`
`DynamicMethod`	`searchMethodInner(String name)`
`CacheEntry`	`searchWithCache(String name)`
`CacheEntry`	`searchWithCache(String name, boolean cacheUndef)` Search through this module and supermodules for method definitions.
`void`	`setBaseName(String name)` Set the base name of the class.
`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)` Set the named class variable to the given value, provided taint and freeze allow setting it.
`IRubyObject`	`setConstant(String name, IRubyObject value)` Set the named constant on this module.
`IRubyObject`	`setConstant(String name, IRubyObject value, boolean hidden)`
`IRubyObject`	`setConstantQuiet(String name, IRubyObject value)` Set the named constant on this module.
`void`	`setInternalModuleVariable(String name, IRubyObject value)` Behaves similarly to `setClassVar(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)` set_method_visibility
`void`	`setParent(RubyModule parent)`
`void`	`setRefinements(Map<RubyClass,RubyModule> refinements)`
`void`	`setSuperClass(RubyClass superClass)`
`IRubyObject`	`singleton_class_p(ThreadContext context)`
`IRubyObject`	`storeClassVariable(String name, IRubyObject value)`
`IRubyObject`	`storeConstant(String name, IRubyObject value)`
`IRubyObject`	`storeConstant(String name, IRubyObject value, boolean hidden)`
`void`	`syncClassVariables(RubyModule other)`
`void`	`syncConstants(RubyModule other)`
`IRubyObject`	`to_s()` rb_mod_to_s
`Object`	`toJava(Class target)` Convert the object to the specified Java class, if possible.
`RubyModule`	`undef_method(ThreadContext context, IRubyObject[] args)`
`void`	`undef(ThreadContext context, String name)` rb_undef
`void`	`undefineMethod(String name)`
`static RubyModule`	`unmarshalFrom(UnmarshalStream input)`
`void`	`updateGeneration()`
`IRubyObject`	`using(ThreadContext context, IRubyObject refinedModule)`
`static void`	`usingModule(ThreadContext context, RubyModule cref, IRubyObject refinedModule)`
`protected String`	`validateClassVariable(String name)`
`protected String`	`validateConstant(IRubyObject name)`
`protected String`	`validateConstant(String name, IRubyObject errorName)`

Methods inherited from class org.jruby.RubyObject
attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, eqlInternal, equalInternal, initialize, initialize, inspect, puts, specificEval, toString

Methods inherited from class org.jruby.RubyBasicObject
addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, display, dup, ensureInstanceVariablesSettable, eql_p, eql, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize19, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isFalse, isFrozen, isImmediate, isNil, isSpecialConst, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing19, method, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal_19, op_match, op_match19, op_not_equal, op_not_match, op_not, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method_added19, singleton_method_removed19, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, trust, type_deprecated, type, untaint, untrust, untrusted_p, 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

Field Detail

ERR_INSECURE_SET_CONSTANT

protected static final String ERR_INSECURE_SET_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 Set<RubyClass> includingHierarchies

methodLocation

protected volatile RubyModule methodLocation

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 Detail

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
```
protected RubyModule(Ruby runtime)
```
standard path for Module construction

Method Detail

createModuleClass

public static RubyClass createModuleClass(Ruby runtime,
                          RubyClass moduleClass)

checkValidBindTargetFrom

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

Throws:: RaiseException

getClassIndex
```
public ClassIndex getClassIndex()
```
Get the ClassIndex for this class. Will be NO_CLASS for non-core types.

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

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). If is_a? semantics is required, use (someObject instanceof RubyModule) instead.

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). If is_a? semantics is required, use (someObject instanceof RubyClass/MetaClass) instead.

isSingleton
```
public boolean isSingleton()
```

isInstance

public boolean isInstance(IRubyObject object)

getConstantMap

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

getConstantMapForWrite

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

addIncludingHierarchy

public void addIncludingHierarchy(IncludedModule hierarchy)

needsImplementer
```
public boolean needsImplementer()
```

newModule

public static RubyModule newModule(Ruby runtime)

rb_module_new

newModule

public static RubyModule newModule(Ruby runtime,
                   String name,
                   RubyModule parent,
                   boolean setParent)

rb_module_new/rb_define_module_id/rb_name_class/rb_set_class_path

addClassProvider

public void addClassProvider(ClassProvider provider)

removeClassProvider

public void removeClassProvider(ClassProvider provider)

checkForCyclicPrepend

protected void checkForCyclicPrepend(RubyModule m)
                              throws RaiseException

Throws:: RaiseException

getSuperClass
```
public RubyClass getSuperClass()
```
Getter for property superClass.

Returns:
Value of property superClass.

setSuperClass

public void setSuperClass(RubyClass 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()

isIncluded
```
public boolean isIncluded()
```
Is this module one that in an included one (e.g. an IncludedModuleWrapper).

See Also:
IncludedModule

isPrepended
```
public boolean isPrepended()
```

getNonIncludedClass

public RubyModule getNonIncludedClass()

getDelegate
```
public RubyModule getDelegate()
```

getNonPrependedClass

public RubyModule getNonPrependedClass()

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
```
public void setBaseName(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

getName
```
public String getName()
```
Generate a fully-qualified class name or a #-style name for anonymous and singleton classes. Ruby C equivalent = "classname"

Returns:
The generated class name

getSimpleName
```
public String getSimpleName()
```
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

refine

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

using

public IRubyObject using(ThreadContext context,
                IRubyObject refinedModule)

usingModule

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

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

getClass
```
public RubyClass getClass(String name)
```
Finds a class that is within the current module (or class).

Parameters:
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
```
public void prependModule(IRubyObject arg)
```
Prepend a new module to this module or class.

Parameters:
arg - The module to include

includeModule
```
public void includeModule(IRubyObject arg)
```
Include a new module in this module or class.

Parameters:
arg - The module to include

defineAnnotatedMethod

public void defineAnnotatedMethod(Class clazz,
                         String name)

defineAnnotatedConstants

public void defineAnnotatedConstants(Class clazz)

defineAnnotatedConstant

public boolean defineAnnotatedConstant(Field field)

defineAnnotatedMethods

public void defineAnnotatedMethods(Class clazz)

defineAnnotatedMethodsIndividually

public void defineAnnotatedMethodsIndividually(Class clazz)

defineAnnotatedMethod

public boolean defineAnnotatedMethod(String name,
                            List<JavaMethodDescriptor> methods,
                            MethodFactory methodFactory)

defineAnnotatedMethod

public boolean defineAnnotatedMethod(Method method,
                            MethodFactory methodFactory)

defineAnnotatedMethod

public boolean defineAnnotatedMethod(String name,
                            JavaMethodDescriptor desc,
                            MethodFactory methodFactory)

undefineMethod

public void undefineMethod(String name)

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

public void addMethod(String name,
             DynamicMethod method)

addMethodInternal

public void addMethodInternal(String name,
                     DynamicMethod method)

addMethodAtBootTimeOnly
```
public void addMethodAtBootTimeOnly(String name,
                           DynamicMethod method)
```
This method is not intended for use by normal users; it is a fast-path method that skips synchronization and hierarchy invalidation to speed boot-time method definition.

Parameters:
name - The name to which to bind the method
method - The method to bind

removeMethod

public void removeMethod(ThreadContext context,
                String name)

searchMethod
```
public 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)

searchWithCache
```
public CacheEntry searchWithCache(String name,
                         boolean cacheUndef)
```
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
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()

becomeSynchronized
```
public void becomeSynchronized()
```

isSynchronized
```
public boolean isSynchronized()
```

searchMethodInner

public DynamicMethod searchMethodInner(String name)

searchMethodCommon

protected DynamicMethod searchMethodCommon(String name)

invalidateCacheDescendants

public void invalidateCacheDescendants()

invalidateCoreClasses

protected void invalidateCoreClasses()

getInvalidator
```
public Invalidator getInvalidator()
```

updateGeneration
```
public void updateGeneration()
```

invalidateCacheDescendantsInner

@Deprecated
protected void invalidateCacheDescendantsInner()

Deprecated.

invalidateConstantCache

protected void invalidateConstantCache(String constantName)

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

public void addModuleFunction(String name,
                     DynamicMethod method)

defineAlias

public void defineAlias(String name,
               String oldName)

rb_alias

defineAliases

public void defineAliases(List<String> aliases,
                 String oldName)

defineOrGetClassUnder

public RubyClass defineOrGetClassUnder(String name,
                              RubyClass superClazz)

this method should be used only by interpreter or compiler

defineOrGetModuleUnder
```
public RubyModule defineOrGetModuleUnder(String name)
```
this method should be used only by interpreter or compiler

defineClassUnder

public RubyClass defineClassUnder(String name,
                         RubyClass superClass,
                         ObjectAllocator allocator)

rb_define_class_under this method should be used only as an API to define/open nested classes

defineModuleUnder
```
public RubyModule defineModuleUnder(String name)
```
rb_define_module_under this method should be used only as an API to define/open nested module

setMethodVisibility

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

set_method_visibility

exportMethod

public void exportMethod(String name,
                Visibility visibility)

rb_export_method

isMethodBound

public boolean isMethodBound(String name,
                    boolean checkVisibility)

MRI: rb_method_boundp

isMethodBound

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

newMethod

public IRubyObject newMethod(IRubyObject receiver,
                    String methodName,
                    boolean bound,
                    Visibility visibility)

newMethod

public IRubyObject newMethod(IRubyObject receiver,
                    String methodName,
                    boolean bound,
                    Visibility visibility,
                    boolean respondToMissing)

newMethod

public IRubyObject newMethod(IRubyObject receiver,
                    String methodName,
                    boolean bound,
                    Visibility visibility,
                    boolean respondToMissing,
                    boolean priv)

define_method

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

define_method

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

define_method

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

Deprecated.

name
```
public IRubyObject name()
```

name19
```
public IRubyObject name19()
```

cloneMethods

protected IRubyObject cloneMethods(RubyModule clone)

initialize_copy
```
public IRubyObject initialize_copy(IRubyObject original)
```
mri: rb_mod_init_copy

Overrides:

initialize_copy in class RubyBasicObject

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

See Also:
RubyBasicObject.hashCode()

hash
```
public RubyFixnum hash()
```
Description copied from class: RubyBasicObject

rb_obj_id 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

to_s
```
public IRubyObject to_s()
```
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)

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

public IRubyObject op_le(IRubyObject obj)

rb_mod_le

op_lt

public IRubyObject op_lt(IRubyObject obj)

rb_mod_lt

op_ge

public IRubyObject op_ge(IRubyObject obj)

rb_mod_ge

op_gt

public IRubyObject op_gt(IRubyObject obj)

rb_mod_gt

op_cmp

public IRubyObject op_cmp(IRubyObject obj)

rb_mod_cmp

isKindOfModule

public boolean isKindOfModule(RubyModule type)

isSame

protected boolean isSame(RubyModule module)

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)

attr

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

rb_mod_attr

attr19

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

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

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

instanceMethods

public RubyArray instanceMethods(Visibility visibility,
                        boolean includeSuper,
                        boolean obj,
                        boolean not)

populateInstanceMethodNames

public void populateInstanceMethodNames(Set<String> seen,
                               RubyArray ary,
                               Visibility visibility,
                               boolean obj,
                               boolean not,
                               boolean recur)

instance_methods

public RubyArray instance_methods(IRubyObject[] args)

instance_methods19

public RubyArray instance_methods19(IRubyObject[] args)

public_instance_methods

public RubyArray public_instance_methods(IRubyObject[] args)

public_instance_methods19

public RubyArray public_instance_methods19(IRubyObject[] args)

instance_method

public IRubyObject instance_method(IRubyObject symbol)

public_instance_method

public IRubyObject public_instance_method(IRubyObject symbol)

protected_instance_methods

public RubyArray protected_instance_methods(IRubyObject[] args)

rb_class_protected_instance_methods

protected_instance_methods19

public RubyArray protected_instance_methods19(IRubyObject[] args)

private_instance_methods

public RubyArray private_instance_methods(IRubyObject[] args)

rb_class_private_instance_methods

private_instance_methods19

public RubyArray private_instance_methods19(IRubyObject[] args)

prepend_features

public RubyModule prepend_features(IRubyObject include)

rb_mod_prepend_features

append_features

public RubyModule append_features(IRubyObject include)

rb_mod_append_features

extend_object

public IRubyObject extend_object(IRubyObject obj)

rb_mod_extend_object

include

public RubyModule include(IRubyObject[] modules)

rb_mod_include

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

mix

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

rbPublic

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

rb_mod_public

rbProtected

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

rb_mod_protected

rbPrivate

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

rb_mod_private

module_function

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

rb_mod_modfunc

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)

public_method_defined

public IRubyObject public_method_defined(ThreadContext context,
                                IRubyObject symbol)

protected_method_defined

public IRubyObject protected_method_defined(ThreadContext context,
                                   IRubyObject symbol)

private_method_defined

public IRubyObject private_method_defined(ThreadContext context,
                                 IRubyObject symbol)

public_class_method

public RubyModule public_class_method(IRubyObject[] args)

private_class_method

public RubyModule private_class_method(IRubyObject[] args)

alias_method

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

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

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

Deprecated.

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

public static void marshalTo(RubyModule module,
             MarshalStream output)
                      throws IOException

Throws:: IOException

unmarshalFrom

public static RubyModule unmarshalFrom(UnmarshalStream input)
                                throws IOException

Throws:: IOException

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_get

public IRubyObject class_variable_get(IRubyObject var)

rb_mod_cvar_get

class_variable_get19

public IRubyObject class_variable_get19(IRubyObject var)

class_variable_set

public IRubyObject class_variable_set(IRubyObject var,
                             IRubyObject value)

rb_mod_cvar_set

class_variable_set19

public IRubyObject class_variable_set19(IRubyObject var,
                               IRubyObject value)

remove_class_variable

public IRubyObject remove_class_variable(ThreadContext context,
                                IRubyObject name)

rb_mod_remove_cvar

remove_class_variable19

public IRubyObject remove_class_variable19(ThreadContext context,
                                  IRubyObject name)

class_variables19

@Deprecated
public RubyArray class_variables19(ThreadContext context)

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

rb_mod_const_defined

const_defined_p19

public RubyBoolean const_defined_p19(ThreadContext context,
                            IRubyObject[] args)

const_get

public IRubyObject const_get(IRubyObject symbol)

rb_mod_const_get

const_get_1_9

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

const_get_2_0

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

const_set

public IRubyObject const_set(IRubyObject symbol,
                    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)

constants19

public RubyArray constants19(ThreadContext context)

constants19

public RubyArray constants19(ThreadContext context,
                    IRubyObject allConstants)

constantsCommon19

public RubyArray constantsCommon19(ThreadContext context,
                          boolean replaceModule,
                          boolean 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)

private_constant

public IRubyObject private_constant(ThreadContext context,
                           IRubyObject rubyName)

private_constant

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

public_constant

public IRubyObject public_constant(ThreadContext context,
                          IRubyObject rubyName)

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)

setClassVar
```
public IRubyObject setClassVar(String name,
                      IRubyObject value)
```
Set the named class variable to the given value, provided taint and freeze allow 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
```
public IRubyObject getClassVar(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

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.

removeCvar
```
@Deprecated
public IRubyObject removeCvar(IRubyObject name)
```
Deprecated. - use removeClassVariable(String)

rb_mod_remove_cvar

removeClassVariable

public IRubyObject removeClassVariable(String name)

getConstantAtSpecial
```
public IRubyObject getConstantAtSpecial(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

public IRubyObject getConstantAt(String name)

getConstantAt

public IRubyObject getConstantAt(String name,
                        boolean includePrivate)

fastGetConstantAt

@Deprecated
public IRubyObject fastGetConstantAt(String internedName)

Deprecated.

getConstant
```
public IRubyObject getConstant(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

public IRubyObject getConstant(String name,
                      boolean inherit)

getConstant

public IRubyObject getConstant(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

public IRubyObject getConstantNoConstMissing(String name)

getConstantNoConstMissing

public IRubyObject getConstantNoConstMissing(String name,
                                    boolean inherit)

getConstantNoConstMissing

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

getConstantFrom

public IRubyObject getConstantFrom(String name)

fastGetConstantFrom

@Deprecated
public IRubyObject fastGetConstantFrom(String internedName)

Deprecated.

getConstantFromNoConstMissing

public IRubyObject getConstantFromNoConstMissing(String name)

getConstantFromNoConstMissing

public IRubyObject getConstantFromNoConstMissing(String name,
                                        boolean includePrivate)

fastGetConstantFromNoConstMissing

@Deprecated
public IRubyObject fastGetConstantFromNoConstMissing(String internedName)

Deprecated.

getConstantFromConstMissing

public IRubyObject getConstantFromConstMissing(String name)

fastGetConstantFromConstMissing

@Deprecated
public IRubyObject fastGetConstantFromConstMissing(String internedName)

Deprecated.

resolveUndefConstant

public final IRubyObject resolveUndefConstant(String name)

setConstantQuiet
```
public IRubyObject setConstantQuiet(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
```
public IRubyObject setConstant(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

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

fastSetConstant

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

Deprecated.

defineConstant

public void defineConstant(String name,
                  IRubyObject value)

rb_define_const

isConstantDefined

public boolean isConstantDefined(String name)

rb_const_defined_at

fastIsConstantDefined

public boolean fastIsConstantDefined(String internedName)

fastIsConstantDefined19

public boolean fastIsConstantDefined19(String internedName)

fastIsConstantDefined19

public boolean fastIsConstantDefined19(String internedName,
                              boolean inherit)

hasInternalModuleVariable
```
public boolean hasInternalModuleVariable(String name)
```
Behaves similarly to getClassVar(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(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(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

public IRubyObject storeClassVariable(String name,
                             IRubyObject value)

fastStoreClassVariable

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

Deprecated.

deleteClassVariable

public IRubyObject deleteClassVariable(String name)

getClassVariableNameList

public List<String> getClassVariableNameList()

validateClassVariable

protected final String validateClassVariable(String name)

ensureClassVariablesSettable

protected final void ensureClassVariablesSettable()

hasConstant

public boolean hasConstant(String name)

fastHasConstant

@Deprecated
public boolean fastHasConstant(String internedName)

Deprecated.

fetchConstant

public IRubyObject fetchConstant(String name)

fetchConstant

public IRubyObject fetchConstant(String name,
                        boolean includePrivate)

fastFetchConstant

@Deprecated
public IRubyObject fastFetchConstant(String internedName)

Deprecated.

storeConstant

public IRubyObject storeConstant(String name,
                        IRubyObject value)

storeConstant

public IRubyObject storeConstant(String name,
                        IRubyObject value,
                        boolean hidden)

fastStoreConstant

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

Deprecated.

deleteConstant

public IRubyObject deleteConstant(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

protected final String validateConstant(IRubyObject name)

validateConstant

protected final String validateConstant(String name,
                      IRubyObject errorName)

ensureConstantsSettable

protected final void ensureConstantsSettable()

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)

constantTableRemove

protected IRubyObject constantTableRemove(String name)

defineAutoload

protected final void defineAutoload(String name,
                  RubyModule.AutoloadMethod loadMethod)

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

finishAutoload
```
protected final IRubyObject finishAutoload(String name)
```
Extract an Object which is defined by autoload thread from autoloadMap and define it as a constant.

getAutoloadConstant
```
public final IRubyObject getAutoloadConstant(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

protected IRubyObject getAutoloadConstant(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 Object toJava(Class 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

Parameters:
target - The target type to which the object should be converted.
See Also:
IRubyObject.toJava(java.lang.Class)

discoverInstanceVariables

public Set<String> discoverInstanceVariables()

isRefinement
```
public boolean isRefinement()
```

isMethodBuiltin
```
public boolean isMethodBuiltin(String methodName)
```
Return true if the given method is defined on this class and is a builtin (defined in Java at boot).

Parameters:
methodName -

Returns:

getRefinements

public Map<RubyClass,RubyModule> getRefinements()

setRefinements

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

Class RubyModule

Nested Class Summary

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

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

Field Summary

Fields inherited from class org.jruby.RubyObject

Fields inherited from class org.jruby.RubyBasicObject

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

Constructor Summary

Method Summary

Methods inherited from class org.jruby.RubyObject

Methods inherited from class org.jruby.RubyBasicObject

Methods inherited from class java.lang.Object

Field Detail

ERR_INSECURE_SET_CONSTANT

MODULE_ALLOCATOR

NormalCacheEntryFactory

kindOf

id

parent

baseName

methods

cachedMethods

generation

generationObject

includingHierarchies

methodLocation

superClass

index

SCOPE_CAPTURING_METHODS

classIndex

methodInvalidator

Constructor Detail

RubyModule

RubyModule

RubyModule

Method Detail

createModuleClass

checkValidBindTargetFrom

getClassIndex

getNativeClassIndex

isModule

isClass

isSingleton

isInstance

getConstantMap

getConstantMapForWrite

addIncludingHierarchy

needsImplementer

newModule

newModule

addClassProvider

removeClassProvider

checkForCyclicPrepend

getSuperClass

setSuperClass

getParent

setParent

getMethodLocation

setMethodLocation

getMethods

getMethodsForWrite

isIncluded

isPrepended

getNonIncludedClass

getDelegate

getNonPrependedClass

getBaseName

setBaseName

getName

getSimpleName

refine

using

usingModule

newIncludeClass

getClass

fastGetClass

prependModule

includeModule

defineAnnotatedMethod