Package scala_maven

Class ScalaCompilerSupport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

scala_maven.ScalaMojoSupport

scala_maven.ScalaSourceMojoSupport

scala_maven.ScalaCompilerSupport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

ScalaCompileMojo, ScalaContinuousCompileMojo, ScalaTestCompileMojo

public abstract class ScalaCompilerSupport
extends ScalaSourceMojoSupport

Abstract parent of all Scala Mojo who run compilation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ScalaCompilerSupport.LastCompilationInfo

Field Summary

Fields

Modifier and Type	Field	Description
private long	_lastCompileAt
private String	addZincArgs	Additional parameter to use to call zinc server It is a pipe '|' separated list of arguments, so it can be used from command line ("-DaddZincArgs=arg1|arg2|arg3|...").
static final String	ALL
private boolean	compileErrors	Keeps track of if we get compile errors in incremental mode
private String	compileOrder	Compile order for Scala and Java sources for sbt incremental compile.
private SbtIncrementalCompiler	incremental
static final String	INCREMENTAL
static final String	MODIFIED_ONLY
private boolean	notifyCompilation	notifyCompilation if true then print a message "path: compiling" for each root directory or files that will be compiled.
protected String	recompileMode	Recompile mode to use when sources were previously compiled and there is at least one change: "modified-only" => only modified sources are recompiled (pre 2.13 behavior), "all" => all sources are recompiled, "incremental" => incrementally recompile modified sources and other affected sources.
private boolean	useZincServer	Use zinc server for incremental recompilation.
private String	zincHost	Zinc server host, if running with incremental zinc server mode.
private int	zincPort	Zinc server port, if running with incremental zinc server mode.

Fields inherited from class scala_maven.ScalaSourceMojoSupport

excludes, includes, sendJavaToScalac

Fields inherited from class scala_maven.ScalaMojoSupport

addJavacArgs, addScalacArgs, args, checkMultipleScalaVersions, compilerPlugins, dependencies, displayCmd, encoding, factory, failOnMultipleScalaVersions, forceUseArgFile, fork, JAR, javacArgs, javacGenerateDebugSymbols, jvmArgs, localRepo, mavenProjectBuilder, POM, project, reactorProjects, remoteRepos, resolver, SCALA_COMPILER_ARTIFACTID, SCALA_LIBRARY_ARTIFACTID, scalaClassName, session, source, target, toolchainManager, useCanonicalPath

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
ScalaCompilerSupport()

Method Summary

Modifier and Type	Method	Description
protected void	clearCompileErrors()
protected int	compile(List<File> sourceRootDirs, File outputDir, File analysisCacheFile, List<String> classpathElements, boolean compileInLoop)
protected File	defaultAnalysisCacheFile(org.apache.maven.project.MavenProject p)
protected File	defaultAnalysisDirectory(org.apache.maven.project.MavenProject p)
protected File	defaultTestAnalysisCacheFile(org.apache.maven.project.MavenProject p)
protected void	doExecute()
protected abstract File	getAnalysisCacheFile()	Analysis cache file for incremental recompilation.
protected Map<File,File>	getAnalysisCacheMap()
protected abstract List<String>	getClasspathElements()
protected List<File>	getFilesToCompile(List<File> sourceRootDirs, long lastSuccessfullCompileTime)
protected abstract File	getOutputDir()
protected boolean	hasCompileErrors()	Returns true if the previous compile failed
protected int	incrementalCompile(List<String> classpathElements, List<File> sourceRootDirs, File outputDir, File cacheFile, boolean compileInLoop)
private void	notifyCompilation(List<File> files)

Methods inherited from class scala_maven.ScalaSourceMojoSupport

findSourceWithFilters, findSourceWithFilters, getSourceDirectories, initFilters, normalize

Methods inherited from class scala_maven.ScalaMojoSupport

addCompilerPluginOptions, addCompilerToClasspath, addLibraryToClasspath, addToClasspath, addToClasspath, addToClasspath, addToClasspath, checkScalaVersion, execute, findScalaVersion, findVersionFromDependencies, findVersionFromPluginArtifacts, getAllDependencies, getArtifactJar, getArtifactJar, getCompilerDependencies, getCompilerJar, getCompilerPluginOptions, getDependencies, getEmptyScalaCommand, getEmptyScalaCommand, getJavacOptions, getLibraryJar, getPluginArtifactJar, getPluginArtifactJar, getScalaCommand, getScalaCommand, getScalaOptions, getScalaOrganization, isJavaSupportedByCompiler, resolveArtifactDependencies, resolveDependencyArtifacts, resolveDependencyArtifacts, scalaCompilerArtifact

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Details

ALL

public static final String ALL

See Also:

• Constant Field Values

MODIFIED_ONLY

public static final String MODIFIED_ONLY

See Also:

• Constant Field Values

INCREMENTAL

public static final String INCREMENTAL

See Also:

• Constant Field Values

compileErrors

private boolean compileErrors

Keeps track of if we get compile errors in incremental mode

recompileMode

@Parameter(property="recompileMode",
           defaultValue="all")
protected String recompileMode

Recompile mode to use when sources were previously compiled and there is at least one change: "modified-only" => only modified sources are recompiled (pre 2.13 behavior), "all" => all sources are recompiled, "incremental" => incrementally recompile modified sources and other affected sources.

notifyCompilation

@Parameter(property="notifyCompilation",
           defaultValue="true")
private boolean notifyCompilation

notifyCompilation if true then print a message "path: compiling" for each root directory or files that will be compiled. Useful for debug, and for integration with Editor/IDE to reset markers only for compiled files.

_lastCompileAt

private long _lastCompileAt

incremental

private SbtIncrementalCompiler incremental

compileOrder

@Parameter(property="compileOrder",
           defaultValue="mixed")
private String compileOrder

Compile order for Scala and Java sources for sbt incremental compile. Can be Mixed, JavaThenScala, or ScalaThenJava.

useZincServer

@Parameter(property="useZincServer",
           defaultValue="false")
private boolean useZincServer

Use zinc server for incremental recompilation.

zincPort

@Parameter(property="zincPort",
           defaultValue="3030")
private int zincPort

Zinc server port, if running with incremental zinc server mode.

zincHost

@Parameter(property="zincHost",
           defaultValue="127.0.0.1")
private String zincHost

Zinc server host, if running with incremental zinc server mode. Defaults to 127.0.0.1.

addZincArgs

@Parameter(property="addZincArgs")
private String addZincArgs

Additional parameter to use to call zinc server It is a pipe '|' separated list of arguments, so it can be used from command line ("-DaddZincArgs=arg1|arg2|arg3|...").

Constructor Details

ScalaCompilerSupport

public ScalaCompilerSupport()

Method Details

getOutputDir

protected abstract File getOutputDir()
                              throws Exception

Throws:

Exception

getClasspathElements

protected abstract List<String> getClasspathElements()
                                              throws Exception

Throws:

Exception

getAnalysisCacheFile

protected abstract File getAnalysisCacheFile()
                                      throws Exception

Analysis cache file for incremental recompilation.

Throws:

Exception

doExecute

protected void doExecute()
                  throws Exception

Specified by:

doExecute in class ScalaMojoSupport

Throws:

Exception

compile

protected int compile(List<File> sourceRootDirs,
 File outputDir,
 File analysisCacheFile,
 List<String> classpathElements,
 boolean compileInLoop)
               throws Exception,
InterruptedException

Throws:

Exception

InterruptedException

hasCompileErrors

protected boolean hasCompileErrors()

Returns true if the previous compile failed

clearCompileErrors

protected void clearCompileErrors()

getFilesToCompile

protected List<File> getFilesToCompile(List<File> sourceRootDirs,
 long lastSuccessfullCompileTime)
                                throws Exception

Throws:

Exception

notifyCompilation

private void notifyCompilation(List<File> files)
                        throws Exception

Throws:

Exception

incrementalCompile

protected int incrementalCompile(List<String> classpathElements,
 List<File> sourceRootDirs,
 File outputDir,
 File cacheFile,
 boolean compileInLoop)
                          throws Exception,
InterruptedException

Throws:

Exception

InterruptedException

getAnalysisCacheMap

protected Map<File,File> getAnalysisCacheMap()

defaultAnalysisDirectory

protected File defaultAnalysisDirectory(org.apache.maven.project.MavenProject p)

defaultAnalysisCacheFile

protected File defaultAnalysisCacheFile(org.apache.maven.project.MavenProject p)

defaultTestAnalysisCacheFile

protected File defaultTestAnalysisCacheFile(org.apache.maven.project.MavenProject p)