Package com.intellij.compiler

Class CompilerManagerImpl

java.lang.Object

com.intellij.openapi.compiler.CompilerManager

com.intellij.compiler.CompilerManagerImpl

public class CompilerManagerImpl
extends CompilerManager

Field Summary

Fields inherited from class com.intellij.openapi.compiler.CompilerManager

NOTIFICATION_GROUP, RUN_CONFIGURATION_KEY, RUN_CONFIGURATION_TYPE_ID_KEY

Constructor Summary

Constructors

Constructor and Description
CompilerManagerImpl(Project project)
CompilerManagerImpl(Project project, MessageBus messageBus) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addAfterTask(CompileTask task) Registers a compiler task that will be executed after the compilation.
void	addBeforeTask(CompileTask task) Registers a compiler task that will be executed before the compilation.
void	addCompilableFileType(FileType type) Registers the type as a compilable type so that Compile action will be enabled on files of this type.
void	addCompilationStatusListener(CompilationStatusListener listener)
void	addCompilationStatusListener(CompilationStatusListener listener, Disposable parentDisposable)
void	addCompiler(Compiler compiler) Registers a custom compiler.
void	addTranslatingCompiler(TranslatingCompiler compiler, java.util.Set<FileType> inputTypes, java.util.Set<FileType> outputTypes) Deprecated.
boolean	awaitNettyThreadPoolTermination(long time, java.util.concurrent.TimeUnit unit)
void	compile(CompileScope scope, CompileStatusNotification callback) Compile all files from the scope given.
void	compile(Module module, CompileStatusNotification callback) Compile all sources (including test sources) from the module.
void	compile(VirtualFile [] files, CompileStatusNotification callback) Compile a set of files.
java.util.Collection<ClassObject>	compileJavaCode(java.util.List<java.lang.String> options, java.util.Collection<? extends java.io.File> platformCp, java.util.Collection<? extends java.io.File> classpath, java.util.Collection<? extends java.io.File> upgradeModulePath, java.util.Collection<? extends java.io.File> modulePath, java.util.Collection<? extends java.io.File> sourcePath, java.util.Collection<? extends java.io.File> files, java.io.File outputDir)
CompileScope	createFilesCompileScope(VirtualFile [] files)
CompileScope	createModuleCompileScope(Module module, boolean includeDependentModules)
CompileScope	createModuleGroupCompileScope(Project project, Module [] modules, boolean includeDependentModules)
CompileScope	createModulesCompileScope(Module [] modules, boolean includeDependentModules)
CompileScope	createModulesCompileScope(Module [] modules, boolean includeDependentModules, boolean includeRuntimeDependencies)
CompileScope	createProjectCompileScope(Project project)
void	executeTask(CompileTask task, CompileScope scope, java.lang.String contentName, java.lang.Runnable onTaskFinished) Execute a custom compile task.
java.util.List<CompileTask>	getAfterTaskList() Returns the list of all tasks to be executed after compilation.
java.util.List<CompileTask>	getBeforeTasks() Returns the list of all tasks to be executed before compilation.
java.util.concurrent.Semaphore	getCompilationSemaphore()
<T extends Compiler> T []	getCompilers(java.lang.Class<T> compilerClass) Returns all registered compilers of the specified class.
java.io.File	getJavacCompilerWorkingDir()
boolean	isCompilableFileType(FileType type) Checks if files of the specified type can be compiled by one of registered compilers.
boolean	isCompilationActive()
boolean	isExcludedFromCompilation(VirtualFile file) Checks if the specified file is excluded from compilation.
boolean	isUpToDate(CompileScope scope) Checks if compile scope given is up-to-date
boolean	isValidationEnabled(Module module)
void	make(CompileScope scope, CompileStatusNotification callback) Compile all modified files and all files that depend on them from the scope given.
void	make(CompileStatusNotification callback) Compile all modified files and all files that depend on them all over the project.
void	make(Module module, CompileStatusNotification callback) Compile all modified files and all files that depend on them from the given module and all modules this module depends on recursively.
void	make(Project project, Module [] modules, CompileStatusNotification callback) Compile all modified files and all files that depend on them from the modules and all modules these modules depend on recursively.
void	makeWithModalProgress(CompileScope scope, CompileStatusNotification callback) Same as CompilerManager.make(CompileScope, CompileStatusNotification) but with modal progress window instead of background progress
void	rebuild(CompileStatusNotification callback) Rebuild the whole project from scratch.
void	removeCompilableFileType(FileType type) Unregisters the type as a compilable type so that Compile action will be disabled on files of this type.
void	removeCompilationStatusListener(CompilationStatusListener listener)
void	removeCompiler(Compiler compiler) Unregisters a custom compiler.
void	setValidationEnabled(ModuleType<?> moduleType, boolean enabled)
boolean	waitForExternalJavacToTerminate(long time, java.util.concurrent.TimeUnit unit)

Methods inherited from class com.intellij.openapi.compiler.CompilerManager

getAfterTasks, getInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

CompilerManagerImpl

@Deprecated
public CompilerManagerImpl(Project project,
                           MessageBus messageBus)

Deprecated.

CompilerManagerImpl

public CompilerManagerImpl(Project project)

Method Detail

waitForExternalJavacToTerminate

public boolean waitForExternalJavacToTerminate(long time,
                                               java.util.concurrent.TimeUnit unit)

awaitNettyThreadPoolTermination

public boolean awaitNettyThreadPoolTermination(long time,
                                               java.util.concurrent.TimeUnit unit)

getCompilationSemaphore

public java.util.concurrent.Semaphore getCompilationSemaphore()

isCompilationActive

public boolean isCompilationActive()

Specified by:

isCompilationActive in class CompilerManager

addCompiler

public final void addCompiler(Compiler compiler)

Description copied from class: CompilerManager

Registers a custom compiler.

Specified by:

addCompiler in class CompilerManager

addTranslatingCompiler

@Deprecated
public void addTranslatingCompiler(TranslatingCompiler compiler,
                                   java.util.Set<FileType> inputTypes,
                                   java.util.Set<FileType> outputTypes)

Deprecated.

Description copied from class: CompilerManager

Registers a custom translating compiler. Input and output filetype sets allow compiler manager to sort translating compilers so that output of one compiler will be used as input for another one

Specified by:

addTranslatingCompiler in class CompilerManager

Parameters:

compiler - compiler implementation

inputTypes - a set of filetypes that compiler accepts as input

outputTypes - a set of filetypes that compiler can generate

removeCompiler

public final void removeCompiler(Compiler compiler)

Description copied from class: CompilerManager

Unregisters a custom compiler.

Specified by:

removeCompiler in class CompilerManager

getCompilers

public <T extends Compiler> T [] getCompilers(java.lang.Class<T> compilerClass)

Description copied from class: CompilerManager

Returns all registered compilers of the specified class.

Specified by:

getCompilers in class CompilerManager

Parameters:

compilerClass - the class for which the compilers should be returned.

Returns:

all registered compilers of the specified class.

addCompilableFileType

public void addCompilableFileType(FileType type)

Description copied from class: CompilerManager

Registers the type as a compilable type so that Compile action will be enabled on files of this type.

Specified by:

addCompilableFileType in class CompilerManager

Parameters:

type - the type for which the Compile action is enabled.

removeCompilableFileType

public void removeCompilableFileType(FileType type)

Description copied from class: CompilerManager

Unregisters the type as a compilable type so that Compile action will be disabled on files of this type.

Specified by:

removeCompilableFileType in class CompilerManager

Parameters:

type - the type for which the Compile action is disabled.

isCompilableFileType

public boolean isCompilableFileType(FileType type)

Description copied from class: CompilerManager

Checks if files of the specified type can be compiled by one of registered compilers. If the compiler can process files of certain type, it should register this file type within the CompilerManager as a compilable file type.

Specified by:

isCompilableFileType in class CompilerManager

Parameters:

type - the type to check.

Returns:

true if the file type is compilable, false otherwise.

See Also:

CompilerManager.addCompilableFileType(FileType)

addBeforeTask

public final void addBeforeTask(CompileTask task)

Description copied from class: CompilerManager

Registers a compiler task that will be executed before the compilation. Consider using compiler.task extension point instead (see CompileTask for details), this way you won't need to call this method during project's initialization.

Specified by:

addBeforeTask in class CompilerManager

addAfterTask

public final void addAfterTask(CompileTask task)

Description copied from class: CompilerManager

Registers a compiler task that will be executed after the compilation.

Specified by:

addAfterTask in class CompilerManager

getBeforeTasks

public java.util.List<CompileTask> getBeforeTasks()

Description copied from class: CompilerManager

Returns the list of all tasks to be executed before compilation.

Specified by:

getBeforeTasks in class CompilerManager

Returns:

all tasks to be executed before compilation.

getAfterTaskList

public java.util.List<CompileTask> getAfterTaskList()

Description copied from class: CompilerManager

Returns the list of all tasks to be executed after compilation.

Specified by:

getAfterTaskList in class CompilerManager

Returns:

all tasks to be executed after compilation.

compile

public void compile(VirtualFile [] files,
                    CompileStatusNotification callback)

Description copied from class: CompilerManager

Compile a set of files.

Specified by:

compile in class CompilerManager

Parameters:

files - a list of files to compile. If a VirtualFile is a directory, all containing files are processed. Compiler excludes are not honored.

callback - a notification callback, or null if no notifications needed.

compile

public void compile(Module module,
                    CompileStatusNotification callback)

Description copied from class: CompilerManager

Compile all sources (including test sources) from the module. Compiler excludes are not honored.

Specified by:

compile in class CompilerManager

Parameters:

module - a module which sources are to be compiled

callback - a notification callback, or null if no notifications needed

compile

public void compile(CompileScope scope,
                    CompileStatusNotification callback)

Description copied from class: CompilerManager

Compile all files from the scope given. Compiler excludes are not honored.

Specified by:

compile in class CompilerManager

Parameters:

scope - a scope to be compiled

callback - a notification callback, or null if no notifications needed

make

public void make(CompileStatusNotification callback)

Description copied from class: CompilerManager

Compile all modified files and all files that depend on them all over the project. Files are compiled according to dependencies between the modules they belong to. Compiler excludes are honored.

Specified by:

make in class CompilerManager

Parameters:

callback - a notification callback, or null if no notifications needed

make

public void make(Module module,
                 CompileStatusNotification callback)

Description copied from class: CompilerManager

Compile all modified files and all files that depend on them from the given module and all modules this module depends on recursively. Files are compiled according to dependencies between the modules they belong to. Compiler excludes are honored.

Specified by:

make in class CompilerManager

Parameters:

module - a module which sources are to be compiled.

callback - a notification callback, or null if no notifications needed.

make

public void make(Project project,
                 Module [] modules,
                 CompileStatusNotification callback)

Description copied from class: CompilerManager

Compile all modified files and all files that depend on them from the modules and all modules these modules depend on recursively. Files are compiled according to dependencies between the modules they belong to. Compiler excludes are honored. All modules must belong to the same project.

Specified by:

make in class CompilerManager

Parameters:

project - a project modules belong to

modules - modules to compile

callback - a notification callback, or null if no notifications needed.

make

public void make(CompileScope scope,
                 CompileStatusNotification callback)

Description copied from class: CompilerManager

Compile all modified files and all files that depend on them from the scope given. Files are compiled according to dependencies between the modules they belong to. Compiler excludes are honored. All modules must belong to the same project

Specified by:

make in class CompilerManager

Parameters:

scope - a scope to be compiled

callback - a notification callback, or null if no notifications needed

makeWithModalProgress

public void makeWithModalProgress(CompileScope scope,
                                  CompileStatusNotification callback)

Description copied from class: CompilerManager

Same as CompilerManager.make(CompileScope, CompileStatusNotification) but with modal progress window instead of background progress

Specified by:

makeWithModalProgress in class CompilerManager

isUpToDate

public boolean isUpToDate(CompileScope scope)

Description copied from class: CompilerManager

Checks if compile scope given is up-to-date

Specified by:

isUpToDate in class CompilerManager

Returns:

true if make on the scope specified wouldn't do anything or false if something is to be compiled or deleted

rebuild

public void rebuild(CompileStatusNotification callback)

Description copied from class: CompilerManager

Rebuild the whole project from scratch. Compiler excludes are honored.

Specified by:

rebuild in class CompilerManager

Parameters:

callback - a notification callback, or null if no notifications needed

executeTask

public void executeTask(CompileTask task,
                        CompileScope scope,
                        java.lang.String contentName,
                        java.lang.Runnable onTaskFinished)

Description copied from class: CompilerManager

Execute a custom compile task.

Specified by:

executeTask in class CompilerManager

Parameters:

task - the task to execute.

scope - compile scope for which the task is executed.

contentName - the name of a tab in message view where the execution results will be displayed.

onTaskFinished - a runnable to be executed when the task finishes, null if nothing should be executed.

addCompilationStatusListener

public void addCompilationStatusListener(CompilationStatusListener listener)

Specified by:

addCompilationStatusListener in class CompilerManager

addCompilationStatusListener

public void addCompilationStatusListener(CompilationStatusListener listener,
                                         Disposable parentDisposable)

Specified by:

addCompilationStatusListener in class CompilerManager

removeCompilationStatusListener

public void removeCompilationStatusListener(CompilationStatusListener listener)

Specified by:

removeCompilationStatusListener in class CompilerManager

isExcludedFromCompilation

public boolean isExcludedFromCompilation(VirtualFile file)

Description copied from class: CompilerManager

Checks if the specified file is excluded from compilation.

Specified by:

isExcludedFromCompilation in class CompilerManager

Parameters:

file - the file to check.

Returns:

true if the file is excluded from compilation, false otherwise

createFilesCompileScope

public CompileScope createFilesCompileScope(VirtualFile [] files)

Specified by:

createFilesCompileScope in class CompilerManager

createModuleCompileScope

public CompileScope createModuleCompileScope(Module module,
                                             boolean includeDependentModules)

Specified by:

createModuleCompileScope in class CompilerManager

createModulesCompileScope

public CompileScope createModulesCompileScope(Module [] modules,
                                              boolean includeDependentModules)

Specified by:

createModulesCompileScope in class CompilerManager

createModulesCompileScope

public CompileScope createModulesCompileScope(Module [] modules,
                                              boolean includeDependentModules,
                                              boolean includeRuntimeDependencies)

Specified by:

createModulesCompileScope in class CompilerManager

createModuleGroupCompileScope

public CompileScope createModuleGroupCompileScope(Project project,
                                                  Module [] modules,
                                                  boolean includeDependentModules)

Specified by:

createModuleGroupCompileScope in class CompilerManager

createProjectCompileScope

public CompileScope createProjectCompileScope(Project project)

Specified by:

createProjectCompileScope in class CompilerManager

setValidationEnabled

public void setValidationEnabled(ModuleType<?> moduleType,
                                 boolean enabled)

Specified by:

setValidationEnabled in class CompilerManager

isValidationEnabled

public boolean isValidationEnabled(Module module)

Specified by:

isValidationEnabled in class CompilerManager

compileJavaCode

public java.util.Collection<ClassObject> compileJavaCode(java.util.List<java.lang.String> options,
                                                         java.util.Collection<? extends java.io.File> platformCp,
                                                         java.util.Collection<? extends java.io.File> classpath,
                                                         java.util.Collection<? extends java.io.File> upgradeModulePath,
                                                         java.util.Collection<? extends java.io.File> modulePath,
                                                         java.util.Collection<? extends java.io.File> sourcePath,
                                                         java.util.Collection<? extends java.io.File> files,
                                                         java.io.File outputDir)
                                                  throws java.io.IOException,
                                                         CompilationException

Specified by:

compileJavaCode in class CompilerManager

Throws:

java.io.IOException

CompilationException

getJavacCompilerWorkingDir

public java.io.File getJavacCompilerWorkingDir()

Specified by:

getJavacCompilerWorkingDir in class CompilerManager