org.jruby

Class RubyModule

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyModule

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

Direct Known Subclasses:

JavaPackage, 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 java.lang.String	baseName The base name of this class/module, excluding nesting.
protected java.util.Map<java.lang.String,CacheEntry>	cachedMethods
static int	CACHEPROXY_F
protected ClassIndex	classIndex
protected int	generation
protected java.lang.Integer	generationObject
int	id
static int	INCLUDED_INTO_REFINEMENT
protected java.util.Set<RubyClass>	includingHierarchies
int	index Deprecated. use RubyModule#getClassIndex()
static int	IS_OVERLAID_F
RubyModule.KindOf	kindOf
protected Invalidator	methodInvalidator
protected RubyModule	methodLocation
protected java.util.Map<java.lang.String,DynamicMethod>	methods
static ObjectAllocator	MODULE_ALLOCATOR
static int	NEEDSIMPL_F
protected static RubyModule.CacheEntryFactory	NormalCacheEntryFactory
static int	OMOD_SHARED
RubyModule	parent The class/module within whose namespace this class/module resides.
static int	REFINED_MODULE_F
static java.util.Set<java.lang.String>	SCOPE_CAPTURING_METHODS Deprecated.
protected RubyClass	superClass

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

Modifier and Type	Method and Description
void	addClassProvider(ClassProvider provider)
void	addIncludingHierarchy(IncludedModule hierarchy)
void	addMethod(java.lang.String id, DynamicMethod method)
void	addMethodAtBootTimeOnly(java.lang.String id, DynamicMethod method) Deprecated. No longer used, internal API!
void	addMethodInternal(java.lang.String name, DynamicMethod method)
protected void	addMethodSymbols(Ruby runtime, java.util.Set<java.lang.String> seen, RubyArray ary, boolean not, Visibility visibility)
void	addModuleFunction(java.lang.String name, DynamicMethod method)
void	addReadAttribute(ThreadContext context, java.lang.String name)
void	addReadWriteAttribute(ThreadContext context, java.lang.String name)
protected CacheEntry	addToCache(java.lang.String id, CacheEntry entry)
protected CacheEntry	addToCache(java.lang.String id, DynamicMethod method, RubyModule sourceModule, int token)
void	addWriteAttribute(ThreadContext context, java.lang.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) Deprecated.
void	becomeSynchronized()
protected void	checkForCyclicPrepend(RubyModule m)
void	checkFrozen() The actual method that checks frozen with the default frozen message from MRI.
void	checkValidBindTargetFrom(ThreadContext context, RubyModule originModule)
IRubyObject	class_variable_defined_p(ThreadContext context, IRubyObject var)
IRubyObject	class_variable_get(IRubyObject name) rb_mod_cvar_get
IRubyObject	class_variable_get19(IRubyObject name)
IRubyObject	class_variable_set(IRubyObject name, IRubyObject value) rb_mod_cvar_set
IRubyObject	class_variable_set19(IRubyObject name, 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 name, IRubyObject value) rb_mod_const_set
protected RubyModule.ConstantEntry	constantEntryFetch(java.lang.String name)
RubyArray	constants(ThreadContext context)
RubyArray	constants(ThreadContext context, IRubyObject allConstants)
RubyArray	constants19(ThreadContext context) Deprecated.
RubyArray	constants19(ThreadContext context, IRubyObject allConstants) Deprecated.
java.util.Collection<java.lang.String>	constantsCommon(Ruby runtime, boolean replaceModule, boolean allConstants) rb_mod_constants
java.util.Collection<java.lang.String>	constantsCommon(Ruby runtime, boolean replaceModule, boolean allConstants, boolean includePrivate)
RubyArray	constantsCommon19(ThreadContext context, boolean replaceModule, boolean allConstants) Deprecated.
protected boolean	constantTableContains(java.lang.String name)
protected IRubyObject	constantTableFetch(java.lang.String name)
protected IRubyObject	constantTableRemove(java.lang.String name)
protected IRubyObject	constantTableStore(java.lang.String name, IRubyObject value)
protected IRubyObject	constantTableStore(java.lang.String name, IRubyObject value, boolean hidden)
protected IRubyObject	constantTableStore(java.lang.String name, IRubyObject value, boolean hidden, boolean deprecated)
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(java.lang.String name, java.lang.String oldName) rb_alias
void	defineAliases(java.util.List<java.lang.String> aliases, java.lang.String oldId)
boolean	defineAnnotatedConstant(java.lang.reflect.Field field)
void	defineAnnotatedConstants(java.lang.Class clazz)
void	defineAnnotatedMethod(java.lang.Class clazz, java.lang.String name)
boolean	defineAnnotatedMethod(java.lang.reflect.Method method, MethodFactory methodFactory)
boolean	defineAnnotatedMethod(java.lang.String name, JavaMethodDescriptor desc, MethodFactory methodFactory)
boolean	defineAnnotatedMethod(java.lang.String name, java.util.List<JavaMethodDescriptor> methods, MethodFactory methodFactory)
void	defineAnnotatedMethods(java.lang.Class clazz)
void	defineAnnotatedMethodsIndividually(java.lang.Class clazz)
protected void	defineAutoload(java.lang.String name, RubyModule.AutoloadMethod loadMethod) Define an autoload.
RubyClass	defineClassUnder(java.lang.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(java.lang.String name, IRubyObject value) rb_define_const
IRubyObject	defineMethodFromBlock(ThreadContext context, IRubyObject arg0, Block block, Visibility visibility)
IRubyObject	defineMethodFromCallable(ThreadContext context, IRubyObject arg0, IRubyObject arg1, Visibility visibility)
RubyModule	defineModuleUnder(java.lang.String name) rb_define_module_under this method should be used only as an API to define/open nested module
RubyClass	defineOrGetClassUnder(java.lang.String name, RubyClass superClazz) this method should be used only by interpreter or compiler
RubyClass	defineOrGetClassUnder(java.lang.String name, RubyClass superClazz, ObjectAllocator allocator)
RubyModule	defineOrGetModuleUnder(java.lang.String name) this method should be used only by interpreter or compiler
IRubyObject	deleteClassVariable(java.lang.String name)
IRubyObject	deleteConstant(java.lang.String name)
IRubyObject	deprecate_constant(ThreadContext context, IRubyObject name)
IRubyObject	deprecate_constant(ThreadContext context, IRubyObject[] names)
void	deprecateConstant(Ruby runtime, java.lang.String name)
java.util.Set<java.lang.String>	discoverInstanceVariables()
protected void	ensureClassVariablesSettable()
protected void	ensureConstantsSettable()
boolean	equals(java.lang.Object other) We override equals here to provide a faster path, since equality for modules is pretty cut and dried.
void	exportMethod(java.lang.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(java.lang.String internedName) Deprecated.
IRubyObject	fastFetchConstant(java.lang.String internedName) Deprecated.
RubyClass	fastGetClass(java.lang.String internedName) Deprecated.
IRubyObject	fastGetClassVar(java.lang.String internedName) Deprecated.
IRubyObject	fastGetConstant(java.lang.String internedName) Deprecated.
IRubyObject	fastGetConstant(java.lang.String internedName, boolean inherit) Deprecated.
IRubyObject	fastGetConstantAt(java.lang.String internedName) Deprecated.
IRubyObject	fastGetConstantFrom(java.lang.String internedName) Deprecated.
IRubyObject	fastGetConstantFromConstMissing(java.lang.String internedName) Deprecated.
IRubyObject	fastGetConstantFromNoConstMissing(java.lang.String internedName) Deprecated.
boolean	fastHasClassVariable(java.lang.String internedName) Deprecated.
boolean	fastHasConstant(java.lang.String internedName) Deprecated.
boolean	fastIsClassVarDefined(java.lang.String internedName) Deprecated.
boolean	fastIsConstantDefined(java.lang.String internedName)
boolean	fastIsConstantDefined19(java.lang.String internedName)
boolean	fastIsConstantDefined19(java.lang.String internedName, boolean inherit)
IRubyObject	fastSetClassVar(java.lang.String internedName, IRubyObject value) Deprecated.
IRubyObject	fastSetConstant(java.lang.String internedName, IRubyObject value) Deprecated.
IRubyObject	fastStoreClassVariable(java.lang.String internedName, IRubyObject value) Deprecated.
IRubyObject	fastStoreConstant(java.lang.String internedName, IRubyObject value) Deprecated.
IRubyObject	fetchClassVariable(java.lang.String name)
IRubyObject	fetchConstant(java.lang.String name)
IRubyObject	fetchConstant(java.lang.String name, boolean includePrivate)
RubyModule	findImplementer(RubyModule clazz) Find the given class in this hierarchy, considering modules along the way.
protected IRubyObject	finishAutoload(java.lang.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
java.util.List<IRubyObject>	getAncestorList()
IRubyObject	getAutoloadConstant(java.lang.String name) Get autoload constant.
protected IRubyObject	getAutoloadConstant(java.lang.String name, boolean loadConstant)
protected RubyString	getAutoloadFile(java.lang.String name)
java.lang.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(java.lang.String name) Finds a class that is within the current module (or class).
ClassIndex	getClassIndex() Get the ClassIndex for this class.
IRubyObject	getClassVar(IRubyObject nameObject, java.lang.String name)
IRubyObject	getClassVar(java.lang.String name) Retrieve the specified class variable, searching through this module, included modules, and supermodules.
java.util.List<java.lang.String>	getClassVariableNameList()
protected java.util.Map<java.lang.String,IRubyObject>	getClassVariables()
protected java.util.Map<java.lang.String,IRubyObject>	getClassVariablesForRead()
IRubyObject	getClassVarQuiet(java.lang.String name)
IRubyObject	getConstant(java.lang.String name) Retrieve the named constant, invoking 'const_missing' should that be appropriate.
IRubyObject	getConstant(java.lang.String name, boolean inherit)
IRubyObject	getConstant(java.lang.String name, boolean inherit, boolean includeObject)
IRubyObject	getConstantAt(java.lang.String name)
IRubyObject	getConstantAt(java.lang.String name, boolean includePrivate)
IRubyObject	getConstantAtSpecial(java.lang.String name) This version searches superclasses if we're starting with Object.
IRubyObject	getConstantFrom(java.lang.String name)
IRubyObject	getConstantFromConstMissing(java.lang.String name)
IRubyObject	getConstantFromNoConstMissing(java.lang.String name)
IRubyObject	getConstantFromNoConstMissing(java.lang.String name, boolean includePrivate)
java.util.Map<java.lang.String,RubyModule.ConstantEntry>	getConstantMap()
java.util.Map<java.lang.String,RubyModule.ConstantEntry>	getConstantMapForWrite()
java.util.Collection<java.lang.String>	getConstantNames()
java.util.Collection<java.lang.String>	getConstantNames(boolean includePrivate)
IRubyObject	getConstantNoConstMissing(java.lang.String name)
IRubyObject	getConstantNoConstMissing(java.lang.String name, boolean inherit)
IRubyObject	getConstantNoConstMissing(java.lang.String name, boolean inherit, boolean includeObject)
IRubyObject	getConstantNoConstMissingSkipAutoload(java.lang.String name)
IRubyObject	getConstantNoConstMissingSKipAutoload(java.lang.String name) Deprecated.
RubyModule	getDelegate()
int	getGeneration()
java.lang.Integer	getGenerationObject()
java.lang.invoke.MethodHandle	getIdTest()
Invalidator	getInvalidator()
boolean	getJavaProxy() Get whether this class is associated with (i.e.
RubyModule	getMethodLocation()
java.util.Map<java.lang.String,DynamicMethod>	getMethods()
java.util.Map<java.lang.String,DynamicMethod>	getMethodsForWrite()
RubyModule	getModule(java.lang.String name) Finds a module that is within the current module (or class).
java.lang.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	getParent()
java.util.Map<RubyModule,RubyModule>	getRefinements()
java.util.Map<RubyModule,RubyModule>	getRefinementsForWrite()
java.lang.String	getSimpleName() Get the "simple" name for the class, which is either the "base" name or the "anonymous" class name.
java.util.List<Variable<IRubyObject>>	getStoredConstantList() Deprecated.
java.util.List<java.lang.String>	getStoredConstantNameList() Deprecated.
RubyClass	getSuperClass() Getter for property superClass.
boolean	hasClassVariable(java.lang.String name)
boolean	hasConstant(java.lang.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(java.lang.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
RubyModule	include(ThreadContext context, IRubyObject module)
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(java.lang.String constantName)
protected void	invalidateConstantCaches(java.util.Set<java.lang.String> constantNames)
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(java.lang.String name) Is class var defined? Ruby C equivalent = "rb_cvar_defined"
boolean	isConstantDefined(java.lang.String name) rb_const_defined_at
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(java.lang.String name, boolean checkVisibility) MRI: rb_method_boundp
boolean	isMethodBound(java.lang.String name, boolean checkVisibility, boolean checkRespondTo) Deprecated.
boolean	isMethodBuiltin(java.lang.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 TypePopulator	loadPopulatorFor(java.lang.Class<?> type)
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.
static java.util.Map<RubyModule,IncludedModule>	newActivatedRefinementsMap()
protected java.lang.invoke.MethodHandle	newIdTest()
IncludedModuleWrapper	newIncludeClass(RubyClass superClazz) Deprecated.
IRubyObject	newMethod(IRubyObject receiver, java.lang.String methodName, boolean bound, Visibility visibility)
IRubyObject	newMethod(IRubyObject receiver, java.lang.String methodName, boolean bound, Visibility visibility, boolean respondToMissing)
IRubyObject	newMethod(IRubyObject receiver, java.lang.String methodName, boolean bound, Visibility visibility, boolean respondToMissing, boolean priv)
static RubyModule	newModule(Ruby runtime) rb_module_new
static RubyModule	newModule(Ruby runtime, java.lang.String name, RubyModule parent, boolean setParent) rb_module_new/rb_define_module_id/rb_name_class/rb_set_class_path
static java.util.Map<RubyModule,RubyModule>	newRefinementsMap()
static java.util.Map<RubyModule,RubyModule>	newRefinementsMap(java.util.Map<RubyModule,RubyModule> refinements)
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) rb_obj_equal Will by default use identity equality to compare objects.
IRubyObject	op_ge(IRubyObject obj) rb_mod_ge
IRubyObject	op_gt(IRubyObject obj) rb_mod_gt
IRubyObject	op_le(IRubyObject arg) MRI: rb_class_inherited_p
IRubyObject	op_lt(IRubyObject obj) rb_mod_lt
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 name)
IRubyObject	private_constant(ThreadContext context, IRubyObject[] rubyNames)
RubyArray	private_instance_methods(IRubyObject[] args) rb_class_private_instance_methods
RubyArray	private_instance_methods19(IRubyObject[] args) Deprecated.
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) Deprecated.
IRubyObject	protected_method_defined(ThreadContext context, IRubyObject symbol)
RubyModule	public_class_method(IRubyObject[] args)
IRubyObject	public_constant(ThreadContext context, IRubyObject name)
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)
void	putAlias(java.lang.String id, CacheEntry entry, java.lang.String oldName) Alias the method contained in the given CacheEntry as a new entry in this module.
void	putAlias(java.lang.String id, DynamicMethod method, java.lang.String oldName)
DynamicMethod	putMethod(Ruby runtime, java.lang.String id, DynamicMethod method)
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 klass, 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(java.lang.String name)
void	removeMethod(ThreadContext context, java.lang.String id)
CacheEntry	resolveRefinedMethod(java.util.Map<RubyModule,RubyModule> refinements, CacheEntry entry, java.lang.String id, boolean cacheUndef)
IRubyObject	resolveUndefConstant(java.lang.String name)
boolean	respondsToMethod(java.lang.String name, boolean checkVisibility)
DynamicMethod	retrieveMethod(java.lang.String name) Search through this module and supermodules for method definitions.
RubyString	rubyBaseName()
RubyString	rubyName() 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(java.lang.String name) Behaves similarly to getClassVar(String).
DynamicMethod	searchMethod(java.lang.String name) Search through this module and supermodules for method definitions.
protected DynamicMethod	searchMethodCommon(java.lang.String id)
CacheEntry	searchMethodEntryInner(java.lang.String id)
DynamicMethod	searchMethodInner(java.lang.String id)
CacheEntry	searchWithCache(java.lang.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.
CacheEntry	searchWithCache(java.lang.String id, boolean cacheUndef) Search through this module and supermodules for method definitions.
CacheEntry	searchWithRefinements(java.lang.String name, StaticScope refinedScope) Search for the named method in this class and in superclasses applying refinements from the given scope.
void	setBaseName(java.lang.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(java.lang.String name, IRubyObject value) Set the named class variable to the given value, provided taint and freeze allow setting it.
IRubyObject	setConstant(java.lang.String name, IRubyObject value) Set the named constant on this module.
IRubyObject	setConstant(java.lang.String name, IRubyObject value, boolean hidden)
IRubyObject	setConstantQuiet(java.lang.String name, IRubyObject value) Set the named constant on this module.
void	setConstantVisibility(Ruby runtime, java.lang.String name, boolean hidden)
void	setInternalModuleVariable(java.lang.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(java.util.Map<RubyModule,RubyModule> refinements)
void	setSuperClass(RubyClass superClass)
IRubyObject	singleton_class_p(ThreadContext context)
IRubyObject	storeClassVariable(java.lang.String name, IRubyObject value)
IRubyObject	storeConstant(java.lang.String name, IRubyObject value)
IRubyObject	storeConstant(java.lang.String name, IRubyObject value, boolean hidden)
void	syncClassVariables(RubyModule other)
void	syncConstants(RubyModule other)
RubyString	to_s() rb_mod_to_s
<T> T	toJava(java.lang.Class<T> target) Convert the object to the specified Java class, if possible.
RubyModule	undef_method(ThreadContext context, IRubyObject[] args)
void	undef(ThreadContext context, java.lang.String name) rb_undef
static java.lang.String	undefinedMethodMessage(Ruby runtime, IRubyObject name, IRubyObject modName, boolean isModule)
void	undefineMethod(java.lang.String name)
static RubyModule	unmarshalFrom(UnmarshalStream input)
void	updateGeneration()
IRubyObject	used_modules(ThreadContext context)
IRubyObject	using(ThreadContext context, IRubyObject refinedModule)
static void	usingModule(ThreadContext context, RubyModule cref, IRubyObject refinedModule)
protected java.lang.String	validateClassVariable(IRubyObject nameObj, java.lang.String name)
protected java.lang.String	validateClassVariable(Ruby runtime, IRubyObject object)
protected java.lang.String	validateClassVariable(java.lang.String name)
protected java.lang.String	validateConstant(IRubyObject name) Validates name is a valid constant name and returns its id string.
protected java.lang.String	validateConstant(java.lang.String name, IRubyObject errorName)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, dig, eqlInternal, equalInternal, inspect, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, 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, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize, 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, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing, 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, 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_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_method, 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, 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

Field Detail

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

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 java.lang.String baseName

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

methods

protected volatile java.util.Map<java.lang.String,DynamicMethod> methods

cachedMethods

protected java.util.Map<java.lang.String,CacheEntry> cachedMethods

generation

protected int generation

generationObject

protected java.lang.Integer generationObject

includingHierarchies

protected volatile java.util.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 java.util.Set<java.lang.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 java.util.Map<java.lang.String,RubyModule.ConstantEntry> getConstantMap()

getConstantMapForWrite

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

addIncludingHierarchy

public void addIncludingHierarchy(IncludedModule hierarchy)

getIdTest

public final java.lang.invoke.MethodHandle getIdTest()

newIdTest

protected final java.lang.invoke.MethodHandle newIdTest()

needsImplementer

public boolean needsImplementer()

newModule

public static RubyModule newModule(Ruby runtime)

rb_module_new

newModule

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

rb_module_new/rb_define_module_id/rb_name_class/rb_set_class_path

addClassProvider

public final void addClassProvider(ClassProvider provider)

removeClassProvider

public final 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 java.util.Map<java.lang.String,DynamicMethod> getMethods()

getMethodsForWrite

public java.util.Map<java.lang.String,DynamicMethod> getMethodsForWrite()

putMethod

public DynamicMethod putMethod(Ruby runtime,
                               java.lang.String id,
                               DynamicMethod method)

Parameters:

runtime -

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

getNonIncludedClass

public RubyModule getNonIncludedClass()

getDelegate

public RubyModule getDelegate()

getBaseName

public java.lang.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(java.lang.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 java.lang.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

rubyName

public RubyString rubyName()

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.

rubyBaseName

public RubyString rubyBaseName()

getSimpleName

public java.lang.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 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 java.util.Map<RubyModule,RubyModule> newRefinementsMap(java.util.Map<RubyModule,RubyModule> refinements)

newRefinementsMap

public static java.util.Map<RubyModule,RubyModule> newRefinementsMap()

newActivatedRefinementsMap

public static java.util.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

public RubyModule getModule(java.lang.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

public RubyClass getClass(java.lang.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(java.lang.String internedName)

Deprecated.

prependModule

public void prependModule(IRubyObject arg)

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

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(java.lang.Class clazz,
                                  java.lang.String name)

defineAnnotatedConstants

public final void defineAnnotatedConstants(java.lang.Class clazz)

defineAnnotatedConstant

public final boolean defineAnnotatedConstant(java.lang.reflect.Field field)

defineAnnotatedMethods

public void defineAnnotatedMethods(java.lang.Class clazz)

loadPopulatorFor

public static TypePopulator loadPopulatorFor(java.lang.Class<?> type)

defineAnnotatedMethodsIndividually

public final void defineAnnotatedMethodsIndividually(java.lang.Class clazz)

defineAnnotatedMethod

public final boolean defineAnnotatedMethod(java.lang.String name,
                                           java.util.List<JavaMethodDescriptor> methods,
                                           MethodFactory methodFactory)

defineAnnotatedMethod

public final boolean defineAnnotatedMethod(java.lang.reflect.Method method,
                                           MethodFactory methodFactory)

defineAnnotatedMethod

public final boolean defineAnnotatedMethod(java.lang.String name,
                                           JavaMethodDescriptor desc,
                                           MethodFactory methodFactory)

undefineMethod

public void undefineMethod(java.lang.String name)

undef

public void undef(ThreadContext context,
                  java.lang.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(java.lang.String id,
                      DynamicMethod method)

addMethodInternal

public final void addMethodInternal(java.lang.String name,
                                    DynamicMethod method)

addMethodAtBootTimeOnly

public final void addMethodAtBootTimeOnly(java.lang.String id,
                                          DynamicMethod method)

Deprecated. No longer used, internal API!

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:

id - The name to which to bind the method

method - The method to bind

removeMethod

public void removeMethod(ThreadContext context,
                         java.lang.String id)

searchMethod

public final DynamicMethod searchMethod(java.lang.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(java.lang.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(java.lang.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(java.lang.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 java.lang.Integer getGenerationObject()

becomeSynchronized

public void becomeSynchronized()

isSynchronized

public boolean isSynchronized()

addToCache

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

addToCache

protected CacheEntry addToCache(java.lang.String id,
                                CacheEntry entry)

searchMethodInner

public DynamicMethod searchMethodInner(java.lang.String id)

searchMethodEntryInner

public CacheEntry searchMethodEntryInner(java.lang.String id)

resolveRefinedMethod

public CacheEntry resolveRefinedMethod(java.util.Map<RubyModule,RubyModule> refinements,
                                       CacheEntry entry,
                                       java.lang.String id,
                                       boolean cacheUndef)

searchMethodCommon

protected DynamicMethod searchMethodCommon(java.lang.String id)

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(java.lang.String constantName)

invalidateConstantCaches

protected void invalidateConstantCaches(java.util.Set<java.lang.String> constantNames)

retrieveMethod

public DynamicMethod retrieveMethod(java.lang.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(java.lang.String name,
                              DynamicMethod method)

defineAlias

public void defineAlias(java.lang.String name,
                        java.lang.String oldName)

rb_alias

putAlias

public void putAlias(java.lang.String id,
                     DynamicMethod method,
                     java.lang.String oldName)

Parameters:

id -

method -

oldName -

putAlias

public void putAlias(java.lang.String id,
                     CacheEntry entry,
                     java.lang.String oldName)

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

Parameters:

id -

entry -

oldName -

defineAliases

public void defineAliases(java.util.List<java.lang.String> aliases,
                          java.lang.String oldId)

defineOrGetClassUnder

public RubyClass defineOrGetClassUnder(java.lang.String name,
                                       RubyClass superClazz)

this method should be used only by interpreter or compiler

defineOrGetClassUnder

public RubyClass defineOrGetClassUnder(java.lang.String name,
                                       RubyClass superClazz,
                                       ObjectAllocator allocator)

defineOrGetModuleUnder

public RubyModule defineOrGetModuleUnder(java.lang.String name)

this method should be used only by interpreter or compiler

defineClassUnder

public RubyClass defineClassUnder(java.lang.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(java.lang.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(java.lang.String name,
                         Visibility visibility)

rb_export_method

undefinedMethodMessage

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

isMethodBound

public boolean isMethodBound(java.lang.String name,
                             boolean checkVisibility)

MRI: rb_method_boundp

respondsToMethod

public boolean respondsToMethod(java.lang.String name,
                                boolean checkVisibility)

isMethodBound

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

Deprecated.

newMethod

public final IRubyObject newMethod(IRubyObject receiver,
                                   java.lang.String methodName,
                                   boolean bound,
                                   Visibility visibility)

newMethod

public final IRubyObject newMethod(IRubyObject receiver,
                                   java.lang.String methodName,
                                   boolean bound,
                                   Visibility visibility,
                                   boolean respondToMissing)

newMethod

public IRubyObject newMethod(IRubyObject receiver,
                             java.lang.String methodName,
                             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

public IRubyObject name()

name19

public IRubyObject name19()

cloneMethods

protected final 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 java.util.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 RubyString 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(java.lang.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

public IRubyObject op_le(IRubyObject arg)

MRI: rb_class_inherited_p

searchAncestor

protected RubyModule searchAncestor(RubyModule c)

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,
                                  java.lang.String name)

addReadAttribute

public void addReadAttribute(ThreadContext context,
                             java.lang.String name)

addWriteAttribute

public void addWriteAttribute(ThreadContext context,
                              java.lang.String name)

attr

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

rb_mod_attr

attr19

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

Deprecated.

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)

addMethodSymbols

protected void addMethodSymbols(Ruby runtime,
                                java.util.Set<java.lang.String> seen,
                                RubyArray ary,
                                boolean not,
                                Visibility visibility)

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

@Deprecated
public RubyArray protected_instance_methods19(IRubyObject[] args)

Deprecated.

private_instance_methods

public RubyArray private_instance_methods(IRubyObject[] args)

rb_class_private_instance_methods

private_instance_methods19

@Deprecated
public RubyArray private_instance_methods19(IRubyObject[] args)

Deprecated.

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

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 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 java.io.IOException

Throws:

java.io.IOException

unmarshalFrom

public static RubyModule unmarshalFrom(UnmarshalStream input)
                                throws java.io.IOException

Throws:

java.io.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 name)

rb_mod_cvar_get

class_variable_get19

public IRubyObject class_variable_get19(IRubyObject name)

class_variable_set

public IRubyObject class_variable_set(IRubyObject name,
                                      IRubyObject value)

rb_mod_cvar_set

class_variable_set19

public IRubyObject class_variable_set19(IRubyObject name,
                                        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 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)

constants19

@Deprecated
public RubyArray constants19(ThreadContext context)

Deprecated.

constants19

@Deprecated
public RubyArray constants19(ThreadContext context,
                                         IRubyObject allConstants)

Deprecated.

constantsCommon19

@Deprecated
public RubyArray constantsCommon19(ThreadContext context,
                                               boolean replaceModule,
                                               boolean allConstants)

Deprecated.

constantsCommon

public java.util.Collection<java.lang.String> constantsCommon(Ruby runtime,
                                                              boolean replaceModule,
                                                              boolean allConstants)

rb_mod_constants

constantsCommon

public java.util.Collection<java.lang.String> constantsCommon(Ruby runtime,
                                                              boolean replaceModule,
                                                              boolean allConstants,
                                                              boolean includePrivate)

deprecateConstant

public void deprecateConstant(Ruby runtime,
                              java.lang.String name)

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

public final void setConstantVisibility(Ruby runtime,
                                        java.lang.String name,
                                        boolean hidden)

setClassVar

public IRubyObject setClassVar(java.lang.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(java.lang.String internedName,
                                               IRubyObject value)

Deprecated.

getClassVar

public IRubyObject getClassVar(java.lang.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

public IRubyObject getClassVar(IRubyObject nameObject,
                               java.lang.String name)

getClassVarQuiet

public IRubyObject getClassVarQuiet(java.lang.String name)

fastGetClassVar

@Deprecated
public IRubyObject fastGetClassVar(java.lang.String internedName)

Deprecated.

isClassVarDefined

public boolean isClassVarDefined(java.lang.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(java.lang.String internedName)

Deprecated.

removeClassVariable

public IRubyObject removeClassVariable(java.lang.String name)

getConstantAtSpecial

public IRubyObject getConstantAtSpecial(java.lang.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(java.lang.String name)

getConstantAt

public IRubyObject getConstantAt(java.lang.String name,
                                 boolean includePrivate)

fastGetConstantAt

@Deprecated
public IRubyObject fastGetConstantAt(java.lang.String internedName)

Deprecated.

getConstant

public IRubyObject getConstant(java.lang.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(java.lang.String name,
                               boolean inherit)

getConstant

public IRubyObject getConstant(java.lang.String name,
                               boolean inherit,
                               boolean includeObject)

fastGetConstant

@Deprecated
public IRubyObject fastGetConstant(java.lang.String internedName)

Deprecated.

fastGetConstant

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

Deprecated.

getConstantNoConstMissing

public IRubyObject getConstantNoConstMissing(java.lang.String name)

getConstantNoConstMissing

public IRubyObject getConstantNoConstMissing(java.lang.String name,
                                             boolean inherit)

getConstantNoConstMissing

public IRubyObject getConstantNoConstMissing(java.lang.String name,
                                             boolean inherit,
                                             boolean includeObject)

getConstantNoConstMissingSkipAutoload

public final IRubyObject getConstantNoConstMissingSkipAutoload(java.lang.String name)

getConstantNoConstMissingSKipAutoload

@Deprecated
public IRubyObject getConstantNoConstMissingSKipAutoload(java.lang.String name)

Deprecated.

getConstantFrom

public IRubyObject getConstantFrom(java.lang.String name)

fastGetConstantFrom

@Deprecated
public IRubyObject fastGetConstantFrom(java.lang.String internedName)

Deprecated.

getConstantFromNoConstMissing

public IRubyObject getConstantFromNoConstMissing(java.lang.String name)

getConstantFromNoConstMissing

public IRubyObject getConstantFromNoConstMissing(java.lang.String name,
                                                 boolean includePrivate)

fastGetConstantFromNoConstMissing

@Deprecated
public IRubyObject fastGetConstantFromNoConstMissing(java.lang.String internedName)

Deprecated.

getConstantFromConstMissing

public IRubyObject getConstantFromConstMissing(java.lang.String name)

fastGetConstantFromConstMissing

@Deprecated
public IRubyObject fastGetConstantFromConstMissing(java.lang.String internedName)

Deprecated.

resolveUndefConstant

public final IRubyObject resolveUndefConstant(java.lang.String name)

setConstantQuiet

public IRubyObject setConstantQuiet(java.lang.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(java.lang.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(java.lang.String name,
                               IRubyObject value,
                               boolean hidden)

fastSetConstant

@Deprecated
public IRubyObject fastSetConstant(java.lang.String internedName,
                                               IRubyObject value)

Deprecated.

defineConstant

public void defineConstant(java.lang.String name,
                           IRubyObject value)

rb_define_const

isConstantDefined

public boolean isConstantDefined(java.lang.String name)

rb_const_defined_at

fastIsConstantDefined

public boolean fastIsConstantDefined(java.lang.String internedName)

fastIsConstantDefined19

public boolean fastIsConstantDefined19(java.lang.String internedName)

fastIsConstantDefined19

public boolean fastIsConstantDefined19(java.lang.String internedName,
                                       boolean inherit)

hasInternalModuleVariable

public boolean hasInternalModuleVariable(java.lang.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(java.lang.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(java.lang.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 java.util.Map<java.lang.String,IRubyObject> getClassVariables()

getClassVariablesForRead

protected java.util.Map<java.lang.String,IRubyObject> getClassVariablesForRead()

hasClassVariable

public boolean hasClassVariable(java.lang.String name)

fastHasClassVariable

@Deprecated
public boolean fastHasClassVariable(java.lang.String internedName)

Deprecated.

fetchClassVariable

public IRubyObject fetchClassVariable(java.lang.String name)

fastFetchClassVariable

@Deprecated
public IRubyObject fastFetchClassVariable(java.lang.String internedName)

Deprecated.

storeClassVariable

public IRubyObject storeClassVariable(java.lang.String name,
                                      IRubyObject value)

fastStoreClassVariable

@Deprecated
public IRubyObject fastStoreClassVariable(java.lang.String internedName,
                                                      IRubyObject value)

Deprecated.

deleteClassVariable

public IRubyObject deleteClassVariable(java.lang.String name)

getClassVariableNameList

public java.util.List<java.lang.String> getClassVariableNameList()

validateClassVariable

protected final java.lang.String validateClassVariable(java.lang.String name)

validateClassVariable

protected final java.lang.String validateClassVariable(IRubyObject nameObj,
                                                       java.lang.String name)

validateClassVariable

protected java.lang.String validateClassVariable(Ruby runtime,
                                                 IRubyObject object)

ensureClassVariablesSettable

protected final void ensureClassVariablesSettable()

hasConstant

public boolean hasConstant(java.lang.String name)

fastHasConstant

@Deprecated
public boolean fastHasConstant(java.lang.String internedName)

Deprecated.

fetchConstant

public IRubyObject fetchConstant(java.lang.String name)

fetchConstant

public IRubyObject fetchConstant(java.lang.String name,
                                 boolean includePrivate)

fastFetchConstant

@Deprecated
public IRubyObject fastFetchConstant(java.lang.String internedName)

Deprecated.

storeConstant

public IRubyObject storeConstant(java.lang.String name,
                                 IRubyObject value)

storeConstant

public IRubyObject storeConstant(java.lang.String name,
                                 IRubyObject value,
                                 boolean hidden)

fastStoreConstant

@Deprecated
public IRubyObject fastStoreConstant(java.lang.String internedName,
                                                 IRubyObject value)

Deprecated.

deleteConstant

public IRubyObject deleteConstant(java.lang.String name)

getStoredConstantList

@Deprecated
public java.util.List<Variable<IRubyObject>> getStoredConstantList()

Deprecated.

getStoredConstantNameList

@Deprecated
public java.util.List<java.lang.String> getStoredConstantNameList()

Deprecated.

getConstantNames

public java.util.Collection<java.lang.String> getConstantNames()

Returns:

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

getConstantNames

public java.util.Collection<java.lang.String> getConstantNames(boolean includePrivate)

validateConstant

protected final java.lang.String validateConstant(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

protected final java.lang.String validateConstant(java.lang.String name,
                                                  IRubyObject errorName)

ensureConstantsSettable

protected final void ensureConstantsSettable()

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(java.lang.String name)

constantTableFetch

protected IRubyObject constantTableFetch(java.lang.String name)

constantEntryFetch

protected RubyModule.ConstantEntry constantEntryFetch(java.lang.String name)

constantTableStore

protected IRubyObject constantTableStore(java.lang.String name,
                                         IRubyObject value)

constantTableStore

protected IRubyObject constantTableStore(java.lang.String name,
                                         IRubyObject value,
                                         boolean hidden)

constantTableStore

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

constantTableRemove

protected IRubyObject constantTableRemove(java.lang.String name)

defineAutoload

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

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

finishAutoload

protected final IRubyObject finishAutoload(java.lang.String name)

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

getAutoloadConstant

public final IRubyObject getAutoloadConstant(java.lang.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(java.lang.String name,
                                          boolean loadConstant)

getAutoloadFile

protected RubyString getAutoloadFile(java.lang.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(java.lang.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

Parameters:

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

See Also:

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

discoverInstanceVariables

public java.util.Set<java.lang.String> discoverInstanceVariables()

isRefinement

public boolean isRefinement()

isIncludedIntoRefinement

public boolean isIncludedIntoRefinement()

isMethodBuiltin

public boolean isMethodBuiltin(java.lang.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 java.util.Map<RubyModule,RubyModule> getRefinements()

getRefinementsForWrite

public java.util.Map<RubyModule,RubyModule> getRefinementsForWrite()

setRefinements

public void setRefinements(java.util.Map<RubyModule,RubyModule> refinements)