Package org.apache.maven.plugins.changes.issues

Class AbstractIssueManagementSystem

java.lang.Object

org.apache.maven.plugins.changes.issues.AbstractIssueManagementSystem

All Implemented Interfaces:

IssueManagementSystem

Direct Known Subclasses:

GitHubIssueManagementSystem, JIRAIssueManagementSystem, TracIssueManagmentSystem

public abstract class AbstractIssueManagementSystem
extends Object
implements IssueManagementSystem

Historically, this plugin started out working against an IMS-neutral XML file, and then added extensive support for JIRA with some small snippets of code for other issue management systems. This class is intended to start a cleaner modularity for support of multiple systems.
Initially, all it provides is a structure for mapping from per-IMS issue types to the three categories defined in IssueAdapter.
Note that the map in here is not immutable. It contains the default configuration for an IMS. Users are expected to add entries to the map via configuration to reflect their customizations.

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,IssueType>	issueTypeMap

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractIssueManagementSystem()

Method Summary

Modifier and Type	Method	Description
void	applyConfiguration(Map<String,String> issueTypes)	Configure this issue management system.
Map<String,IssueType>	getIssueTypeMap()	Get a mapping of issue types used in this issue management system to the ones used in a changes.xml file.
abstract String	getName()	Get the name of the issue management system.

Methods inherited from class java.lang.Object

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

Field Details

issueTypeMap

protected Map<String,IssueType> issueTypeMap

Constructor Details

AbstractIssueManagementSystem

protected AbstractIssueManagementSystem()

Method Details

getIssueTypeMap

public Map<String,IssueType> getIssueTypeMap()

Description copied from interface: IssueManagementSystem

Get a mapping of issue types used in this issue management system to the ones used in a changes.xml file.

Specified by:

getIssueTypeMap in interface IssueManagementSystem

Returns:

The map from keys used in poms and other config files to issue types.

getName

public abstract String getName()

Description copied from interface: IssueManagementSystem

Get the name of the issue management system.

Specified by:

getName in interface IssueManagementSystem

Returns:

The name of the IMS.

applyConfiguration

public void applyConfiguration(Map<String,String> issueTypes)
                        throws org.apache.maven.plugin.MojoExecutionException

Description copied from interface: IssueManagementSystem

Configure this issue management system.

Specified by:

applyConfiguration in interface IssueManagementSystem

Parameters:

issueTypes - The mapping of issue types used in this issue management system to the ones used in a changes.xml file

Throws:

org.apache.maven.plugin.MojoExecutionException - If the configuration fails