Package com.intellij.core

Class CoreModule

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.mock.MockComponentManager

com.intellij.core.CoreModule

All Implemented Interfaces:

ComponentManager, Disposable, AreaInstance, ModuleEx, Module, UserDataHolder, UserDataHolderEx, MessageBusOwner

public class CoreModule
extends MockComponentManager
implements ModuleEx

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields inherited from interface com.intellij.openapi.module.Module

ELEMENT_TYPE, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
CoreModule(Disposable parentDisposable, Project project, java.lang.String moduleFilePath)

Method Summary

Modifier and Type	Method and Description
protected <T> void	addModuleExtension(ExtensionPointName<T> name, T extension)
void	clearScopesCache()
protected ModuleFileIndex	createModuleFileIndex()
protected PathMacroManager	createModulePathMacroManager(Project project)
protected ModuleScopeProvider	createModuleScopeProvider()
GlobalSearchScope	getModuleContentScope()
GlobalSearchScope	getModuleContentWithDependenciesScope()
VirtualFile	getModuleFile() Returns the VirtualFile for the module .iml file.
java.lang.String	getModuleFilePath() System-independent path to the .iml file or empty string if module is not persistent.
GlobalSearchScope	getModuleRuntimeScope(boolean includeTests)
GlobalSearchScope	getModuleScope()
GlobalSearchScope	getModuleScope(boolean includeTests)
GlobalSearchScope	getModuleTestsWithDependentsScope()
GlobalSearchScope	getModuleWithDependenciesAndLibrariesScope(boolean includeTests)
GlobalSearchScope	getModuleWithDependenciesScope()
GlobalSearchScope	getModuleWithDependentsScope()
GlobalSearchScope	getModuleWithLibrariesScope()
java.lang.String	getName() Returns the name of this module.
java.lang.String	getOptionValue(java.lang.String optionName)
Project	getProject() Returns the project to which this module belongs.
protected void	initModuleExtensions()
boolean	isLoaded()
void	setOption(java.lang.String optionName, java.lang.String optionValue)

Methods inherited from class com.intellij.mock.MockComponentManager

addComponent, createListener, dispose, getComponent, getDisposed, getExtensionArea, getMessageBus, getPicoContainer, getService, isDisposed, registerComponentInDisposer, registerService, registerService, registerService, registerService

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.module.impl.ModuleEx

getOptionsModificationCount, init, moduleAdded, projectClosed, projectOpened, rename

Methods inherited from interface com.intellij.openapi.module.Module

clearOption, getModuleTypeName, isDisposed, setModuleType

Methods inherited from interface com.intellij.openapi.components.ComponentManager

createError, createError, getComponent, getComponent, getComponent, getComponentInstancesOfType, getComponentInstancesOfType, getComponents, getDisposed, getExtensionArea, getExtensions, getMessageBus, getPicoContainer, getService, getService, getServiceIfCreated, hasComponent, instantiateClass, instantiateClassWithConstructorInjection, instantiateExtensionWithPicoContainerOnlyIfNeeded, isDisposedOrDisposeInProgress, logError

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Methods inherited from interface com.intellij.openapi.Disposable

dispose

Constructor Detail

CoreModule

public CoreModule(Disposable parentDisposable,
                  Project project,
                  java.lang.String moduleFilePath)

Method Detail

initModuleExtensions

protected void initModuleExtensions()

addModuleExtension

protected <T> void addModuleExtension(ExtensionPointName<T> name,
                                      T extension)

createModuleScopeProvider

protected ModuleScopeProvider createModuleScopeProvider()

createModulePathMacroManager

protected PathMacroManager createModulePathMacroManager(Project project)

createModuleFileIndex

protected ModuleFileIndex createModuleFileIndex()

clearScopesCache

public void clearScopesCache()

Specified by:

clearScopesCache in interface ModuleEx

getModuleFile

public VirtualFile getModuleFile()

Description copied from interface: Module

Returns the VirtualFile for the module .iml file.

Specified by:

getModuleFile in interface Module

Returns:

the virtual file instance.

getModuleFilePath

public java.lang.String getModuleFilePath()

Description copied from interface: Module

System-independent path to the .iml file or empty string if module is not persistent.

Specified by:

getModuleFilePath in interface Module

getProject

public Project getProject()

Description copied from interface: Module

Returns the project to which this module belongs.

Specified by:

getProject in interface Module

Returns:

the project instance.

getName

public java.lang.String getName()

Description copied from interface: Module

Returns the name of this module.

Specified by:

getName in interface Module

Returns:

the module name.

isLoaded

public boolean isLoaded()

Specified by:

isLoaded in interface Module

setOption

public void setOption(java.lang.String optionName,
                      java.lang.String optionValue)

Specified by:

setOption in interface Module

getOptionValue

public java.lang.String getOptionValue(java.lang.String optionName)

Specified by:

getOptionValue in interface Module

getModuleScope

public GlobalSearchScope getModuleScope()

Specified by:

getModuleScope in interface Module

Returns:

module scope including source and tests, excluding libraries and dependencies.

getModuleScope

public GlobalSearchScope getModuleScope(boolean includeTests)

Specified by:

getModuleScope in interface Module

Parameters:

includeTests - whether to include test source

Returns:

module scope including source and, optionally, tests, excluding libraries and dependencies.

getModuleWithLibrariesScope

public GlobalSearchScope getModuleWithLibrariesScope()

Specified by:

getModuleWithLibrariesScope in interface Module

Returns:

module scope including source, tests, and libraries, excluding dependencies.

getModuleWithDependenciesScope

public GlobalSearchScope getModuleWithDependenciesScope()

Specified by:

getModuleWithDependenciesScope in interface Module

Returns:

module scope including source, tests, and dependencies, excluding libraries.

getModuleContentScope

public GlobalSearchScope getModuleContentScope()

Specified by:

getModuleContentScope in interface Module

Returns:

a scope that includes everything in module content roots, without any dependencies or libraries

getModuleContentWithDependenciesScope

public GlobalSearchScope getModuleContentWithDependenciesScope()

Specified by:

getModuleContentWithDependenciesScope in interface Module

Returns:

a scope that includes everything under the content roots of this module and its dependencies, with test source

getModuleWithDependenciesAndLibrariesScope

public GlobalSearchScope getModuleWithDependenciesAndLibrariesScope(boolean includeTests)

Specified by:

getModuleWithDependenciesAndLibrariesScope in interface Module

Parameters:

includeTests - whether test source and test dependencies should be included

Returns:

a scope including module source and dependencies with libraries

getModuleWithDependentsScope

public GlobalSearchScope getModuleWithDependentsScope()

Specified by:

getModuleWithDependentsScope in interface Module

Returns:

a scope including everything under the content roots of this module and all modules that depend on it, directly or indirectly (via exported dependencies), excluding test source and resources

getModuleTestsWithDependentsScope

public GlobalSearchScope getModuleTestsWithDependentsScope()

Specified by:

getModuleTestsWithDependentsScope in interface Module

Returns:

same as Module.getModuleWithDependentsScope(), but with test source/resources included

getModuleRuntimeScope

public GlobalSearchScope getModuleRuntimeScope(boolean includeTests)

Specified by:

getModuleRuntimeScope in interface Module

Parameters:

includeTests - whether test source and test dependencies should be included

Returns:

a scope including production (and optionally test) source of this module and all modules and libraries it depends upon, including runtime and transitive dependencies, even if they're not exported.