net.kemitix.quality.api

Interface PluginGoal

All Known Implementing Classes:

AbstractPluginGoal

public interface PluginGoal

A Plugin and a Goal of that plugin.

Author:

Paul Campbell (pcampbell@kemitix.net)

Method Summary

Modifier and Type	Method and Description
void	configuration(PluginGoalConfiguration configuration) Configure the Plugin Goal.
default String	configValue(String elementName) Extract the value of a configuration element by name.
org.codehaus.plexus.util.xml.Xpp3Dom	getConfiguration() Gets the Configuration of the plugin.
String	getGoal() Get the Goal for the Plugin.
org.apache.maven.model.Plugin	getPlugin() Get the Plugin.
void	groupArtifactVersion(String groupId, String artifactId, String version) Set the maven coordinates for the plugin.
default void	onComplete() Hook called just after the plugin is executed, whether there is any error or not.
default void	onError(org.apache.maven.plugin.MojoExecutionException e) Hook called if there is an error when the plugin is executed.
default void	onExecute() Hook called just before the plugin is executed.
default void	onSuccess() Hook called just after the plugin is executed without throwing any exceptions.

Method Detail

getPlugin

org.apache.maven.model.Plugin getPlugin()

Get the Plugin.

Returns:

the Plugin

getGoal

String getGoal()

Get the Goal for the Plugin.

Returns:

the goal name

groupArtifactVersion

void groupArtifactVersion(String groupId,
                          String artifactId,
                          String version)

Set the maven coordinates for the plugin.

Parameters:

groupId - The groupId

artifactId - The artifactId

version - The version

configuration

void configuration(PluginGoalConfiguration configuration)

Configure the Plugin Goal.

Parameters:

configuration - The configuration

getConfiguration

org.codehaus.plexus.util.xml.Xpp3Dom getConfiguration()

Gets the Configuration of the plugin.

Returns:

the Xpp3Dom configuration

configValue

default String configValue(String elementName)

Extract the value of a configuration element by name.

Parameters:

elementName - the name of the element

Returns:

the value of the element

onExecute

default void onExecute()

Hook called just before the plugin is executed.

This default implementation does nothing.

onSuccess

default void onSuccess()

Hook called just after the plugin is executed without throwing any exceptions.

This default implementation does nothing.

onError

default void onError(org.apache.maven.plugin.MojoExecutionException e)

Hook called if there is an error when the plugin is executed.

This default implementation does nothing.

Parameters:

e - The exception that was thrown

onComplete

default void onComplete()

Hook called just after the plugin is executed, whether there is any error or not.

This default implementation does nothing.