com.intellij.openapi.compiler
Interface Compiler

All Known Subinterfaces:

ClassInstrumentingCompiler, ClassPostProcessingCompiler, FileProcessingCompiler, GeneratingCompiler, JavaSourceTransformingCompiler, PackagingCompiler, SourceGeneratingCompiler, SourceInstrumentingCompiler, TranslatingCompiler, Validator

All Known Implementing Classes:

CopyingCompiler

public interface Compiler

Base interface for a custom compiler which participates in the IDEA build process.

See Also:

CompilerManager.addCompiler(Compiler), CompilerManager.removeCompiler(Compiler)

Method Summary

java.lang.String	getDescription() Returns the description of the compiler.
boolean	validateConfiguration(CompileScope scope) Called before compilation starts.

Method Detail

getDescription

@NotNull
java.lang.String getDescription()

Returns the description of the compiler. All registered compilers should have unique description.

Returns:

the description string.

validateConfiguration

boolean validateConfiguration(CompileScope scope)

Called before compilation starts. If at least one of registered compilers returned false, compilation won't start.

Parameters:

scope - the scope on which the compilation is started.

Returns:

true if everything is ok, false otherwise