View Javadoc

1   package org.apache.maven.plugin.issues;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.util.Map;
23  
24  import org.apache.maven.plugin.MojoExecutionException;
25  import org.apache.maven.plugin.changes.IssueType;
26  
27  /**
28   * An interface for issue management systems.
29   * <p/>
30   * The plan is to enhance this interface to allow communication with different issue management systems in a consistent
31   * way.
32   *
33   * @version $Id: IssueManagementSystem.java 1379901 2012-09-01 23:44:49Z dennisl $
34   */
35  public interface IssueManagementSystem
36  {
37  
38      /**
39       * Get a mapping of issue types used in this issue management system to the ones used in a changes.xml file.
40       *
41       * @return The map from keys used in poms and other config files to issue types.
42       */
43      public abstract Map<String, IssueType> getIssueTypeMap();
44  
45      /**
46       * Get the name of the issue management system.
47       *
48       * @return The name of the IMS.
49       */
50      public abstract String getName();
51  
52      /**
53       * Configure this issue management system.
54       *
55       * @param issueTypes The mapping of issue types used in this issue management system to the ones used in a changes.xml file
56       * @throws MojoExecutionException If the configuration fails
57       */
58      public abstract void applyConfiguration( Map<String, String> issueTypes )
59          throws MojoExecutionException;
60  
61  }