Package scala_maven

Class ScalaScriptMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

scala_maven.ScalaMojoSupport

scala_maven.ScalaScriptMojo

All Implemented Interfaces:

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

@Mojo(name="script",
      requiresDependencyResolution=RUNTIME,
      executionStrategy="always",
      threadSafe=true)
public class ScalaScriptMojo
extends ScalaMojoSupport

Run a scala script.

Since:

2.7

Field Summary

Fields

Modifier and Type	Field	Description
private static AtomicInteger	_lastScriptIndex
protected String	addToClasspath	Comma seperated list of directories or jars to add to the classpath
protected String	excludeScopes	Comma separated list of scopes to remove from the classpath.
protected String	includeScopes	Comma separated list of scopes to add to the classpath.
protected boolean	keepGeneratedScript	If set to true the Scala classfile that is generated will not be deleted after the goal completes.
protected File	outputDir	The build directory of the project
protected String	removeFromClasspath	Comma separated list of directories or jars to remove from the classpath.
protected String	script	The script that will be executed.
protected String	scriptEncoding	The encoding of file containing script to be executed.
protected File	scriptFile	The file containing script to be executed.

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
ScalaScriptMojo()

Method Summary

Modifier and Type	Method	Description
private void	compileScript(File scriptDir, File destFile, URLClassLoader loader)
private void	configureClasspath(Set<String> classpath)
private URLClassLoader	createScriptClassloader(File scriptDir, Set<String> classpath)
private void	delete(File scriptDir)
protected void	doExecute()
private void	runScript(boolean mavenProjectDependency, URLClassLoader loader, String baseName)
private static String	scriptBaseNameOf(File scriptFile, int idx)
private void	wrapScript(File destFile, boolean mavenProjectDependency)

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

outputDir

@Parameter(property="project.build.directory")
protected File outputDir

The build directory of the project

scriptFile

@Parameter(property="scriptFile")
protected File scriptFile

The file containing script to be executed. Either 'scriptFile' or 'script' must be defined.

scriptEncoding

@Parameter(property="scriptEncoding",
           defaultValue="UTF-8")
protected String scriptEncoding

The encoding of file containing script to be executed.

script

@Parameter(property="script")
protected String script

The script that will be executed. Either 'scriptFile' or ' script' must be defined.

keepGeneratedScript

@Parameter(property="maven.scala.keepGeneratedScript",
           defaultValue="false")
protected boolean keepGeneratedScript

If set to true the Scala classfile that is generated will not be deleted after the goal completes. This is to allows easier debugging of the script especially since line numbers will be wrong because lines are added to the compiled script (see script examples)

includeScopes

@Parameter(property="maven.scala.includeScopes")
protected String includeScopes

Comma separated list of scopes to add to the classpath. The possible scopes are : test,compile, system, runtime, plugin. By default embedded script into pom.xml run with 'plugin' scope and script read from scriptFile run with 'compile, test, runtime'

excludeScopes

@Parameter(property="maven.scala.excludeScopes")
protected String excludeScopes

Comma separated list of scopes to remove from the classpath. Eg: test,compile

addToClasspath

@Parameter(property="addToClasspath")
protected String addToClasspath

Comma seperated list of directories or jars to add to the classpath

removeFromClasspath

@Parameter(property="removeFromClasspath")
protected String removeFromClasspath

Comma separated list of directories or jars to remove from the classpath. This is useful for resolving conflicts in the classpath. For example, the script uses Ant 1.7 and the compiler dependencies pull in Ant 1.5 optional which conflicts and causes a crash

_lastScriptIndex

private static AtomicInteger _lastScriptIndex

Constructor Details

ScalaScriptMojo

public ScalaScriptMojo()

Method Details

scriptBaseNameOf

private static String scriptBaseNameOf(File scriptFile,
 int idx)

doExecute

protected void doExecute()
                  throws Exception

Specified by:

doExecute in class ScalaMojoSupport

Throws:

Exception

runScript

private void runScript(boolean mavenProjectDependency,
 URLClassLoader loader,
 String baseName)
                throws Exception

Throws:

Exception

createScriptClassloader

private URLClassLoader createScriptClassloader(File scriptDir,
 Set<String> classpath)
                                        throws Exception

Throws:

Exception

compileScript

private void compileScript(File scriptDir,
 File destFile,
 URLClassLoader loader)
                    throws Exception

Throws:

Exception

configureClasspath

private void configureClasspath(Set<String> classpath)
                         throws Exception,
org.apache.maven.artifact.DependencyResolutionRequiredException

Throws:

Exception

org.apache.maven.artifact.DependencyResolutionRequiredException

wrapScript

private void wrapScript(File destFile,
 boolean mavenProjectDependency)
                 throws IOException

Throws:

IOException

delete

private void delete(File scriptDir)