Package com.intellij.openapi.roots.impl

Class RootModelBase

java.lang.Object

com.intellij.openapi.roots.impl.RootModelBase

All Implemented Interfaces:

ModuleRootModel

Direct Known Subclasses:

JpsRootModel, RootModelImpl

public abstract class RootModelBase
extends java.lang.Object
implements ModuleRootModel

Constructor Summary

Constructors

Constructor and Description
RootModelBase()

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.Collection<ContentEntry>	getContent()
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 []	getModuleDependencies()
Module []	getModuleDependencies(boolean includeTests)
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.roots.ModuleRootModel

getModule, getModuleExtension, getOrderEntries

Constructor Detail

RootModelBase

public RootModelBase()

Method Detail

getContentRoots

public VirtualFile [] getContentRoots()

Description copied from interface: ModuleRootModel

Returns an array of content roots from all content entries.

Specified by:

getContentRoots in interface ModuleRootModel

Returns:

the array of content roots.

See Also:

ModuleRootModel.getContentEntries()

getContentRootUrls

public java.lang.String [] getContentRootUrls()

Description copied from interface: ModuleRootModel

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

Specified by:

getContentRootUrls in interface ModuleRootModel

Returns:

the array of content root URLs.

See Also:

ModuleRootModel.getContentEntries()

getExcludeRootUrls

public java.lang.String [] getExcludeRootUrls()

Description copied from interface: ModuleRootModel

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

Specified by:

getExcludeRootUrls in interface ModuleRootModel

Returns:

the array of excluded root URLs.

See Also:

ModuleRootModel.getContentEntries()

getExcludeRoots

public VirtualFile [] getExcludeRoots()

Description copied from interface: ModuleRootModel

Returns an array of exclude roots from all content entries.

Specified by:

getExcludeRoots in interface ModuleRootModel

Returns:

the array of excluded roots.

See Also:

ModuleRootModel.getContentEntries()

getSourceRootUrls

public java.lang.String [] getSourceRootUrls()

Description copied from interface: ModuleRootModel

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

Specified by:

getSourceRootUrls in interface ModuleRootModel

Returns:

the array of source root URLs.

See Also:

ModuleRootModel.getContentEntries(), ModuleRootModel.getSourceRootUrls(boolean)

getSourceRootUrls

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

Description copied from interface: ModuleRootModel

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

Specified by:

getSourceRootUrls in interface ModuleRootModel

Parameters:

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

Returns:

the array of source root URLs.

See Also:

ModuleRootModel.getContentEntries()

getSourceRoots

public VirtualFile [] getSourceRoots()

Description copied from interface: ModuleRootModel

Returns an array of source roots from all content entries.

Specified by:

getSourceRoots in interface ModuleRootModel

Returns:

the array of source roots.

See Also:

ModuleRootModel.getContentEntries(), ModuleRootModel.getSourceRoots(boolean)

getSourceRoots

public VirtualFile [] getSourceRoots(boolean includingTests)

Description copied from interface: ModuleRootModel

Returns an array of source roots from all content entries.

Specified by:

getSourceRoots in interface ModuleRootModel

Parameters:

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

Returns:

the array of source roots.

See Also:

ModuleRootModel.getContentEntries()

getSourceRoots

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

Description copied from interface: ModuleRootModel

Return a list of source roots of the specified type.

Specified by:

getSourceRoots in interface ModuleRootModel

Parameters:

rootType - type of source roots

Returns:

list of source roots

getSourceRoots

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

Description copied from interface: ModuleRootModel

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

Specified by:

getSourceRoots in interface ModuleRootModel

Parameters:

rootTypes - types of source roots

Returns:

list of source roots

getContentEntries

public ContentEntry [] getContentEntries()

Description copied from interface: ModuleRootModel

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

Specified by:

getContentEntries in interface ModuleRootModel

Returns:

list of content entries for this module

See Also:

ContentEntry

getContent

protected abstract java.util.Collection<ContentEntry> getContent()

getSdk

public Sdk getSdk()

Description copied from interface: ModuleRootModel

Returns the SDK used by the module.

Specified by:

getSdk in interface ModuleRootModel

Returns:

either module-specific or inherited SDK

See Also:

ModuleRootModel.isSdkInherited()

isSdkInherited

public boolean isSdkInherited()

Description copied from interface: ModuleRootModel

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

Specified by:

isSdkInherited in interface ModuleRootModel

Returns:

true if the SDK is inherited, false otherwise

See Also:

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

orderEntries

public OrderEnumerator orderEntries()

Description copied from interface: ModuleRootModel

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

Specified by:

orderEntries in interface ModuleRootModel

Returns:

OrderEnumerator instance

processOrder

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

Description copied from interface: ModuleRootModel

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

Specified by:

processOrder in interface ModuleRootModel

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)

getDependencyModuleNames

public java.lang.String [] getDependencyModuleNames()

Description copied from interface: ModuleRootModel

Returns list of module names this module depends on.

Specified by:

getDependencyModuleNames in interface ModuleRootModel

Returns:

the list of module names this module depends on.

getModuleDependencies

public Module [] getModuleDependencies()

Specified by:

getModuleDependencies in interface ModuleRootModel

getModuleDependencies

public Module [] getModuleDependencies(boolean includeTests)

Specified by:

getModuleDependencies in interface ModuleRootModel