net.kemitix.quality.api

Class AbstractPluginGoal

java.lang.Object

net.kemitix.quality.api.AbstractPluginGoal

All Implemented Interfaces:

PluginGoal

public abstract class AbstractPluginGoal
extends Object
implements PluginGoal

Plugin and Goal with constructor to create the Plugin.

Author:

Paul Campbell (pcampbell@kemitix.net)

Nested Class Summary

Nested classes/interfaces inherited from interface net.kemitix.quality.api.PluginGoal

PluginGoal.LifecyclePhase

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPluginGoal() Constructor to assign configuration to plugin.

Method Summary

Modifier and Type	Method and Description
protected org.codehaus.plexus.util.xml.Xpp3Dom	addChildContainer(org.codehaus.plexus.util.xml.Xpp3Dom parent, String name) Add container element to the parent config.
protected void	addChildElement(org.codehaus.plexus.util.xml.Xpp3Dom parent, String name, String value) Add name and string value element to the parent config.
protected void	addDependency(String groupId, String artifactId, String version) Add a dependency for the plugin.
protected org.codehaus.plexus.util.xml.Xpp3Dom	addRootContainer(String name) Add container element to the root config.
protected void	addRootElement(String name, boolean value) Add name and boolean value element to the root config.
protected void	addRootElement(String name, String value) Add name and string value element to the root config.
void	groupArtifactVersion(String groupId, String artifactId, String version) Set the Maven Co-ordinates for the plugin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.kemitix.quality.api.PluginGoal

configuration, configValue, getConfiguration, getGoals, getName, getPlugin, getWeight, matches, onComplete, onError, onExecute, onSuccess

Constructor Detail

AbstractPluginGoal

protected AbstractPluginGoal()

Constructor to assign configuration to plugin.

Method Detail

groupArtifactVersion

public void groupArtifactVersion(@NonNull
                                 String groupId,
                                 @NonNull
                                 String artifactId,
                                 @NonNull
                                 String version)

Set the Maven Co-ordinates for the plugin.

Specified by:

groupArtifactVersion in interface PluginGoal

Parameters:

groupId - The groupId

artifactId - The artifactId

version - The version

addRootElement

protected final void addRootElement(String name,
                                    boolean value)

Add name and boolean value element to the root config.

Parameters:

name - The name of the element

value - The value of the element

addRootElement

protected final void addRootElement(String name,
                                    String value)

Add name and string value element to the root config.

Parameters:

name - The name of the element

value - The value of the element

addRootContainer

protected final org.codehaus.plexus.util.xml.Xpp3Dom addRootContainer(String name)

Add container element to the root config.

Parameters:

name - The name of the container

Returns:

the container

addChildContainer

protected final org.codehaus.plexus.util.xml.Xpp3Dom addChildContainer(org.codehaus.plexus.util.xml.Xpp3Dom parent,
                                                                       String name)

Add container element to the parent config.

Parameters:

parent - The parent of the container

name - The name of the container

Returns:

the container

addChildElement

protected final void addChildElement(org.codehaus.plexus.util.xml.Xpp3Dom parent,
                                     String name,
                                     String value)

Add name and string value element to the parent config.

Parameters:

parent - The parent of the element

name - The name of the element

value - The value of the element

addDependency

protected final void addDependency(String groupId,
                                   String artifactId,
                                   String version)

Add a dependency for the plugin.

Parameters:

groupId - The groupId

artifactId - The artifactId

version - The version