Package com.intellij.openapi.module.impl

Class ModuleImpl

java.lang.Object

ComponentManagerImpl

com.intellij.openapi.module.impl.ModuleImpl

All Implemented Interfaces:

ComponentManager, Disposable, AreaInstance, ModuleEx, Module, UserDataHolder

public class ModuleImpl
extends ComponentManagerImpl
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
ModuleImpl(java.lang.String name, Project project, java.lang.String filePath)

Method Summary

Modifier and Type	Method and Description
void	clearScopesCache()
void	dispose() Usually not invoked directly, see class javadoc.
protected ContainerDescriptor	getContainerDescriptor(IdeaPluginDescriptorImpl pluginDescriptor)
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.
long	getOptionsModificationCount()
java.lang.String	getOptionValue(java.lang.String key)
Project	getProject() Returns the project to which this module belongs.
void	init(java.lang.Runnable beforeComponentCreation)
protected boolean	isComponentSuitable(ComponentConfig componentConfig)
boolean	isDisposed() Checks if the module instance has been disposed and unloaded.
boolean	isLoaded()
void	moduleAdded()
void	projectClosed()
void	projectOpened()
void	rename(java.lang.String newName, boolean notifyStorage)
void	setOption(java.lang.String key, java.lang.String value)
protected void	setProgressDuringInit(ProgressIndicator indicator)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

ModuleImpl

public ModuleImpl(java.lang.String name,
                  Project project,
                  java.lang.String filePath)

Method Detail

init

public void init(java.lang.Runnable beforeComponentCreation)

Specified by:

init in interface ModuleEx

setProgressDuringInit

protected void setProgressDuringInit(ProgressIndicator indicator)

isDisposed

public final boolean isDisposed()

Description copied from interface: Module

Checks if the module instance has been disposed and unloaded.

Specified by:

isDisposed in interface ComponentManager

Specified by:

isDisposed in interface Module

Returns:

true if the module has been disposed, false otherwise

isComponentSuitable

protected boolean isComponentSuitable(ComponentConfig componentConfig)

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.

rename

public void rename(java.lang.String newName,
                   boolean notifyStorage)

Specified by:

rename in interface ModuleEx

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

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

getContainerDescriptor

protected ContainerDescriptor getContainerDescriptor(IdeaPluginDescriptorImpl pluginDescriptor)

projectOpened

public void projectOpened()

Specified by:

projectOpened in interface ModuleEx

projectClosed

public void projectClosed()

Specified by:

projectClosed in interface ModuleEx

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

moduleAdded

public void moduleAdded()

Specified by:

moduleAdded in interface ModuleEx

setOption

public void setOption(java.lang.String key,
                      java.lang.String value)

Specified by:

setOption in interface Module

getOptionValue

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

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.

clearScopesCache

public void clearScopesCache()

Specified by:

clearScopesCache in interface ModuleEx

toString

public java.lang.String toString()

getOptionsModificationCount

public long getOptionsModificationCount()

Specified by:

getOptionsModificationCount in interface ModuleEx