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

Interface IssueManagementSystem

All Known Implementing Classes:
AbstractIssueManagementSystem, GitHubIssueManagementSystem, JIRAIssueManagmentSystem, TracIssueManagmentSystem
public interface IssueManagementSystem
An interface for issue management systems.

The plan is to enhance this interface to allow communication with different issue management systems in a consistent way.

Version:
$Id$

  • 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.
    String
    getName()
    Get the name of the issue management system.

  • Method Details

    • getIssueTypeMap

      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.
      Returns:
      The map from keys used in poms and other config files to issue types.

    • getName

      String getName()
      Get the name of the issue management system.
      Returns:
      The name of the IMS.

    • applyConfiguration

      void applyConfiguration(Map<String,String> issueTypes) throws org.apache.maven.plugin.MojoExecutionException
      Configure this issue management system.
      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