org.apache.maven.model.converter.plugins
Class AbstractPluginConfigurationConverter

java.lang.Object
  org.codehaus.plexus.logging.AbstractLogEnabled
      org.apache.maven.model.converter.plugins.AbstractPluginConfigurationConverter

All Implemented Interfaces:

PluginConfigurationConverter, org.codehaus.plexus.logging.LogEnabled

Direct Known Subclasses:

PCCCastor, PCCChangelog, PCCChanges, PCCCheckstyle, PCCCompiler, PCCJalopy, PCCJar, PCCJavadoc, PCCJavaNCSS, PCCPmd, PCCSite, PCCSurefire, PCCTaglist, PCCWar

public abstract class AbstractPluginConfigurationConverter
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements PluginConfigurationConverter

Version:

$Id: AbstractPluginConfigurationConverter.java 695609 2008-09-15 20:29:30Z dennisl $

Author:

Fabrizio Giustina, Dennis Lundberg

TYPE_BUILD_PLUGIN

public static final String TYPE_BUILD_PLUGIN

See Also:

Constant Field Values

TYPE_REPORT_PLUGIN

public static final String TYPE_REPORT_PLUGIN

See Also:

Constant Field Values

AbstractPluginConfigurationConverter

public AbstractPluginConfigurationConverter()

getArtifactId

public abstract String getArtifactId()

getGroupId

public String getGroupId()

getType

public abstract String getType()

addListeners

public void addListeners(List listeners)

Description copied from interface: PluginConfigurationConverter

Add a listeners list for all messages sended by the relocator.

Specified by:

addListeners in interface PluginConfigurationConverter

Parameters:

listeners - The listeners list that will receive messages

addListener

public void addListener(ConverterListener listener)

Description copied from interface: PluginConfigurationConverter

Add a listener for all messages sended by the relocator.

Specified by:

addListener in interface PluginConfigurationConverter

Parameters:

listener - The listener that will receive messages

addConfigurationChild

protected void addConfigurationChild(Xpp3Dom configuration,
                                     Properties projectProperties,
                                     String mavenOneProperty,
                                     String mavenTwoElement)

Add a child element to the configuration.

Parameters:

configuration - The configuration to add the element to

projectProperties - The M1 properties

mavenOneProperty - The name of the Maven 1 property to convert

mavenTwoElement - The name of the Maven 2 configuration element

addConfigurationChild

protected void addConfigurationChild(Xpp3Dom configuration,
                                     String mavenTwoElement,
                                     String value)

Add a child element to the configuration.

Parameters:

configuration - The configuration to add the element to

mavenTwoElement - The name of the Maven 2 configuration element

value - Set the value of the element to this

convertConfiguration

public void convertConfiguration(Model v4Model,
                                 org.apache.maven.model.v3_0_0.Model v3Model,
                                 Properties projectProperties)
                          throws ProjectConverterException

Specified by:

convertConfiguration in interface PluginConfigurationConverter

Throws:

ProjectConverterException

buildConfiguration

protected abstract void buildConfiguration(Xpp3Dom configuration,
                                           org.apache.maven.model.v3_0_0.Model v3Model,
                                           Properties projectProperties)
                                    throws ProjectConverterException

Throws:

ProjectConverterException

getReportSets

protected List getReportSets()

Get the report sets for this plugin. Override this method if the plugin you are converting needs report sets.

Returns:

This default implementation simply returns an empty list