com.github.jlgrock.javascriptframework.jsdependency

Class AbstractDependencyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.jlgrock.javascriptframework.jsdependency.AbstractDependencyMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

JsarDependencyMojo, JsarTestDependencyMojo, JsarWarDependencyMojo

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

The Abstract instance of all of the dependecy mojo implementations. This gives common functions for retrieving dependencies for each different type.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSURE_LIBRARY_NAME The name of the current closure library - this is updated regularly.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractDependencyMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected void	extractAndRenameLibrary() Extracts the closure library and renames it to a standard so that it can be referenced at a later point.
protected abstract void	extractDependencies() Extract the dependencies from the jsar to the appropriate location(s).
protected void	extractExterns(Set<org.apache.maven.artifact.Artifact> artifactSet) Extract the externs from the package.
protected void	extractInterns(boolean extractAssert) Extract the interns (assert/debug) files from the package.
File	getClosureExtractLibDirectory()
abstract File	getFrameworkTargetDirectory()
abstract org.apache.maven.project.MavenProject	getProject()
boolean	isSkipGoogleExtraction()

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

CLOSURE_LIBRARY_NAME

public static final String CLOSURE_LIBRARY_NAME

The name of the current closure library - this is updated regularly.

See Also:

Constant Field Values

Constructor Detail

AbstractDependencyMojo

public AbstractDependencyMojo()

Method Detail

getProject

public abstract org.apache.maven.project.MavenProject getProject()

Returns:

the current maven project

isSkipGoogleExtraction

public final boolean isSkipGoogleExtraction()

Returns:

the skipExtraction

getClosureExtractLibDirectory

public final File getClosureExtractLibDirectory()

Returns:

the closureExtractLibDirectory

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

extractDependencies

protected abstract void extractDependencies()
                                     throws IOException,
                                            org.apache.maven.plugin.MojoFailureException,
                                            org.apache.maven.plugin.MojoExecutionException

Extract the dependencies from the jsar to the appropriate location(s).

Throws:

IOException - if there is a problem reading the artifact

org.apache.maven.plugin.MojoFailureException - from any Mojo API specific calls

org.apache.maven.plugin.MojoExecutionException - from any Mojo API specific calls

extractAndRenameLibrary

protected final void extractAndRenameLibrary()
                                      throws IOException

Extracts the closure library and renames it to a standard so that it can be referenced at a later point.

Throws:

IOException - if there is a problem reading the artifact

extractInterns

protected final void extractInterns(boolean extractAssert)
                             throws IOException,
                                    org.apache.maven.plugin.MojoFailureException,
                                    org.apache.maven.plugin.MojoExecutionException

Extract the interns (assert/debug) files from the package.

Parameters:

extractAssert - whether to extract assert files

Throws:

IOException - if unable to write files

org.apache.maven.plugin.MojoFailureException - from any Mojo API specific calls

org.apache.maven.plugin.MojoExecutionException - from any Mojo API specific calls

extractExterns

protected final void extractExterns(Set<org.apache.maven.artifact.Artifact> artifactSet)
                             throws IOException,
                                    org.apache.maven.plugin.MojoFailureException,
                                    org.apache.maven.plugin.MojoExecutionException

Extract the externs from the package.

Parameters:

artifactSet - the set to extract

Throws:

IOException - if unable to write files

org.apache.maven.plugin.MojoFailureException - from any Mojo API specific calls

org.apache.maven.plugin.MojoExecutionException - from any Mojo API specific calls

getFrameworkTargetDirectory

public abstract File getFrameworkTargetDirectory()

Returns:

frameworkTargetDirectory