Package com.google.inject.spi

Class ModuleSource

java.lang.Object

com.google.inject.spi.ModuleSource

final class ModuleSource
extends java.lang.Object

Associated to a module, provides the module class name, the parent module source, and the call stack that ends just before the module configure(Binder) method invocation.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	moduleClassName	The class name of module that this ModuleSource associated to.
private ModuleSource	parent	The parent module source.
private BindingSourceRestriction.PermitMap	permitMap	Permit map created by the binder that installed this module.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ModuleSource(ModuleSource parent, java.lang.Class<?> moduleClass, BindingSourceRestriction.PermitMap permitMap)	Creates a new ModuleSource Object.
(package private)	ModuleSource(java.lang.Class<?> moduleClass, BindingSourceRestriction.PermitMap permitMap)	Creates a new ModuleSource with a null parent.

Method Summary

Modifier and Type	Method	Description
(package private) ModuleSource	createChild(java.lang.Class<?> moduleClass)	Creates and returns a child ModuleSource corresponding to the module.
(package private) java.lang.String	getModuleClassName()	Returns the corresponding module class name.
(package private) java.util.List<java.lang.String>	getModuleClassNames()	Returns the class names of modules in this module source.
(package private) ModuleSource	getParent()	Returns the parent module source.
(package private) BindingSourceRestriction.PermitMap	getPermitMap()	Returns the permit map created by the binder that installed this module.
(package private) int	size()	Returns the size of ModuleSources chain (all parents) that ends at this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

moduleClassName

private final java.lang.String moduleClassName

The class name of module that this ModuleSource associated to.

parent

private final ModuleSource parent

The parent module source.

permitMap

private final BindingSourceRestriction.PermitMap permitMap

Permit map created by the binder that installed this module.

The permit map is a binder-scoped object, but it's saved here because these maps have to outlive the binders that created them in order to be used at injector creation, and there isn't a 'BinderSource' object.

Constructor Detail

ModuleSource

ModuleSource(java.lang.Class<?> moduleClass,
             BindingSourceRestriction.PermitMap permitMap)

Creates a new ModuleSource with a null parent.

Parameters:

moduleClass - the corresponding module

ModuleSource

private ModuleSource(@Nullable
                     ModuleSource parent,
                     java.lang.Class<?> moduleClass,
                     BindingSourceRestriction.PermitMap permitMap)

Creates a new ModuleSource Object.

Parameters:

parent - the parent module source

moduleClass - the corresponding module

partialCallStack - the chunk of call stack that starts from the parent module configure(Binder) call and ends just before the module configure(Binder) method invocation

Method Detail

getModuleClassName

java.lang.String getModuleClassName()

Returns the corresponding module class name.

See Also:

Class.getName()

createChild

ModuleSource createChild(java.lang.Class<?> moduleClass)

Creates and returns a child ModuleSource corresponding to the module.

Parameters:

moduleClass - the corresponding module

getParent

ModuleSource getParent()

Returns the parent module source.

getModuleClassNames

java.util.List<java.lang.String> getModuleClassNames()

Returns the class names of modules in this module source. The first element (index 0) is filled by this object getModuleClassName(). The second element is filled by the parent's getModuleClassName() and so on.

size

int size()

Returns the size of ModuleSources chain (all parents) that ends at this object.

getPermitMap

BindingSourceRestriction.PermitMap getPermitMap()

Returns the permit map created by the binder that installed this module.