Package com.intellij.openapi.compiler

Class CompilerManager

java.lang.Object

com.intellij.openapi.compiler.CompilerManager

Direct Known Subclasses:

CompilerManagerImpl

public abstract class CompilerManager
extends java.lang.Object

A "root" class in compiler subsystem - allows one to register a custom compiler or a compilation task, register/unregister a compilation listener and invoke various types of compilations (make, compile, rebuild)

Field Summary

Fields

Modifier and Type	Field and Description
static NotificationGroup	NOTIFICATION_GROUP
static Key<RunConfiguration>	RUN_CONFIGURATION_KEY
static Key<java.lang.String>	RUN_CONFIGURATION_TYPE_ID_KEY

Constructor Summary

Constructors

Constructor and Description
CompilerManager()

Method Summary

Modifier and Type	Method and Description
abstract void	addAfterTask(CompileTask task) Deprecated. Use compiler.task extension point instead (see CompileTask for details).
abstract void	addBeforeTask(CompileTask task) Registers a compiler task that will be executed before the compilation.
abstract void	addCompilableFileType(FileType type) Registers the type as a compilable type so that Compile action will be enabled on files of this type.
abstract void	addCompilationStatusListener(CompilationStatusListener listener) Deprecated. Use CompilerTopics.COMPILATION_STATUS instead
abstract void	addCompilationStatusListener(CompilationStatusListener listener, Disposable parentDisposable) Deprecated. Use CompilerTopics.COMPILATION_STATUS instead
abstract void	addCompiler(Compiler compiler) Deprecated. use CompileTask extension instead
abstract void	addTranslatingCompiler(TranslatingCompiler compiler, java.util.Set<FileType> inputTypes, java.util.Set<FileType> outputTypes) Deprecated. this method is part of the obsolete build system which runs as part of the IDE process. Since IDEA 12 plugins need to integrate into 'external build system' instead (https://confluence.jetbrains.com/display/IDEADEV/External+Builder+API+and+Plugins). Since IDEA 13 users cannot switch to the old build system via UI and it will be completely removed in IDEA 14.
abstract void	compile(CompileScope scope, CompileStatusNotification callback) Compile all files from the scope given.
abstract void	compile(Module module, CompileStatusNotification callback) Compile all sources (including test sources) from the module.
abstract void	compile(VirtualFile [] files, CompileStatusNotification callback) Compile a set of files.
abstract 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)
abstract CompileScope	createFilesCompileScope(VirtualFile [] files)
abstract CompileScope	createModuleCompileScope(Module module, boolean includeDependentModules)
abstract CompileScope	createModuleGroupCompileScope(Project project, Module [] modules, boolean includeDependentModules)
abstract CompileScope	createModulesCompileScope(Module [] modules, boolean includeDependentModules)
abstract CompileScope	createModulesCompileScope(Module [] modules, boolean includeDependentModules, boolean includeRuntimeDependencies)
abstract CompileScope	createProjectCompileScope(Project project)
abstract void	executeTask(CompileTask task, CompileScope scope, java.lang.String contentName, java.lang.Runnable onTaskFinished) Execute a custom compile task.
abstract java.util.List<CompileTask>	getAfterTaskList() Returns the list of all tasks to be executed after compilation.
CompileTask []	getAfterTasks() Deprecated. Use getAfterTaskList()
abstract java.util.List<CompileTask>	getBeforeTasks() Returns the list of all tasks to be executed before compilation.
abstract <T extends Compiler> T []	getCompilers(java.lang.Class<T> compilerClass) Returns all registered compilers of the specified class.
static CompilerManager	getInstance(Project project) Returns the compiler manager instance for the specified project.
abstract java.io.File	getJavacCompilerWorkingDir()
abstract boolean	isCompilableFileType(FileType type) Checks if files of the specified type can be compiled by one of registered compilers.
abstract boolean	isCompilationActive()
abstract boolean	isExcludedFromCompilation(VirtualFile file) Checks if the specified file is excluded from compilation.
abstract boolean	isUpToDate(CompileScope scope) Checks if compile scope given is up-to-date
abstract boolean	isValidationEnabled(Module moduleType)
abstract void	make(CompileScope scope, CompileStatusNotification callback) Compile all modified files and all files that depend on them from the scope given.
abstract void	make(CompileStatusNotification callback) Compile all modified files and all files that depend on them all over the project.
abstract 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.
abstract 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.
abstract void	makeWithModalProgress(CompileScope scope, CompileStatusNotification callback) Same as make(CompileScope, CompileStatusNotification) but with modal progress window instead of background progress
abstract void	rebuild(CompileStatusNotification callback) Rebuild the whole project from scratch.
abstract void	removeCompilableFileType(FileType type) Unregisters the type as a compilable type so that Compile action will be disabled on files of this type.
abstract void	removeCompilationStatusListener(CompilationStatusListener listener) Deprecated. Use CompilerTopics.COMPILATION_STATUS instead
abstract void	removeCompiler(Compiler compiler) Deprecated. use CompileTask extension instead
abstract void	setValidationEnabled(ModuleType<?> moduleType, boolean enabled)

Methods inherited from class java.lang.Object

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

Field Detail

RUN_CONFIGURATION_KEY

public static final Key<RunConfiguration> RUN_CONFIGURATION_KEY

RUN_CONFIGURATION_TYPE_ID_KEY

public static final Key<java.lang.String> RUN_CONFIGURATION_TYPE_ID_KEY

NOTIFICATION_GROUP

public static final NotificationGroup NOTIFICATION_GROUP

Constructor Detail

CompilerManager

public CompilerManager()

Method Detail

getInstance

public static CompilerManager getInstance(Project project)

Returns the compiler manager instance for the specified project.

Parameters:

project - the project for which the manager is requested.

Returns:

the manager instance.

isCompilationActive

public abstract boolean isCompilationActive()

addCompiler

@Deprecated
public abstract void addCompiler(Compiler compiler)

Deprecated. use CompileTask extension instead

Registers a custom compiler.

addTranslatingCompiler

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

Deprecated. this method is part of the obsolete build system which runs as part of the IDE process. Since IDEA 12 plugins need to integrate into 'external build system' instead (https://confluence.jetbrains.com/display/IDEADEV/External+Builder+API+and+Plugins). Since IDEA 13 users cannot switch to the old build system via UI and it will be completely removed in IDEA 14.

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

Parameters:

compiler - compiler implementation

inputTypes - a set of filetypes that compiler accepts as input

outputTypes - a set of filetypes that compiler can generate

removeCompiler

@Deprecated
public abstract void removeCompiler(Compiler compiler)

Deprecated. use CompileTask extension instead

Unregisters a custom compiler.

getCompilers

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

Returns all registered compilers of the specified class.

Parameters:

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

Returns:

all registered compilers of the specified class.

addCompilableFileType

public abstract void addCompilableFileType(FileType type)

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

Parameters:

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

removeCompilableFileType

public abstract void removeCompilableFileType(FileType type)

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

Parameters:

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

isCompilableFileType

public abstract boolean isCompilableFileType(FileType type)

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.

Parameters:

type - the type to check.

Returns:

true if the file type is compilable, false otherwise.

See Also:

addCompilableFileType(FileType)

addBeforeTask

public abstract void addBeforeTask(CompileTask task)

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.

addAfterTask

@Deprecated
public abstract void addAfterTask(CompileTask task)

Deprecated. Use compiler.task extension point instead (see CompileTask for details).

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

getBeforeTasks

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

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

Returns:

all tasks to be executed before compilation.

getAfterTasks

@Deprecated
public CompileTask [] getAfterTasks()

Deprecated. Use getAfterTaskList()

getAfterTaskList

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

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

Returns:

all tasks to be executed after compilation.

compile

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

Compile a set of files.

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 abstract void compile(Module module,
                             CompileStatusNotification callback)

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

Parameters:

module - a module which sources are to be compiled

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

compile

public abstract void compile(CompileScope scope,
                             CompileStatusNotification callback)

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

Parameters:

scope - a scope to be compiled

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

make

public abstract void make(CompileStatusNotification callback)

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.

Parameters:

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

make

public abstract 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. Files are compiled according to dependencies between the modules they belong to. Compiler excludes are honored.

Parameters:

module - a module which sources are to be compiled.

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

make

public abstract 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. Files are compiled according to dependencies between the modules they belong to. Compiler excludes are honored. All modules must belong to the same project.

Parameters:

project - a project modules belong to

modules - modules to compile

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

make

public abstract void make(CompileScope scope,
                          CompileStatusNotification callback)

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

Parameters:

scope - a scope to be compiled

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

makeWithModalProgress

public abstract void makeWithModalProgress(CompileScope scope,
                                           CompileStatusNotification callback)

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

isUpToDate

public abstract boolean isUpToDate(CompileScope scope)

Checks if compile scope given is up-to-date

Parameters:

scope -

Returns:

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

rebuild

public abstract void rebuild(CompileStatusNotification callback)

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

Parameters:

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

executeTask

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

Execute a custom compile task.

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

@Deprecated
public abstract void addCompilationStatusListener(CompilationStatusListener listener)

Deprecated. Use CompilerTopics.COMPILATION_STATUS instead

addCompilationStatusListener

@Deprecated
public abstract void addCompilationStatusListener(CompilationStatusListener listener,
                                                  Disposable parentDisposable)

Deprecated. Use CompilerTopics.COMPILATION_STATUS instead

removeCompilationStatusListener

@Deprecated
public abstract void removeCompilationStatusListener(CompilationStatusListener listener)

Deprecated. Use CompilerTopics.COMPILATION_STATUS instead

isExcludedFromCompilation

public abstract boolean isExcludedFromCompilation(VirtualFile file)

Checks if the specified file is excluded from compilation.

Parameters:

file - the file to check.

Returns:

true if the file is excluded from compilation, false otherwise

createFilesCompileScope

public abstract CompileScope createFilesCompileScope(VirtualFile [] files)

createModuleCompileScope

public abstract CompileScope createModuleCompileScope(Module module,
                                                      boolean includeDependentModules)

createModulesCompileScope

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

createModulesCompileScope

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

createModuleGroupCompileScope

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

createProjectCompileScope

public abstract CompileScope createProjectCompileScope(Project project)

setValidationEnabled

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

isValidationEnabled

public abstract boolean isValidationEnabled(Module moduleType)

compileJavaCode

public abstract 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

Throws:

java.io.IOException

CompilationException

getJavacCompilerWorkingDir

public abstract java.io.File getJavacCompilerWorkingDir()