Package com.intellij.openapi.roots

Interface ModuleRootModel

All Known Subinterfaces:

ModifiableRootModel

All Known Implementing Classes:

JpsRootModel, ModuleRootManager, ModuleRootManagerComponent, ModuleRootManagerEx, ModuleRootManagerImpl, RootModelBase, RootModelImpl

public interface ModuleRootModel

Interface providing root information model for a given module. It's implemented by ModuleRootManager.

Method Summary

Modifier and Type	Method and Description
ContentEntry []	getContentEntries() Use this method to obtain all content entries of a module.
VirtualFile []	getContentRoots() Returns an array of content roots from all content entries.
java.lang.String []	getContentRootUrls() Returns an array of content root urls from all content entries.
java.lang.String []	getDependencyModuleNames() Returns list of module names this module depends on.
VirtualFile []	getExcludeRoots() Returns an array of exclude roots from all content entries.
java.lang.String []	getExcludeRootUrls() Returns an array of exclude root urls from all content entries.
Module	getModule() Returns the module to which the model belongs.
Module []	getModuleDependencies()
Module []	getModuleDependencies(boolean includeTests)
<T> T	getModuleExtension(java.lang.Class<T> klass)
OrderEntry []	getOrderEntries() Use this method to obtain order of roots of a module.
Sdk	getSdk() Returns the SDK used by the module.
VirtualFile []	getSourceRoots() Returns an array of source roots from all content entries.
VirtualFile []	getSourceRoots(boolean includingTests) Returns an array of source roots from all content entries.
java.util.List<VirtualFile>	getSourceRoots(JpsModuleSourceRootType<?> rootType) Return a list of source roots of the specified type.
java.util.List<VirtualFile>	getSourceRoots(java.util.Set<? extends JpsModuleSourceRootType<?>> rootTypes) Return a list of source roots which types belong to the specified set.
java.lang.String []	getSourceRootUrls() Returns an array of source root urls from all content entries.
java.lang.String []	getSourceRootUrls(boolean includingTests) Returns an array of source root urls from all content entries.
boolean	isSdkInherited() Returns true if SDK for this module is inherited from a project.
OrderEnumerator	orderEntries() Returns OrderEnumerator instance which can be used to process order entries of the module (with or without dependencies) and collect classes or source roots.
<R> R	processOrder(RootPolicy<R> policy, R initialValue) Passes all order entries in the module to the specified visitor.

Method Detail

getModule

Module getModule()

Returns the module to which the model belongs.

Returns:

the module instance.

getContentEntries

ContentEntry [] getContentEntries()

Use this method to obtain all content entries of a module. Entries are given in lexicographical order of their paths.

Returns:

list of content entries for this module

See Also:

ContentEntry

getOrderEntries

OrderEntry [] getOrderEntries()

Use this method to obtain order of roots of a module. Order of entries is important.

Returns:

list of order entries for this module

getSdk

Sdk getSdk()

Returns the SDK used by the module.

Returns:

either module-specific or inherited SDK

See Also:

isSdkInherited()

isSdkInherited

boolean isSdkInherited()

Returns true if SDK for this module is inherited from a project.

Returns:

true if the SDK is inherited, false otherwise

See Also:

ProjectRootManager.getProjectSdk(), ProjectRootManager.setProjectSdk(Sdk)

getContentRoots

VirtualFile [] getContentRoots()

Returns an array of content roots from all content entries.

Returns:

the array of content roots.

See Also:

getContentEntries()

getContentRootUrls

java.lang.String [] getContentRootUrls()

Returns an array of content root urls from all content entries.

Returns:

the array of content root URLs.

See Also:

getContentEntries()

getExcludeRoots

VirtualFile [] getExcludeRoots()

Returns an array of exclude roots from all content entries.

Returns:

the array of excluded roots.

See Also:

getContentEntries()

getExcludeRootUrls

java.lang.String [] getExcludeRootUrls()

Returns an array of exclude root urls from all content entries.

Returns:

the array of excluded root URLs.

See Also:

getContentEntries()

getSourceRoots

VirtualFile [] getSourceRoots()

Returns an array of source roots from all content entries.

Returns:

the array of source roots.

See Also:

getContentEntries(), getSourceRoots(boolean)

getSourceRoots

VirtualFile [] getSourceRoots(boolean includingTests)

Returns an array of source roots from all content entries.

Parameters:

includingTests - determines whether test source roots should be included in the result

Returns:

the array of source roots.

See Also:

getContentEntries()

getSourceRoots

java.util.List<VirtualFile> getSourceRoots(JpsModuleSourceRootType<?> rootType)

Return a list of source roots of the specified type.

Parameters:

rootType - type of source roots

Returns:

list of source roots

getSourceRoots

java.util.List<VirtualFile> getSourceRoots(java.util.Set<? extends JpsModuleSourceRootType<?>> rootTypes)

Return a list of source roots which types belong to the specified set.

Parameters:

rootTypes - types of source roots

Returns:

list of source roots

getSourceRootUrls

java.lang.String [] getSourceRootUrls()

Returns an array of source root urls from all content entries.

Returns:

the array of source root URLs.

See Also:

getContentEntries(), getSourceRootUrls(boolean)

getSourceRootUrls

java.lang.String [] getSourceRootUrls(boolean includingTests)

Returns an array of source root urls from all content entries.

Parameters:

includingTests - determines whether test source root urls should be included in the result

Returns:

the array of source root URLs.

See Also:

getContentEntries()

processOrder

<R> R processOrder(RootPolicy<R> policy,
                   R initialValue)

Passes all order entries in the module to the specified visitor.

Parameters:

policy - the visitor to accept.

initialValue - the default value to be returned by the visit process.

Returns:

the value returned by the visitor.

See Also:

OrderEntry.accept(RootPolicy, Object)

orderEntries

OrderEnumerator orderEntries()

Returns OrderEnumerator instance which can be used to process order entries of the module (with or without dependencies) and collect classes or source roots.

Returns:

OrderEnumerator instance

getDependencyModuleNames

java.lang.String [] getDependencyModuleNames()

Returns list of module names this module depends on.

Returns:

the list of module names this module depends on.

getModuleExtension

<T> T getModuleExtension(java.lang.Class<T> klass)

getModuleDependencies

Module [] getModuleDependencies()

getModuleDependencies

Module [] getModuleDependencies(boolean includeTests)