Package com.intellij.openapi.module

Interface Module

All Superinterfaces:

AreaInstance, ComponentManager, Disposable, UserDataHolder

All Known Subinterfaces:

ModuleEx

All Known Implementing Classes:

CoreModule, ModuleImpl

public interface Module
extends ComponentManager, AreaInstance, Disposable

Represents a module in an IDEA project.

See Also:

ModuleManager.getModules(), ModuleComponent

Nested Class Summary

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

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT_TYPE
static Module[]	EMPTY_ARRAY The empty array of modules which cab be reused to avoid unnecessary allocations.

Method Summary

Modifier and Type	Method and Description
default void	clearOption(java.lang.String key) Deprecated. Please store options in your own PersistentStateComponent
GlobalSearchScope	getModuleContentScope()
GlobalSearchScope	getModuleContentWithDependenciesScope()
VirtualFile	getModuleFile() Returns the VirtualFile for the module .iml file.
@SystemIndependent 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()
default java.lang.String	getModuleTypeName()
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 key) Deprecated. Please store options in your own PersistentStateComponent
Project	getProject() Returns the project to which this module belongs.
boolean	isDisposed() Checks if the module instance has been disposed and unloaded.
boolean	isLoaded()
default void	setModuleType(java.lang.String name)
void	setOption(java.lang.String key, java.lang.String value) Deprecated. Please store options in your own PersistentStateComponent

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

Field Detail

EMPTY_ARRAY

static final Module[] EMPTY_ARRAY

The empty array of modules which cab be reused to avoid unnecessary allocations.

ELEMENT_TYPE

static final java.lang.String ELEMENT_TYPE

See Also:

Constant Field Values

Method Detail

getModuleFile

VirtualFile getModuleFile()

Returns the VirtualFile for the module .iml file.

Returns:

the virtual file instance.

getModuleFilePath

@SystemIndependent java.lang.String getModuleFilePath()

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

getProject

Project getProject()

Returns the project to which this module belongs.

Returns:

the project instance.

getName

java.lang.String getName()

Returns the name of this module.

Returns:

the module name.

isDisposed

boolean isDisposed()

Checks if the module instance has been disposed and unloaded.

Specified by:

isDisposed in interface ComponentManager

Returns:

true if the module has been disposed, false otherwise

isLoaded

boolean isLoaded()

clearOption

@Deprecated
default void clearOption(java.lang.String key)

Deprecated. Please store options in your own PersistentStateComponent

setOption

@Deprecated
void setOption(java.lang.String key,
               java.lang.String value)

Deprecated. Please store options in your own PersistentStateComponent

getOptionValue

@Deprecated
java.lang.String getOptionValue(java.lang.String key)

Deprecated. Please store options in your own PersistentStateComponent

getModuleScope

GlobalSearchScope getModuleScope()

Returns:

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

getModuleScope

GlobalSearchScope getModuleScope(boolean includeTests)

Parameters:

includeTests - whether to include test source

Returns:

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

getModuleWithLibrariesScope

GlobalSearchScope getModuleWithLibrariesScope()

Returns:

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

getModuleWithDependenciesScope

GlobalSearchScope getModuleWithDependenciesScope()

Returns:

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

getModuleContentScope

GlobalSearchScope getModuleContentScope()

Returns:

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

getModuleContentWithDependenciesScope

GlobalSearchScope getModuleContentWithDependenciesScope()

Returns:

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

getModuleWithDependenciesAndLibrariesScope

GlobalSearchScope getModuleWithDependenciesAndLibrariesScope(boolean includeTests)

Parameters:

includeTests - whether test source and test dependencies should be included

Returns:

a scope including module source and dependencies with libraries

getModuleWithDependentsScope

GlobalSearchScope getModuleWithDependentsScope()

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

GlobalSearchScope getModuleTestsWithDependentsScope()

Returns:

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

getModuleRuntimeScope

GlobalSearchScope getModuleRuntimeScope(boolean includeTests)

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.

getModuleTypeName

default java.lang.String getModuleTypeName()

setModuleType

default void setModuleType(java.lang.String name)