scala_maven

Class ScalaMojoSupport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

scala_maven.ScalaMojoSupport

All Implemented Interfaces:

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

Direct Known Subclasses:

ScalaConsoleMojo, ScalaHelpMojo, ScalaRunMojo, ScalaScriptMojo, ScalaSourceMojoSupport

public abstract class ScalaMojoSupport
extends org.apache.maven.plugin.AbstractMojo

Field Summary

Fields

Modifier and Type	Field and Description
protected String	addJavacArgs Alternative method for specifying javac arguments (when using incremental compiler).
protected String	addScalacArgs Additional parameter to use to call the main class Using this parameter only from command line ("-DaddScalacArgs=arg1|arg2|arg3|..."), not from pom.xml.
protected String[]	args compiler additionnals arguments
protected boolean	checkMultipleScalaVersions Check if every dependencies use the same version of scala-library or scala.compat.version.
protected BasicArtifact[]	compilerPlugins Compiler plugin dependencies to use when compiling.
protected BasicArtifact[]	dependencies Additional dependencies/jar to add to classpath to run "scalaClassName" (scope and optional field not supported) ex : <dependencies> <dependency> <groupId>org.scala-tools</groupId> <artifactId>scala-compiler-addon</artifactId> <version>1.0-SNAPSHOT</version> </dependency> </dependencies>
boolean	displayCmd Display the command line called ?
protected String	encoding The -encoding argument for the Java compiler.
protected org.apache.maven.repository.RepositorySystem	factory Used to look up Artifacts in the remote repository.
protected boolean	failOnMultipleScalaVersions Determines if a detection of multiple scala versions in the dependencies will cause the build to fail.
protected boolean	forceUseArgFile Force the use of an external ArgFile to run any forked process.
protected boolean	fork Forks the execution of scalac into a separate process.
protected String[]	javacArgs Arguments for javac (when using incremental compiler).
protected boolean	javacGenerateDebugSymbols Whether to instruct javac to generate debug symbols (when using incremental compiler)
protected String[]	jvmArgs Jvm Arguments.
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepo Location of the local repository.
protected org.apache.maven.project.MavenProjectBuilder	mavenProjectBuilder Artifact factory, needed to download source jars.
protected org.apache.maven.project.MavenProject	project
protected List<org.apache.maven.project.MavenProject>	reactorProjects Contains the full list of projects in the reactor.
protected List<?>	remoteRepos List of Remote Repositories used by the resolver
protected org.apache.maven.artifact.resolver.ArtifactResolver	resolver Used to look up Artifacts in the remote repository.
static String	SCALA_COMPILER_ARTIFACTID
static String	SCALA_LIBRARY_ARTIFACTID
protected String	scalaClassName className (FQN) of the scala tool to provide as
protected org.apache.maven.execution.MavenSession	session The Maven Session Object
protected String	source The -source argument for the Java compiler (when using incremental compiler).
protected String	target The -target argument for the Java compiler (when using incremental compiler).
protected org.apache.maven.toolchain.ToolchainManager	toolchainManager The toolchain manager to use.
protected boolean	useCanonicalPath Should use CanonicalPath to normalize path (true => getCanonicalPath, false => getAbsolutePath)

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ScalaMojoSupport()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCompilerPluginOptions(JavaMainCaller scalac) Adds appropriate compiler plugins to the scalac command.
protected void	addCompilerToClasspath(Set<String> classpath)
protected void	addLibraryToClasspath(Set<String> classpath)
protected void	addToClasspath(org.apache.maven.artifact.Artifact artifact, Set<String> classpath, boolean addDependencies)
void	addToClasspath(String groupId, String artifactId, String version, Set<String> classpath)
void	addToClasspath(String groupId, String artifactId, String version, Set<String> classpath, boolean addDependencies)
void	addToClasspath(String groupId, String artifactId, String version, String classifier, Set<String> classpath, boolean addDependencies) added for classifier support.
protected void	checkScalaVersion()
protected abstract void	doExecute()
void	execute()
protected VersionNumber	findScalaVersion()
protected String	findVersionFromDependencies(String groupId, String artifactId)
protected String	findVersionFromPluginArtifacts(String groupId, String artifactId)
protected Set<org.apache.maven.artifact.Artifact>	getAllDependencies(String groupId, String artifactId, String version)
protected File	getArtifactJar(String groupId, String artifactId, String version)
protected File	getArtifactJar(String groupId, String artifactId, String version, String classifier)
protected List<File>	getCompilerDependencies()
protected File	getCompilerJar()
protected List<String>	getCompilerPluginOptions()
protected List<org.apache.maven.model.Dependency>	getDependencies()
protected JavaMainCaller	getEmptyScalaCommand(String mainClass)
protected List<String>	getJavacOptions()
protected File	getLibraryJar()
protected File	getPluginArtifactJar(String groupId, String artifactId, String version)
protected File	getPluginArtifactJar(String groupId, String artifactId, String version, String classifier)
protected JavaMainCaller	getScalaCommand()
protected List<String>	getScalaOptions()
String	getScalaOrganization()
protected boolean	isJavaSupportedByCompiler()
protected Set<org.apache.maven.artifact.Artifact>	resolveArtifactDependencies(org.apache.maven.artifact.Artifact artifact) This method resolves all transitive dependencies of an artifact.
protected Set<org.apache.maven.artifact.Artifact>	resolveDependencyArtifacts(org.apache.maven.project.MavenProject theProject) This method resolves the dependency artifacts from the project.

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 Detail

SCALA_LIBRARY_ARTIFACTID

public static final String SCALA_LIBRARY_ARTIFACTID

See Also:

Constant Field Values

SCALA_COMPILER_ARTIFACTID

public static final String SCALA_COMPILER_ARTIFACTID

See Also:

Constant Field Values

project

protected org.apache.maven.project.MavenProject project

session

protected org.apache.maven.execution.MavenSession session

The Maven Session Object

reactorProjects

protected List<org.apache.maven.project.MavenProject> reactorProjects

Contains the full list of projects in the reactor.

factory

protected org.apache.maven.repository.RepositorySystem factory

Used to look up Artifacts in the remote repository.

resolver

protected org.apache.maven.artifact.resolver.ArtifactResolver resolver

Used to look up Artifacts in the remote repository.

localRepo

protected org.apache.maven.artifact.repository.ArtifactRepository localRepo

Location of the local repository.

remoteRepos

protected List<?> remoteRepos

List of Remote Repositories used by the resolver

dependencies

protected BasicArtifact[] dependencies

Additional dependencies/jar to add to classpath to run "scalaClassName" (scope and optional field not supported) ex :

    <dependencies>
      <dependency>
        <groupId>org.scala-tools</groupId>
        <artifactId>scala-compiler-addon</artifactId>
        <version>1.0-SNAPSHOT</version>
      </dependency>
    </dependencies>
 

compilerPlugins

protected BasicArtifact[] compilerPlugins

Compiler plugin dependencies to use when compiling. ex:

jvmArgs

protected String[] jvmArgs

Jvm Arguments.

args

protected String[] args

compiler additionnals arguments

addScalacArgs

protected String addScalacArgs

Additional parameter to use to call the main class Using this parameter only from command line ("-DaddScalacArgs=arg1|arg2|arg3|..."), not from pom.xml.

scalaClassName

protected String scalaClassName

className (FQN) of the scala tool to provide as

javacArgs

protected String[] javacArgs

Arguments for javac (when using incremental compiler).

javacGenerateDebugSymbols

protected boolean javacGenerateDebugSymbols

Whether to instruct javac to generate debug symbols (when using incremental compiler)

See Also:

://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#debug

addJavacArgs

protected String addJavacArgs

Alternative method for specifying javac arguments (when using incremental compiler). Can be used from command line with -DaddJavacArgs=arg1|arg2|arg3|... rather than in pom.xml.

source

protected String source

The -source argument for the Java compiler (when using incremental compiler).

target

protected String target

The -target argument for the Java compiler (when using incremental compiler).

encoding

protected String encoding

The -encoding argument for the Java compiler. (when using incremental compiler).

displayCmd

public boolean displayCmd

Display the command line called ? (property 'maven.scala.displayCmd' replaced by 'displayCmd')

fork

protected boolean fork

Forks the execution of scalac into a separate process.

forceUseArgFile

protected boolean forceUseArgFile

Force the use of an external ArgFile to run any forked process.

checkMultipleScalaVersions

protected boolean checkMultipleScalaVersions

Check if every dependencies use the same version of scala-library or scala.compat.version.

failOnMultipleScalaVersions

protected boolean failOnMultipleScalaVersions

Determines if a detection of multiple scala versions in the dependencies will cause the build to fail.

useCanonicalPath

protected boolean useCanonicalPath

Should use CanonicalPath to normalize path (true => getCanonicalPath, false => getAbsolutePath)

See Also:

https://github.com/davidB/maven-scala-plugin/issues/50

mavenProjectBuilder

protected org.apache.maven.project.MavenProjectBuilder mavenProjectBuilder

Artifact factory, needed to download source jars.

toolchainManager

protected org.apache.maven.toolchain.ToolchainManager toolchainManager

The toolchain manager to use.

Constructor Detail

ScalaMojoSupport

public ScalaMojoSupport()

Method Detail

getScalaOrganization

public String getScalaOrganization()

resolveDependencyArtifacts

protected Set<org.apache.maven.artifact.Artifact> resolveDependencyArtifacts(org.apache.maven.project.MavenProject theProject)
                                                                      throws Exception

This method resolves the dependency artifacts from the project.

Parameters:

theProject - The POM.

Returns:

resolved set of dependency artifacts.

Throws:

org.apache.maven.artifact.resolver.ArtifactResolutionException

org.apache.maven.artifact.resolver.ArtifactNotFoundException

org.apache.maven.project.artifact.InvalidDependencyVersionException

Exception

resolveArtifactDependencies

protected Set<org.apache.maven.artifact.Artifact> resolveArtifactDependencies(org.apache.maven.artifact.Artifact artifact)
                                                                       throws Exception

This method resolves all transitive dependencies of an artifact.

Parameters:

artifact - the artifact used to retrieve dependencies

Returns:

resolved set of dependencies

Throws:

org.apache.maven.artifact.resolver.ArtifactResolutionException

org.apache.maven.artifact.resolver.ArtifactNotFoundException

org.apache.maven.project.ProjectBuildingException

org.apache.maven.project.artifact.InvalidDependencyVersionException

Exception

addToClasspath

public void addToClasspath(String groupId,
                  String artifactId,
                  String version,
                  Set<String> classpath)
                    throws Exception

Throws:

Exception

addToClasspath

public void addToClasspath(String groupId,
                  String artifactId,
                  String version,
                  Set<String> classpath,
                  boolean addDependencies)
                    throws Exception

Throws:

Exception

addToClasspath

public void addToClasspath(String groupId,
                  String artifactId,
                  String version,
                  String classifier,
                  Set<String> classpath,
                  boolean addDependencies)
                    throws Exception

added for classifier support.

Throws:

Exception

addToClasspath

protected void addToClasspath(org.apache.maven.artifact.Artifact artifact,
                  Set<String> classpath,
                  boolean addDependencies)
                       throws Exception

Throws:

Exception

addCompilerToClasspath

protected void addCompilerToClasspath(Set<String> classpath)
                               throws Exception

Throws:

Exception

addLibraryToClasspath

protected void addLibraryToClasspath(Set<String> classpath)
                              throws Exception

Throws:

Exception

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getDependencies

protected List<org.apache.maven.model.Dependency> getDependencies()

findScalaVersion

protected VersionNumber findScalaVersion()
                                  throws Exception

Throws:

Exception

findVersionFromDependencies

protected String findVersionFromDependencies(String groupId,
                                 String artifactId)
                                      throws Exception

Throws:

Exception

checkScalaVersion

protected void checkScalaVersion()
                          throws Exception

Throws:

Exception

doExecute

protected abstract void doExecute()
                           throws Exception

Throws:

Exception

getScalaCommand

protected JavaMainCaller getScalaCommand()
                                  throws Exception

Throws:

Exception

getEmptyScalaCommand

protected JavaMainCaller getEmptyScalaCommand(String mainClass)
                                       throws Exception

Throws:

Exception

getScalaOptions

protected List<String> getScalaOptions()
                                throws Exception

Throws:

Exception

getJavacOptions

protected List<String> getJavacOptions()
                                throws Exception

Throws:

Exception

getLibraryJar

protected File getLibraryJar()
                      throws Exception

Throws:

Exception

getCompilerJar

protected File getCompilerJar()
                       throws Exception

Throws:

Exception

getCompilerDependencies

protected List<File> getCompilerDependencies()
                                      throws Exception

Throws:

Exception

getArtifactJar

protected File getArtifactJar(String groupId,
                  String artifactId,
                  String version)
                       throws Exception

Throws:

Exception

getArtifactJar

protected File getArtifactJar(String groupId,
                  String artifactId,
                  String version,
                  String classifier)
                       throws Exception

Throws:

Exception

getAllDependencies

protected Set<org.apache.maven.artifact.Artifact> getAllDependencies(String groupId,
                                                         String artifactId,
                                                         String version)
                                                              throws Exception

Throws:

Exception

isJavaSupportedByCompiler

protected boolean isJavaSupportedByCompiler()
                                     throws Exception

Returns:

This returns whether or not the scala version can support having java sent into the compiler

Throws:

Exception

addCompilerPluginOptions

protected void addCompilerPluginOptions(JavaMainCaller scalac)
                                 throws Exception

Adds appropriate compiler plugins to the scalac command.

Parameters:

scalac -

Throws:

Exception

getCompilerPluginOptions

protected List<String> getCompilerPluginOptions()
                                         throws Exception

Throws:

Exception

findVersionFromPluginArtifacts

protected String findVersionFromPluginArtifacts(String groupId,
                                    String artifactId)
                                         throws Exception

Throws:

Exception

getPluginArtifactJar

protected File getPluginArtifactJar(String groupId,
                        String artifactId,
                        String version)
                             throws Exception

Throws:

Exception

getPluginArtifactJar

protected File getPluginArtifactJar(String groupId,
                        String artifactId,
                        String version,
                        String classifier)
                             throws Exception

Throws:

Exception