Package com.google.inject.spi

Class ModuleSource

java.lang.Object

com.google.inject.spi.ModuleSource

final class ModuleSource
extends 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 final String	moduleClassName	The class name of module that this ModuleSource associated to.
private final ModuleSource	parent	The parent module source.
private final StackTraceElements.InMemoryStackTraceElement[]	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.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ModuleSource(ModuleSource parent, Class<?> moduleClass, StackTraceElement[] partialCallStack)	Creates a new ModuleSource Object.
(package private)	ModuleSource(Class<?> moduleClass, StackTraceElement[] partialCallStack)	Creates a new ModuleSource with a null parent.

Method Summary

Modifier and Type	Method	Description
(package private) ModuleSource	createChild(Class<?> moduleClass, StackTraceElement[] partialCallStack)	Creates and returns a child ModuleSource corresponding to the module.
(package private) String	getModuleClassName()	Returns the corresponding module class name.
(package private) List<String>	getModuleClassNames()	Returns the class names of modules in this module source.
(package private) ModuleSource	getParent()	Returns the parent module source.
(package private) StackTraceElement[]	getPartialCallStack()	Returns the chunk of call stack that starts from the parent module configure(Binder) call and ends just before the module configure(Binder) method invocation.
(package private) int	getPartialCallStackSize()	Returns the size of partial call stack if stack trace collection is on otherwise zero.
(package private) StackTraceElement[]	getStackTrace()	Returns the full call stack that ends just before the module configure(Binder) method invocation.
(package private) int	getStackTraceSize()	Returns the size of call stack that ends just before the module configure(Binder) method invocation (see getStackTrace()).
(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 Details

moduleClassName

private final String moduleClassName

The class name of module that this ModuleSource associated to.

parent

private final ModuleSource parent

The parent module source.

partialCallStack

private final StackTraceElements.InMemoryStackTraceElement[] 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. For a module without a parent module the chunk starts from the bottom of call stack. The array is non-empty if stack trace collection is on.

Constructor Details

ModuleSource

ModuleSource(Class<?> moduleClass,
 StackTraceElement[] partialCallStack)

Creates a new ModuleSource with a null parent.

Parameters:

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

ModuleSource

private ModuleSource(ModuleSource parent,
 Class<?> moduleClass,
 StackTraceElement[] partialCallStack)

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 Details

getModuleClassName

String getModuleClassName()

Returns the corresponding module class name.

See Also:

• Class.getName()

getPartialCallStack

StackTraceElement[] getPartialCallStack()

Returns the chunk of call stack that starts from the parent module configure(Binder) call and ends just before the module configure(Binder) method invocation. The return array is non-empty only if stack trace collection is on.

getPartialCallStackSize

int getPartialCallStackSize()

Returns the size of partial call stack if stack trace collection is on otherwise zero.

createChild

ModuleSource createChild(Class<?> moduleClass,
 StackTraceElement[] partialCallStack)

Creates and returns a child ModuleSource corresponding to the module.

Parameters:

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

getParent

ModuleSource getParent()

Returns the parent module source.

getModuleClassNames

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

getStackTraceSize

int getStackTraceSize()

Returns the size of call stack that ends just before the module configure(Binder) method invocation (see getStackTrace()).

getStackTrace

StackTraceElement[] getStackTrace()

Returns the full call stack that ends just before the module configure(Binder) method invocation. The return array is non-empty if stack trace collection on.