Package com.intellij.openapi.roots.impl

Class CompilerModuleExtensionImpl

java.lang.Object

com.intellij.openapi.roots.ModuleExtension

com.intellij.openapi.roots.CompilerModuleExtension

com.intellij.openapi.roots.impl.CompilerModuleExtensionImpl

All Implemented Interfaces:

Disposable

public class CompilerModuleExtensionImpl
extends CompilerModuleExtension

Nested Class Summary

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

Disposable.Parent

Field Summary

Fields inherited from class com.intellij.openapi.roots.CompilerModuleExtension

PRODUCTION, TEST

Fields inherited from class com.intellij.openapi.roots.ModuleExtension

EP_NAME

Constructor Summary

Constructors

Constructor and Description
CompilerModuleExtensionImpl(Module module)

Method Summary

Modifier and Type	Method and Description
void	commit()
void	dispose() Usually not invoked directly, see class javadoc.
VirtualFilePointer	getCompilerOutputForTestsPointer()
VirtualFile	getCompilerOutputPath() Returns a compiler output path for production sources of the module, if it is valid.
VirtualFile	getCompilerOutputPathForTests() Returns a compiler output path for test sources of the module, if it is valid.
VirtualFilePointer	getCompilerOutputPointer()
java.lang.String	getCompilerOutputUrl() Returns a compiler output path URL for production sources of the module.
java.lang.String	getCompilerOutputUrlForTests() Returns a compiler output path URL for test sources of the module.
CompilerModuleExtension	getModifiableModel(boolean writable) Note: don't call this method directly from client code.
Module	getModule()
VirtualFile []	getOutputRoots(boolean includeTests)
java.lang.String []	getOutputRootUrls(boolean includeTests)
Project	getProject()
void	inheritCompilerOutputPath(boolean inherit) Makes this module inheriting compiler output from its project
boolean	isChanged()
boolean	isCompilerOutputPathInherited() Returns true if compiler output for this module is inherited from a project
boolean	isExcludeOutput()
void	readExternal(Element element)
void	setCompilerOutputPath(java.lang.String url)
void	setCompilerOutputPath(VirtualFile file)
void	setCompilerOutputPathForTests(java.lang.String url)
void	setCompilerOutputPathForTests(VirtualFile file)
void	setExcludeOutput(boolean exclude)
void	writeExternal(Element element)

Methods inherited from class com.intellij.openapi.roots.CompilerModuleExtension

getInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

CompilerModuleExtensionImpl

public CompilerModuleExtensionImpl(Module module)

Method Detail

readExternal

public void readExternal(Element element)

Overrides:

readExternal in class ModuleExtension

writeExternal

public void writeExternal(Element element)

Overrides:

writeExternal in class ModuleExtension

getCompilerOutputPath

public VirtualFile getCompilerOutputPath()

Description copied from class: CompilerModuleExtension

Returns a compiler output path for production sources of the module, if it is valid.

Specified by:

getCompilerOutputPath in class CompilerModuleExtension

getCompilerOutputPathForTests

public VirtualFile getCompilerOutputPathForTests()

Description copied from class: CompilerModuleExtension

Returns a compiler output path for test sources of the module, if it is valid.

Specified by:

getCompilerOutputPathForTests in class CompilerModuleExtension

getCompilerOutputUrl

public java.lang.String getCompilerOutputUrl()

Description copied from class: CompilerModuleExtension

Returns a compiler output path URL for production sources of the module.

Specified by:

getCompilerOutputUrl in class CompilerModuleExtension

getCompilerOutputUrlForTests

public java.lang.String getCompilerOutputUrlForTests()

Description copied from class: CompilerModuleExtension

Returns a compiler output path URL for test sources of the module.

Specified by:

getCompilerOutputUrlForTests in class CompilerModuleExtension

setCompilerOutputPath

public void setCompilerOutputPath(VirtualFile file)

Specified by:

setCompilerOutputPath in class CompilerModuleExtension

setCompilerOutputPath

public void setCompilerOutputPath(java.lang.String url)

Specified by:

setCompilerOutputPath in class CompilerModuleExtension

setCompilerOutputPathForTests

public void setCompilerOutputPathForTests(VirtualFile file)

Specified by:

setCompilerOutputPathForTests in class CompilerModuleExtension

setCompilerOutputPathForTests

public void setCompilerOutputPathForTests(java.lang.String url)

Specified by:

setCompilerOutputPathForTests in class CompilerModuleExtension

getModule

public Module getModule()

getProject

public Project getProject()

inheritCompilerOutputPath

public void inheritCompilerOutputPath(boolean inherit)

Description copied from class: CompilerModuleExtension

Makes this module inheriting compiler output from its project

Specified by:

inheritCompilerOutputPath in class CompilerModuleExtension

Parameters:

inherit - whether or not compiler output is inherited

isCompilerOutputPathInherited

public boolean isCompilerOutputPathInherited()

Description copied from class: CompilerModuleExtension

Returns true if compiler output for this module is inherited from a project

Specified by:

isCompilerOutputPathInherited in class CompilerModuleExtension

getCompilerOutputPointer

public VirtualFilePointer getCompilerOutputPointer()

Specified by:

getCompilerOutputPointer in class CompilerModuleExtension

getCompilerOutputForTestsPointer

public VirtualFilePointer getCompilerOutputForTestsPointer()

Specified by:

getCompilerOutputForTestsPointer in class CompilerModuleExtension

setExcludeOutput

public void setExcludeOutput(boolean exclude)

Specified by:

setExcludeOutput in class CompilerModuleExtension

isExcludeOutput

public boolean isExcludeOutput()

Specified by:

isExcludeOutput in class CompilerModuleExtension

getModifiableModel

public CompilerModuleExtension getModifiableModel(boolean writable)

Description copied from class: ModuleExtension

Note: don't call this method directly from client code. Use approach below instead:

   ModifiableRootModel modifiableModel = ModuleRootManager.getInstance(module).getModifiableModel();
   CompilerModuleExtension extension = modifiableModel.getModuleExtension(CompilerModuleExtension.class);
   try {
     // ...
   }
   finally {
     modifiableModel.commit();
   }
 

The point is that call to commit() on CompilerModuleExtension obtained like 'CompilerModuleExtension.getInstance(module).getModifiableModel(true)' doesn't dispose the model.

Call to ModifiableRootModel.commit() not only commits linked extensions but disposes them as well.

Specified by:

getModifiableModel in class ModuleExtension

Parameters:

writable - flag which identifies if resulting model is writable

Returns:

extension model

commit

public void commit()

Specified by:

commit in class ModuleExtension

isChanged

public boolean isChanged()

Specified by:

isChanged in class ModuleExtension

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

getOutputRoots

public VirtualFile [] getOutputRoots(boolean includeTests)

Specified by:

getOutputRoots in class CompilerModuleExtension

getOutputRootUrls

public java.lang.String [] getOutputRootUrls(boolean includeTests)

Specified by:

getOutputRootUrls in class CompilerModuleExtension