xsbti.compile

Interface IncrementalCompiler

public interface IncrementalCompiler

Method Summary

Modifier and Type	Method and Description
CompileResult	compile(Inputs inputs, xsbti.Logger logger) Performs an incremental compilation given an instance of Inputs.
CompileResult	compile(ScalaCompiler scalaCompiler, JavaCompiler javaCompiler, java.nio.file.Path[] sources, java.nio.file.Path[] classpath, Output output, java.util.Optional<Output> earlyOutput, java.util.Optional<AnalysisStore> earlyAnalysisStore, GlobalsCache globalsCache, java.lang.String[] scalacOptions, java.lang.String[] javacOptions, java.util.Optional<CompileAnalysis> previousAnalysis, java.util.Optional<MiniSetup> previousSetup, PerClasspathEntryLookup perClasspathEntryLookup, Reporter reporter, CompileOrder compileOrder, java.lang.Boolean skip, java.util.Optional<CompileProgress> progress, IncOptions incrementalOptions, java.util.Optional<java.nio.file.Path> temporaryClassesDirectory, xsbti.T2<java.lang.String,java.lang.String>[] extra, FileConverter converter, ReadStamps stamper, xsbti.Logger logger) Performs an incremental compilation given its configuration.
CompileResult	compile(ScalaCompiler scalaCompiler, JavaCompiler javaCompiler, VirtualFile[] sources, VirtualFile[] classpath, Output output, java.util.Optional<Output> earlyOutput, java.util.Optional<AnalysisStore> earlyAnalysisStore, GlobalsCache globalsCache, java.lang.String[] scalacOptions, java.lang.String[] javacOptions, java.util.Optional<CompileAnalysis> previousAnalysis, java.util.Optional<MiniSetup> previousSetup, PerClasspathEntryLookup perClasspathEntryLookup, Reporter reporter, CompileOrder compileOrder, java.lang.Boolean skip, java.util.Optional<CompileProgress> progress, IncOptions incrementalOptions, java.util.Optional<java.nio.file.Path> temporaryClassesDirectory, xsbti.T2<java.lang.String,java.lang.String>[] extra, FileConverter converter, ReadStamps stamper, xsbti.Logger logger) Performs an incremental compilation given its configuration.
CompileResult	compileAllJava(Inputs inputs, xsbti.Logger logger) Compile all Java sources based on xsbti.compile.Inputs.

Method Detail

compile

CompileResult compile(Inputs inputs,
                      xsbti.Logger logger)

Performs an incremental compilation given an instance of Inputs.

Parameters:

inputs - An instance of Inputs that collect all the inputs required to run the compiler (from sources and classpath, to compilation order, previous results, current setup, etc).

logger - An instance of Logger that logs Zinc output.

Returns:

An instance of CompileResult that holds information about the results of the compilation.

compile

CompileResult compile(ScalaCompiler scalaCompiler,
                      JavaCompiler javaCompiler,
                      VirtualFile[] sources,
                      VirtualFile[] classpath,
                      Output output,
                      java.util.Optional<Output> earlyOutput,
                      java.util.Optional<AnalysisStore> earlyAnalysisStore,
                      GlobalsCache globalsCache,
                      java.lang.String[] scalacOptions,
                      java.lang.String[] javacOptions,
                      java.util.Optional<CompileAnalysis> previousAnalysis,
                      java.util.Optional<MiniSetup> previousSetup,
                      PerClasspathEntryLookup perClasspathEntryLookup,
                      Reporter reporter,
                      CompileOrder compileOrder,
                      java.lang.Boolean skip,
                      java.util.Optional<CompileProgress> progress,
                      IncOptions incrementalOptions,
                      java.util.Optional<java.nio.file.Path> temporaryClassesDirectory,
                      xsbti.T2<java.lang.String,java.lang.String>[] extra,
                      FileConverter converter,
                      ReadStamps stamper,
                      xsbti.Logger logger)

Performs an incremental compilation given its configuration.

Parameters:

scalaCompiler - The Scala compiler to compile Scala sources.

javaCompiler - The Java compiler to compile Java sources.

sources - An array of Java and Scala source files to be compiled.

classpath - An array of files representing classpath entries.

output - An instance of Output to store the compiler outputs.

globalsCache - Directory where previous cached compilers are stored.

scalacOptions - An array of options/settings for the Scala compiler.

javacOptions - An array of options for the Java compiler.

previousAnalysis - Optional previous incremental compilation analysis.

previousSetup - Optional previous incremental compilation setup.

perClasspathEntryLookup - Lookup of data structures and operations for a given classpath entry.

reporter - An instance of Reporter to report compiler output.

compileOrder - The order in which Java and Scala sources should be compiled.

skip - Flag to ignore this compilation run and return previous one.

progress - An instance of CompileProgress to keep track of the current compilation progress.

incrementalOptions - An Instance of IncOptions that configures the incremental compiler behaviour.

temporaryClassesDirectory - A directory where incremental compiler can put temporary class files or jars.

extra - An array of sbt tuples with extra options.

converter - FileConverter to convert between Path and VirtualFileRef.

stamper - Stamper creates timestamp or hash.

logger - An instance of Logger that logs Zinc output.

Returns:

An instance of CompileResult that holds information about the results of the compilation.

compile

CompileResult compile(ScalaCompiler scalaCompiler,
                      JavaCompiler javaCompiler,
                      java.nio.file.Path[] sources,
                      java.nio.file.Path[] classpath,
                      Output output,
                      java.util.Optional<Output> earlyOutput,
                      java.util.Optional<AnalysisStore> earlyAnalysisStore,
                      GlobalsCache globalsCache,
                      java.lang.String[] scalacOptions,
                      java.lang.String[] javacOptions,
                      java.util.Optional<CompileAnalysis> previousAnalysis,
                      java.util.Optional<MiniSetup> previousSetup,
                      PerClasspathEntryLookup perClasspathEntryLookup,
                      Reporter reporter,
                      CompileOrder compileOrder,
                      java.lang.Boolean skip,
                      java.util.Optional<CompileProgress> progress,
                      IncOptions incrementalOptions,
                      java.util.Optional<java.nio.file.Path> temporaryClassesDirectory,
                      xsbti.T2<java.lang.String,java.lang.String>[] extra,
                      FileConverter converter,
                      ReadStamps stamper,
                      xsbti.Logger logger)

Performs an incremental compilation given its configuration.

Parameters:

scalaCompiler - The Scala compiler to compile Scala sources.

javaCompiler - The Java compiler to compile Java sources.

sources - An array of Java and Scala source files to be compiled.

classpath - An array of files representing classpath entries.

output - An instance of Output to store the compiler outputs.

globalsCache - Directory where previous cached compilers are stored.

scalacOptions - An array of options/settings for the Scala compiler.

javacOptions - An array of options for the Java compiler.

previousAnalysis - Optional previous incremental compilation analysis.

previousSetup - Optional previous incremental compilation setup.

perClasspathEntryLookup - Lookup of data structures and operations for a given classpath entry.

reporter - An instance of Reporter to report compiler output.

compileOrder - The order in which Java and Scala sources should be compiled.

skip - Flag to ignore this compilation run and return previous one.

progress - An instance of CompileProgress to keep track of the current compilation progress.

incrementalOptions - An Instance of IncOptions that configures the incremental compiler behaviour.

temporaryClassesDirectory - A directory where incremental compiler can put temporary class files or jars.

extra - An array of sbt tuples with extra options.

converter - FileConverter to convert between Path and VirtualFileRef.

stamper - Stamper creates timestamp or hash.

logger - An instance of Logger that logs Zinc output.

Returns:

An instance of CompileResult that holds information about the results of the compilation.

compileAllJava

CompileResult compileAllJava(Inputs inputs,
                             xsbti.Logger logger)

Compile all Java sources based on xsbti.compile.Inputs. Currently this step is necessary to perform pipeline builds.

Parameters:

inputs - An instance of Inputs that collect all the inputs required to run the compiler (from sources and classpath, to compilation order, previous results, current setup, etc).

logger - An instance of Logger that logs Zinc output.

Returns:

An instance of CompileResult that holds information about the results of the compilation.