org.jruby

Class IncludedModuleWrapper

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyModule

org.jruby.RubyClass

org.jruby.IncludedModuleWrapper

All Implemented Interfaces:

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

Direct Known Subclasses:

BlankSlateWrapper

public class IncludedModuleWrapper
extends RubyClass

This class is used to provide an intermediate superclass for modules and classes that include other modules. It inserts itself as the immediate superClass of the includer, but defers all module methods to the actual superclass. Multiple of these intermediate superclasses can be added for multiple included modules. This allows the normal superclass-based searches (searchMethod, getConstant, etc) to traverse the superclass ancestors as normal while the included modules do not actually show up in direct inheritance traversal.

See Also:

RubyModule, Serialized Form

Nested Class Summary

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

RubyModule.CacheEntryFactory, RubyModule.ConstantEntry, RubyModule.JavaClassKindOf, RubyModule.KindOf, RubyModule.MethodClumper, RubyModule.ModuleKernelMethods, RubyModule.ProfilingCacheEntryFactory, RubyModule.RespondToMissingMethod, RubyModule.SynchronizedCacheEntryFactory, RubyModule.WrapperCacheEntryFactory

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

RubyObject.Data

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

RubyBasicObject.Finalizer

Field Summary

Fields inherited from class org.jruby.RubyClass

CLASS_ALLOCATOR, CS_IDX_INITIALIZE, CS_NAMES, DEFAULT_OBJECT_MARSHAL, marshal, runtime

Fields inherited from class org.jruby.RubyModule

baseName, cachedMethods, ERR_FROZEN_CONST_TYPE, ERR_FROZEN_CVAR_TYPE, ERR_INSECURE_SET_CLASS_VAR, ERR_INSECURE_SET_CONSTANT, generation, generationObject, id, includingHierarchies, index, kindOf, methodInvalidator, MODULE_ALLOCATOR, NormalCacheEntryFactory, parent, SCOPE_CAPTURING_METHODS, 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, metaClass, NEVER, NIL_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUSTED_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, VAR_TABLE_OFFSET, varTable, varTableStamp

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

NULL_ARRAY

Constructor Summary

Constructors

Constructor and Description
IncludedModuleWrapper(Ruby runtime, RubyClass superClass, RubyModule delegate)

Method Summary

Methods

Modifier and Type	Method and Description
void	addMethod(String name, DynamicMethod method)
protected RubyModule.ConstantEntry	constantEntryFetch(String name)
protected boolean	constantTableContains(String name)
protected IRubyObject	constantTableFetch(String name)
protected IRubyObject	constantTableRemove(String name)
protected IRubyObject	constantTableStore(String name, IRubyObject value)
IRubyObject	getAutoloadConstant(String name) Get autoload constant.
protected Map<String,IRubyObject>	getClassVariables()
protected Map<String,IRubyObject>	getClassVariablesForRead()
Collection<String>	getConstantNames()
Collection<String>	getConstantNames(boolean includePrivate)
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.
RubyModule	getNonIncludedClass()
List<String>	getStoredConstantNameList() Deprecated.
IRubyObject	id() We don't want to reveal ourselves to Ruby code, so delegate this operation.
boolean	isClass() Specifically polymorphic method that are meant to be overridden by classes to specify that they are classes in an easy way.
boolean	isImmediate() Is object immediate (def: Fixnum, Symbol, true, false, nil?).
boolean	isIncluded() Is this module one that in an included one (e.g.
boolean	isModule() Specifically polymorphic method that are meant to be overridden by modules to specify that they are modules in an easy way.
protected boolean	isSame(RubyModule module)
IncludedModuleWrapper	newIncludeClass(RubyClass superClass) Deprecated.
void	setMetaClass(RubyClass newRubyClass) Makes it possible to change the metaclass of an object.
void	setMethods(Map newMethods)
protected boolean	variableTableContains(String name) Checks if the variable table contains a variable of the specified name.
protected Object	variableTableFetch(String name) Fetch an object from the variable table based on the name.
protected Object	variableTableRemove(String name) Removes the entry with the specified name from the variable table, and returning the removed value.
protected Object	variableTableStore(String name, Object value) Store a value in the variable store under the specific name.
protected void	variableTableSync(List<Variable<Object>> vars) Synchronize the variable table with the argument.

Methods inherited from class org.jruby.RubyClass

addClassAnnotation, addFieldAnnotation, addFieldSignature, addInvalidatorsAndFlush, addMethodAnnotation, addMethodSignature, addParameterAnnotation, addSubclass, allocate, becomeSynchronized, checkInheritable, createBootstrapClass, createClassClass, finvoke, finvoke, finvoke, finvoke, finvoke, finvoke, finvoke, finvoke, finvoke, finvoke, finvokeChecked, getAllocator, getBaseCallSite, getBaseCallSites, getClassAnnotations, getClassRuntime, getExtraCallSites, getFFIHandleAccessorField, getFFIHandleAccessorForRead, getFFIHandleAccessorForWrite, getFieldAnnotations, getFieldSignatures, getMarshal, getMethodAnnotations, getMethodSignatures, getNativeHandleAccessorField, getNativeHandleAccessorForWrite, getNativeTypeIndex, getObjectGroupAccessorField, getObjectGroupAccessorForRead, getObjectGroupAccessorForWrite, getObjectIdAccessorField, getParameterAnnotations, getRealClass, getReifiedClass, getVariableAccessorForRead, getVariableAccessorForWrite, getVariableAccessorsForRead, getVariableNames, getVariableTableCopy, getVariableTableManager, getVariableTableSize, getVariableTableSizeWithExtras, hasObjectID, inherit, inherited, initialize_copy, initialize, initialize, initialize19, initialize19, invalidateCacheDescendants, invoke, invoke, invoke, invoke, invoke, invoke, invoke, invoke, invoke, invoke, invoke, invokeInherited, isReifiable, isSingleton, makeMetaClass, marshal, marshalTo, newClass, newClass, newClass, newClass, newInstance, newInstance, newInstance, newInstance, newInstance, notVisibleAndNotMethodMissing, reify, reify, reify, reify, reifyWithAncestors, reifyWithAncestors, reifyWithAncestors, reifyWithAncestors, removeSubclass, replaceSubclass, setAllocator, setClassAllocator, setMarshal, setModuleSuperClass, setReifiedClass, setRubyClassAllocator, setRubyStaticAllocator, smartDump, smartLoadNewUser, smartLoadOldUser, subclasses, superclass, toJava, unmarshal, unmarshalFrom

Methods inherited from class org.jruby.RubyModule

addClassProvider, addIncludingHierarchy, addMethodAtBootTimeOnly, addMethodInternal, addModuleFunction, addReadAttribute, addReadWriteAttribute, addWriteAttribute, alias_method, ancestors, ancestors, append_features, attr_accessor, attr_accessor, attr_reader, attr_reader, attr_writer, attr, attr19, checkMethodBound, checkValidBindTargetFrom, class_variable_defined_p, class_variable_get, class_variable_get19, class_variable_set, class_variable_set19, class_variables, class_variables19, cloneMethods, const_defined_p, const_defined_p19, const_get_1_9, const_get_2_0, const_get, const_missing, const_set, constants, constants19, constants19, constantsCommon, constantsCommon, constantsCommon19, createModuleClass, define_method, define_method, define_method, defineAlias, defineAliases, defineAnnotatedConstant, defineAnnotatedConstants, defineAnnotatedMethod, defineAnnotatedMethod, defineAnnotatedMethod, defineAnnotatedMethod, defineAnnotatedMethods, defineAnnotatedMethodsIndividually, defineAutoload, defineClassUnder, defineConstant, defineFastMethod, defineFastMethod, defineFastModuleFunction, defineFastPrivateMethod, defineFastProtectedMethod, defineFastPublicModuleFunction, defineMethod, defineModuleFunction, defineModuleUnder, defineOrGetClassUnder, defineOrGetModuleUnder, definePrivateMethod, definePublicModuleFunction, deleteClassVariable, deleteConstant, discoverInstanceVariables, ensureClassVariablesSettable, ensureConstantsSettable, equals, executeUnder, exportMethod, extend_object, extended, fastFetchClassVariable, fastFetchConstant, fastGetClass, fastGetClassVar, fastGetConstant, fastGetConstant, fastGetConstantAt, fastGetConstantFrom, fastGetConstantFromConstMissing, fastGetConstantFromNoConstMissing, fastHasClassVariable, fastHasConstant, fastIsClassVarDefined, fastIsConstantDefined, fastIsConstantDefined19, fastIsConstantDefined19, fastSetClassVar, fastSetConstant, fastStoreClassVariable, fastStoreConstant, fetchClassVariable, fetchConstant, fetchConstant, findImplementer, finishAutoload, freeze, getAncestorList, getAutoloadFile, getBaseName, getCacheProxy, getCacheToken, getClass, getClassVar, getClassVariableNameList, getConstant, getConstant, getConstant, getConstantAt, getConstantAt, getConstantAtSpecial, getConstantFrom, getConstantFromConstMissing, getConstantFromNoConstMissing, getConstantFromNoConstMissing, getConstantMap, getConstantMapForWrite, getConstantNoConstMissing, getConstantNoConstMissing, getConstantNoConstMissing, getGeneration, getGenerationObject, getInvalidator, getJavaProxy, getParent, getSimpleName, getStoredConstantList, getSuperClass, hasClassVariable, hasConstant, hash, hashCode, hasInternalModuleVariable, hasModuleInHierarchy, include_p, include, included_modules, included, includeModule, initialize, instance_method, instance_methods, instance_methods19, invalidateCacheDescendantsInner, invalidateConstantCache, invalidateCoreClasses, isClassVarDefined, isConstantDefined, isInstance, isKindOfModule, isMethodBound, isMethodBound, isSynchronized, marshalTo, method_added, method_defined_p, method_removed, method_undefined, mix, mix, module_eval, module_eval, module_eval, module_eval, module_eval, module_exec, module_exec, module_function, name, name19, needsImplementer, nesting, newMethod, newMethod, newMethod, newModule, newModule, op_cmp, op_eqq, op_equal, op_ge, op_gt, op_le, op_lt, populateInstanceMethodNames, private_class_method, private_constant, private_constant, private_instance_methods, private_instance_methods19, private_method_defined, protected_instance_methods, protected_instance_methods19, protected_method_defined, public_class_method, public_constant, public_constant, public_instance_methods, public_instance_methods19, public_method_defined, rbPrivate, rbProtected, rbPublic, remove_class_variable, remove_class_variable19, remove_const, remove_method, removeClassProvider, removeClassVariable, removeCvar, removeMethod, resolveUndefConstant, retrieveMethod, searchInternalModuleVariable, searchMethod, searchMethodInner, searchWithCache, setBaseName, setCacheProxy, setClassVar, setConstant, setConstantQuiet, setInternalModuleVariable, setJavaProxy, setMethodVisibility, setParent, setSuperClass, storeClassVariable, storeConstant, syncClassVariables, syncConstants, to_s, undef_method, undef, undefineMethod, updateGeneration, validateClassVariable, validateConstant, visitInterpretedMethods

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, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id_deprecated, 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, isNil, isTaint, isTrue, isUntrusted, kind_of_p, method_missing19, method, method19, methods, methods, methods19, nil_p, 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, 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, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method_added19, singleton_method_removed19, singleton_method_undefined19, singleton_methods, singleton_methods19, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, trust, type_deprecated, type, untaint, untrust, untrusted_p, validateInstanceVariable, variableTableFastContains, variableTableFastFetch, variableTableFastStore, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludedModuleWrapper

public IncludedModuleWrapper(Ruby runtime,
                     RubyClass superClass,
                     RubyModule delegate)

Method Detail

newIncludeClass

@Deprecated
public IncludedModuleWrapper newIncludeClass(RubyClass superClass)

Deprecated.

Overridden newIncludeClass implementation to allow attaching future includes to the correct module (i.e. the one to which this is attached)

Overrides:

newIncludeClass in class RubyModule

Returns:

The module wrapper

See Also:

RubyModule.newIncludeClass(RubyClass)

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 RubyClass

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 RubyClass

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.

isIncluded

public boolean isIncluded()

Description copied from class: RubyModule

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

Overrides:

isIncluded in class RubyModule

isImmediate

public boolean isImmediate()

Description copied from class: RubyBasicObject

Is object immediate (def: Fixnum, Symbol, true, false, nil?).

Specified by:

isImmediate in interface IRubyObject

Overrides:

isImmediate in class RubyBasicObject

Returns:

setMetaClass

public void setMetaClass(RubyClass newRubyClass)

Description copied from class: RubyBasicObject

Makes it possible to change the metaclass of an object. In practice, this is a simple version of Smalltalks Become, except that it doesn't work when we're dealing with subclasses. In practice it's used to change the singleton/meta class used, without changing the "real" inheritance chain.

Overrides:

setMetaClass in class RubyBasicObject

getMethods

public Map<String,DynamicMethod> getMethods()

Overrides:

getMethods in class RubyModule

getMethodsForWrite

public Map<String,DynamicMethod> getMethodsForWrite()

Overrides:

getMethodsForWrite in class RubyModule

addMethod

public void addMethod(String name,
             DynamicMethod method)

Overrides:

addMethod in class RubyModule

setMethods

public void setMethods(Map newMethods)

getName

public String getName()

Description copied from class: RubyModule

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

Overrides:

getName in class RubyModule

Returns:

The generated class name

getNonIncludedClass

public RubyModule getNonIncludedClass()

Overrides:

getNonIncludedClass in class RubyModule

isSame

protected boolean isSame(RubyModule module)

Overrides:

isSame in class RubyModule

id

public IRubyObject id()

We don't want to reveal ourselves to Ruby code, so delegate this operation.

Specified by:

id in interface IRubyObject

Overrides:

id in class RubyBasicObject

Returns:

getClassVariables

protected Map<String,IRubyObject> getClassVariables()

Overrides:

getClassVariables in class RubyModule

getClassVariablesForRead

protected Map<String,IRubyObject> getClassVariablesForRead()

Overrides:

getClassVariablesForRead in class RubyModule

variableTableContains

protected boolean variableTableContains(String name)

Description copied from class: RubyBasicObject

Checks if the variable table contains a variable of the specified name.

Overrides:

variableTableContains in class RubyBasicObject

variableTableFetch

protected Object variableTableFetch(String name)

Description copied from class: RubyBasicObject

Fetch an object from the variable table based on the name.

Overrides:

variableTableFetch in class RubyBasicObject

Returns:

the object or null if not found

variableTableStore

protected Object variableTableStore(String name,
                        Object value)

Description copied from class: RubyBasicObject

Store a value in the variable store under the specific name.

Overrides:

variableTableStore in class RubyBasicObject

variableTableRemove

protected Object variableTableRemove(String name)

Description copied from class: RubyBasicObject

Removes the entry with the specified name from the variable table, and returning the removed value.

Overrides:

variableTableRemove in class RubyBasicObject

variableTableSync

protected void variableTableSync(List<Variable<Object>> vars)

Description copied from class: RubyBasicObject

Synchronize the variable table with the argument. In real terms this means copy all entries into a newly allocated table.

Overrides:

variableTableSync in class RubyBasicObject

constantTableContains

protected boolean constantTableContains(String name)

Overrides:

constantTableContains in class RubyModule

constantTableFetch

protected IRubyObject constantTableFetch(String name)

Overrides:

constantTableFetch in class RubyModule

constantEntryFetch

protected RubyModule.ConstantEntry constantEntryFetch(String name)

Overrides:

constantEntryFetch in class RubyModule

constantTableStore

protected IRubyObject constantTableStore(String name,
                             IRubyObject value)

Overrides:

constantTableStore in class RubyModule

constantTableRemove

protected IRubyObject constantTableRemove(String name)

Overrides:

constantTableRemove in class RubyModule

getStoredConstantNameList

@Deprecated
public List<String> getStoredConstantNameList()

Deprecated.

Overrides:

getStoredConstantNameList in class RubyModule

getConstantNames

public Collection<String> getConstantNames()

Overrides:

getConstantNames in class RubyModule

Returns:

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

getConstantNames

public Collection<String> getConstantNames(boolean includePrivate)

Overrides:

getConstantNames in class RubyModule

getAutoloadConstant

public IRubyObject getAutoloadConstant(String name)

Description copied from class: RubyModule

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.

Overrides:

getAutoloadConstant in class RubyModule