org.codehaus.gmavenplus.mojo

Class AbstractGroovyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractGroovySourcesMojo, ExecuteMojo

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

The base mojo class, which all other mojos extend.

Author:

Keegan Witt

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	GROOVY_SOURCES_PATTERN The pattern defining Groovy files.
protected static String	JAVA_SOURCES_PATTERN The pattern defining Java stub files.
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository The local repository.
protected List<org.apache.maven.artifact.Artifact>	pluginArtifacts The plugin dependencies.
protected org.apache.maven.project.MavenProject	project The Maven project this plugin is being used on.
protected List<org.apache.maven.project.MavenProject>	reactorProjects The reactor projects.
protected org.apache.maven.execution.MavenSession	session The Maven Session this plugin is being used on.
protected org.apache.maven.settings.Settings	settings The Maven Settings.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractGroovyMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.maven.artifact.Artifact	getGroovyDependency() Gets the Groovy dependency used by the project.
protected Version	getGroovyVersion() Gets the version of Groovy used from the dependency information.
protected String	getGroovyVersionString() Gets the version string of Groovy used from the dependency information.
protected Version	getJavaVersion() Gets the version of Java executing this mojo as a Version object.
protected String	getJavaVersionString() Gets the version of Java executing this mojo as a String.
protected boolean	isGroovyArtifactId(org.apache.maven.artifact.Artifact artifact) Whether the artifactId of the dependency is Groovy's artifactId.
protected boolean	isGroovyArtifactId(org.apache.maven.model.Dependency dependency) Whether the artifactId of the dependency is Groovy's artifactId.
protected boolean	isGroovyGroupId(org.apache.maven.artifact.Artifact artifact) Whether the groupId of the dependency is Groovy's groupId.
protected boolean	isGroovyGroupId(org.apache.maven.model.Dependency dependency) Whether the groupId of the dependency is Groovy's groupId.
protected boolean	isGroovyIndy() Gets the version of Groovy used from the dependency information.
protected boolean	isJavaSupportIndy() Determines whether the version of Java executing this mojo supports invokedynamic (is at least 1.7).
protected void	logGroovyVersion(String goal) Logs the version of groovy used by this mojo.

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

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

execute

Field Detail

GROOVY_SOURCES_PATTERN

protected static final String GROOVY_SOURCES_PATTERN

The pattern defining Groovy files.

JAVA_SOURCES_PATTERN

protected static final String JAVA_SOURCES_PATTERN

The pattern defining Java stub files.

project

protected org.apache.maven.project.MavenProject project

The Maven project this plugin is being used on.

session

protected org.apache.maven.execution.MavenSession session

The Maven Session this plugin is being used on.

settings

protected org.apache.maven.settings.Settings settings

The Maven Settings.

pluginArtifacts

protected List<org.apache.maven.artifact.Artifact> pluginArtifacts

The plugin dependencies.

localRepository

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

The local repository.

reactorProjects

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

The reactor projects.

Constructor Detail

AbstractGroovyMojo

public AbstractGroovyMojo()

Method Detail

logGroovyVersion

protected void logGroovyVersion(String goal)

Logs the version of groovy used by this mojo.

Parameters:

goal - The goal to mention in the log statement showing Groovy version

getGroovyVersionString

protected String getGroovyVersionString()

Gets the version string of Groovy used from the dependency information.

Returns:

The version string of Groovy used by the project

getGroovyVersion

protected Version getGroovyVersion()

Gets the version of Groovy used from the dependency information.

Returns:

The version of Groovy used by the project

isGroovyIndy

protected boolean isGroovyIndy()

Gets the version of Groovy used from the dependency information.

Returns:

true if the version of Groovy uses InvokeDynamic, false if not or Groovy dependency cannot be found.

getGroovyDependency

protected org.apache.maven.artifact.Artifact getGroovyDependency()

Gets the Groovy dependency used by the project.

Returns:

The Groovy dependency used by the project

isGroovyGroupId

protected boolean isGroovyGroupId(org.apache.maven.model.Dependency dependency)

Whether the groupId of the dependency is Groovy's groupId.

Parameters:

dependency - The dependency to inspect

Returns:

true if the dependency's groupId is a Groovy groupId, false otherwise

isGroovyArtifactId

protected boolean isGroovyArtifactId(org.apache.maven.model.Dependency dependency)

Whether the artifactId of the dependency is Groovy's artifactId.

Parameters:

dependency - The dependency to inspect

Returns:

true if the dependency's groupId is a Groovy groupId, false otherwise

isGroovyGroupId

protected boolean isGroovyGroupId(org.apache.maven.artifact.Artifact artifact)

Whether the groupId of the dependency is Groovy's groupId.

Parameters:

artifact - The dependency to inspect

Returns:

true if the dependency's groupId is a Groovy groupId, false otherwise

isGroovyArtifactId

protected boolean isGroovyArtifactId(org.apache.maven.artifact.Artifact artifact)

Whether the artifactId of the dependency is Groovy's artifactId.

Parameters:

artifact - The dependency to inspect

Returns:

true if the dependency's groupId is a Groovy groupId, false otherwise

isJavaSupportIndy

protected boolean isJavaSupportIndy()

Determines whether the version of Java executing this mojo supports invokedynamic (is at least 1.7).

Returns:

true if the running Java supports invokedynamic, false otherwise

getJavaVersion

protected Version getJavaVersion()

Gets the version of Java executing this mojo as a Version object.

Returns:

a Version object of the running Java version

getJavaVersionString

protected String getJavaVersionString()

Gets the version of Java executing this mojo as a String.

Returns:

a String of the running Java version