Package com.intellij.openapi.roots

Interface ModifiableRootModel

All Superinterfaces:

ModuleRootModel

All Known Implementing Classes:

RootModelImpl

public interface ModifiableRootModel
extends ModuleRootModel

Model of roots that should be used by clients to modify module roots.

Invoke commit() to persist changes, see also ModuleRootModificationUtil.

See Also:

ModuleRootManager.getModifiableModel(), ModuleRootModificationUtil

Method Summary

Modifier and Type	Method and Description
ContentEntry	addContentEntry(java.lang.String url) Adds the specified file or directory as a content root.
ContentEntry	addContentEntry(VirtualFile root) Adds the specified file or directory as a content root.
LibraryOrderEntry	addInvalidLibrary(java.lang.String name, java.lang.String level) Adds an entry for invalid library.
ModuleOrderEntry	addInvalidModuleEntry(java.lang.String name)
LibraryOrderEntry	addLibraryEntry(Library library) Creates an entry for a given library and adds it to order.
ModuleOrderEntry	addModuleOrderEntry(Module module)
void	addOrderEntry(OrderEntry orderEntry) Appends an order entry to the classpath.
void	clear()
void	commit() Commits changes to a ModuleRootManager.
void	dispose() Must be invoked for uncommitted models that are no longer needed.
LibraryOrderEntry	findLibraryOrderEntry(Library library)
ModuleOrderEntry	findModuleOrderEntry(Module module)
LibraryTable	getModuleLibraryTable() Returns library table with module libraries.
Project	getProject()
java.lang.String	getSdkName()
void	inheritSdk() Makes this module inheriting SDK from its project.
boolean	isChanged()
boolean	isDisposed()
boolean	isWritable()
void	rearrangeOrderEntries(OrderEntry [] newOrder)
void	removeContentEntry(ContentEntry entry) Remove the specified content root.
void	removeOrderEntry(OrderEntry orderEntry) Removes order entry from an order.
<T extends OrderEntry> void	replaceEntryOfType(java.lang.Class<T> entryClass, T entry)
void	setInvalidSdk(java.lang.String sdkName, java.lang.String sdkType) Sets JDK name and type for this module.
void	setSdk(Sdk sdk) Sets SDK for this module to a specific value.

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

getContentEntries, getContentRoots, getContentRootUrls, getDependencyModuleNames, getExcludeRoots, getExcludeRootUrls, getModule, getModuleDependencies, getModuleDependencies, getModuleExtension, getOrderEntries, getSdk, getSourceRoots, getSourceRoots, getSourceRoots, getSourceRoots, getSourceRootUrls, getSourceRootUrls, isSdkInherited, orderEntries, processOrder

Method Detail

getProject

Project getProject()

addContentEntry

ContentEntry addContentEntry(VirtualFile root)

Adds the specified file or directory as a content root.

Parameters:

root - root of a content

Returns:

new content entry

addContentEntry

ContentEntry addContentEntry(java.lang.String url)

Adds the specified file or directory as a content root.

Parameters:

url - root of a content

Returns:

new content entry

removeContentEntry

void removeContentEntry(ContentEntry entry)

Remove the specified content root.

Parameters:

entry - the content root to remove.

addOrderEntry

void addOrderEntry(OrderEntry orderEntry)

Appends an order entry to the classpath.

Parameters:

orderEntry - the order entry to add.

addLibraryEntry

LibraryOrderEntry addLibraryEntry(Library library)

Creates an entry for a given library and adds it to order.

Parameters:

library - the library for which the entry is created.

Returns:

newly created order entry for the library

addInvalidLibrary

LibraryOrderEntry addInvalidLibrary(java.lang.String name,
                                    java.lang.String level)

Adds an entry for invalid library.

addModuleOrderEntry

ModuleOrderEntry addModuleOrderEntry(Module module)

addInvalidModuleEntry

ModuleOrderEntry addInvalidModuleEntry(java.lang.String name)

findModuleOrderEntry

ModuleOrderEntry findModuleOrderEntry(Module module)

findLibraryOrderEntry

LibraryOrderEntry findLibraryOrderEntry(Library library)

removeOrderEntry

void removeOrderEntry(OrderEntry orderEntry)

Removes order entry from an order.

rearrangeOrderEntries

void rearrangeOrderEntries(OrderEntry [] newOrder)

clear

void clear()

commit

void commit()

Commits changes to a ModuleRootManager. Should be invoked in a write action. After commit(), the model becomes read-only.

Use of ModuleRootModificationUtil.updateModel(Module, Consumer) is recommended.

dispose

void dispose()

Must be invoked for uncommitted models that are no longer needed.

Use of ModuleRootModificationUtil.updateModel(Module, Consumer) is recommended.

getModuleLibraryTable

LibraryTable getModuleLibraryTable()

Returns library table with module libraries.

Note: returned library table does not support listeners. Also, one shouldn't invoke 'commit()' or 'dispose()' methods on it, it is automatically committed or disposed along with this ModifiableRootModel instance.

Returns:

library table to be modified

setSdk

void setSdk(Sdk sdk)

Sets SDK for this module to a specific value.

setInvalidSdk

void setInvalidSdk(java.lang.String sdkName,
                   java.lang.String sdkType)

Sets JDK name and type for this module. To be used when SDK with this name and type does not exist (e.g. when importing module configuration).

Parameters:

sdkName - SDK name

sdkType - SDK type

inheritSdk

void inheritSdk()

Makes this module inheriting SDK from its project.

isChanged

boolean isChanged()

isWritable

boolean isWritable()

replaceEntryOfType

<T extends OrderEntry> void replaceEntryOfType(java.lang.Class<T> entryClass,
                                               T entry)

getSdkName

java.lang.String getSdkName()

isDisposed

boolean isDisposed()