Package com.intellij.openapi.roots.impl

Class RootModelImpl

java.lang.Object

com.intellij.openapi.roots.impl.RootModelBase

com.intellij.openapi.roots.impl.RootModelImpl

All Implemented Interfaces:

ModifiableRootModel, ModuleRootModel

public class RootModelImpl
extends RootModelBase
implements ModifiableRootModel

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 file) 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 entry) 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)
protected java.util.Set<ContentEntry>	getContent()
Module	getModule() Returns the module to which the model belongs.
<T> T	getModuleExtension(java.lang.Class<T> klass)
LibraryTable	getModuleLibraryTable() Returns library table with module libraries.
OrderEntry []	getOrderEntries() Use this method to obtain order of roots of a module.
Project	getProject()
VirtualFilePointerListener	getRootsChangedListener()
java.lang.String	getSdkName()
void	inheritSdk() Makes this module inheriting SDK from its project.
boolean	isChanged()
boolean	isDisposed()
boolean	isWritable()
void	rearrangeOrderEntries(OrderEntry [] newEntries)
void	removeContentEntry(ContentEntry entry) Remove the specified content root.
void	removeOrderEntry(OrderEntry entry) Removes order entry from an order.
<T extends OrderEntry> void	replaceEntryOfType(java.lang.Class<T> entryClass, T entry)
void	setInvalidSdk(java.lang.String jdkName, java.lang.String jdkType) Sets JDK name and type for this module.
void	setSdk(Sdk jdk) Sets SDK for this module to a specific value.
java.lang.String	toString()
void	writeExternal(Element element)

Methods inherited from class com.intellij.openapi.roots.impl.RootModelBase

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

Methods inherited from class java.lang.Object

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

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

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

Method Detail

isWritable

public boolean isWritable()

Specified by:

isWritable in interface ModifiableRootModel

getOrderEntries

public OrderEntry [] getOrderEntries()

Description copied from interface: ModuleRootModel

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

Specified by:

getOrderEntries in interface ModuleRootModel

Returns:

list of order entries for this module

removeContentEntry

public void removeContentEntry(ContentEntry entry)

Description copied from interface: ModifiableRootModel

Remove the specified content root.

Specified by:

removeContentEntry in interface ModifiableRootModel

Parameters:

entry - the content root to remove.

addOrderEntry

public void addOrderEntry(OrderEntry entry)

Description copied from interface: ModifiableRootModel

Appends an order entry to the classpath.

Specified by:

addOrderEntry in interface ModifiableRootModel

Parameters:

entry - the order entry to add.

addLibraryEntry

public LibraryOrderEntry addLibraryEntry(Library library)

Description copied from interface: ModifiableRootModel

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

Specified by:

addLibraryEntry in interface ModifiableRootModel

Parameters:

library - the library for which the entry is created.

Returns:

newly created order entry for the library

addInvalidLibrary

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

Description copied from interface: ModifiableRootModel

Adds an entry for invalid library.

Specified by:

addInvalidLibrary in interface ModifiableRootModel

addModuleOrderEntry

public ModuleOrderEntry addModuleOrderEntry(Module module)

Specified by:

addModuleOrderEntry in interface ModifiableRootModel

addInvalidModuleEntry

public ModuleOrderEntry addInvalidModuleEntry(java.lang.String name)

Specified by:

addInvalidModuleEntry in interface ModifiableRootModel

findModuleOrderEntry

public ModuleOrderEntry findModuleOrderEntry(Module module)

Specified by:

findModuleOrderEntry in interface ModifiableRootModel

findLibraryOrderEntry

public LibraryOrderEntry findLibraryOrderEntry(Library library)

Specified by:

findLibraryOrderEntry in interface ModifiableRootModel

removeOrderEntry

public void removeOrderEntry(OrderEntry entry)

Description copied from interface: ModifiableRootModel

Removes order entry from an order.

Specified by:

removeOrderEntry in interface ModifiableRootModel

rearrangeOrderEntries

public void rearrangeOrderEntries(OrderEntry [] newEntries)

Specified by:

rearrangeOrderEntries in interface ModifiableRootModel

clear

public void clear()

Specified by:

clear in interface ModifiableRootModel

commit

public void commit()

Description copied from interface: ModifiableRootModel

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.

Specified by:

commit in interface ModifiableRootModel

getModuleLibraryTable

public LibraryTable getModuleLibraryTable()

Description copied from interface: ModifiableRootModel

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.

Specified by:

getModuleLibraryTable in interface ModifiableRootModel

Returns:

library table to be modified

getProject

public Project getProject()

Specified by:

getProject in interface ModifiableRootModel

addContentEntry

public ContentEntry addContentEntry(VirtualFile file)

Description copied from interface: ModifiableRootModel

Adds the specified file or directory as a content root.

Specified by:

addContentEntry in interface ModifiableRootModel

Parameters:

file - root of a content

Returns:

new content entry

addContentEntry

public ContentEntry addContentEntry(java.lang.String url)

Description copied from interface: ModifiableRootModel

Adds the specified file or directory as a content root.

Specified by:

addContentEntry in interface ModifiableRootModel

Parameters:

url - root of a content

Returns:

new content entry

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface ModifiableRootModel

writeExternal

public void writeExternal(Element element)

setSdk

public void setSdk(Sdk jdk)

Description copied from interface: ModifiableRootModel

Sets SDK for this module to a specific value.

Specified by:

setSdk in interface ModifiableRootModel

setInvalidSdk

public void setInvalidSdk(java.lang.String jdkName,
                          java.lang.String jdkType)

Description copied from interface: ModifiableRootModel

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).

Specified by:

setInvalidSdk in interface ModifiableRootModel

Parameters:

jdkName - SDK name

jdkType - SDK type

inheritSdk

public void inheritSdk()

Description copied from interface: ModifiableRootModel

Makes this module inheriting SDK from its project.

Specified by:

inheritSdk in interface ModifiableRootModel

replaceEntryOfType

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

Specified by:

replaceEntryOfType in interface ModifiableRootModel

getSdkName

public java.lang.String getSdkName()

Specified by:

getSdkName in interface ModifiableRootModel

getContent

protected java.util.Set<ContentEntry> getContent()

Specified by:

getContent in class RootModelBase

getModule

public Module getModule()

Description copied from interface: ModuleRootModel

Returns the module to which the model belongs.

Specified by:

getModule in interface ModuleRootModel

Returns:

the module instance.

isChanged

public boolean isChanged()

Specified by:

isChanged in interface ModifiableRootModel

dispose

public void dispose()

Description copied from interface: ModifiableRootModel

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

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

Specified by:

dispose in interface ModifiableRootModel

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getModuleExtension

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

Specified by:

getModuleExtension in interface ModuleRootModel

getRootsChangedListener

public VirtualFilePointerListener getRootsChangedListener()