You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2011/06/14 20:30:10 UTC
svn commit: r1135732 - in
/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin:
changes/ issues/ jira/ trac/
Author: dennisl
Date: Tue Jun 14 18:30:09 2011
New Revision: 1135732
URL: http://svn.apache.org/viewvc?rev=1135732&view=rev
Log:
Improve Javadoc.
Modified:
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/IssueAdapter.java
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/IssueType.java
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/issues/IssueManagementSystem.java
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/jira/JIRAIssueManagmentSystem.java
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/trac/TracIssueManagmentSystem.java
Modified: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/IssueAdapter.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/IssueAdapter.java?rev=1135732&r1=1135731&r2=1135732&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/IssueAdapter.java (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/IssueAdapter.java Tue Jun 14 18:30:09 2011
@@ -30,7 +30,8 @@ import java.util.List;
import java.util.Map;
/**
- * An adapter that can adapt issue management system data models to the data model used in the changes.xml file.
+ * An adapter that can adapt data models from other issue management system to the data models used in the changes.xml
+ * file.
*
* @author Dennis Lundberg
* @version $Id$
@@ -41,6 +42,11 @@ public class IssueAdapter
private static final String UNKNOWN_ISSUE_TYPE = "";
private IssueManagementSystem ims;
+ /**
+ * Create a new adapter.
+ *
+ * @param ims The issue management system that has the data that should be adapted
+ */
public IssueAdapter( IssueManagementSystem ims )
{
this.ims = ims;
@@ -110,6 +116,7 @@ public class IssueAdapter
// beside JIRA
action.setIssue( issue.getKey() );
+ // Try to map the IMS-specific issue type to one that is used in a changes.xml file
IssueType type = null;
if ( getIssueTypeMap().containsKey( issue.getType() ) )
{
Modified: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/IssueType.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/IssueType.java?rev=1135732&r1=1135731&r2=1135732&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/IssueType.java (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/changes/IssueType.java Tue Jun 14 18:30:09 2011
@@ -20,7 +20,7 @@ package org.apache.maven.plugin.changes;
*/
/**
- * Cross-IMS types of issues.
+ * The types of issues that can be used in a <code>changes.xml</code> file.
*/
public enum IssueType
{
Modified: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/issues/IssueManagementSystem.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/issues/IssueManagementSystem.java?rev=1135732&r1=1135731&r2=1135732&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/issues/IssueManagementSystem.java (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/issues/IssueManagementSystem.java Tue Jun 14 18:30:09 2011
@@ -24,19 +24,35 @@ import java.util.Map;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.changes.IssueType;
+/**
+ * An interface for issue management systems.
+ * <p/>
+ * The plan is to enhance this interface to allow communication with different issue management systems in a consistent
+ * way.
+ */
public interface IssueManagementSystem
{
/**
- * @return the map from keys used in poms and other config files to issue types.
+ * Get a mapping of issue types used in this issue management system to the ones used in a changes.xml file.
+ *
+ * @return The map from keys used in poms and other config files to issue types.
*/
public abstract Map<String, IssueType> getIssueTypeMap();
/**
- * @return the name of the IMS.
+ * Get the name of the issue management system.
+ *
+ * @return The name of the IMS.
*/
public abstract String getName();
+ /**
+ * Configure this issue management system.
+ *
+ * @param issueTypes The mapping of issue types used in this issue management system to the ones used in a changes.xml file
+ * @throws MojoExecutionException If the configuration fails
+ */
public abstract void applyConfiguration( Map<String, String> issueTypes )
throws MojoExecutionException;
Modified: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/jira/JIRAIssueManagmentSystem.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/jira/JIRAIssueManagmentSystem.java?rev=1135732&r1=1135731&r2=1135732&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/jira/JIRAIssueManagmentSystem.java (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/jira/JIRAIssueManagmentSystem.java Tue Jun 14 18:30:09 2011
@@ -23,7 +23,7 @@ import org.apache.maven.plugin.changes.I
import org.apache.maven.plugin.issues.AbstractIssueManagementSystem;
/**
- * The standard issue types for JIRA.
+ * The JIRA issue management system.
*/
public class JIRAIssueManagmentSystem
extends AbstractIssueManagementSystem
@@ -35,6 +35,7 @@ public class JIRAIssueManagmentSystem
public JIRAIssueManagmentSystem()
{
super();
+ // Add the standard issue types for JIRA
issueTypeMap.put( DEFAULT_ADD_TYPE, IssueType.ADD );
issueTypeMap.put( DEFAULT_FIX_TYPE, IssueType.FIX );
issueTypeMap.put( DEFAULT_UPDATE_TYPE, IssueType.UPDATE );
Modified: maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/trac/TracIssueManagmentSystem.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/trac/TracIssueManagmentSystem.java?rev=1135732&r1=1135731&r2=1135732&view=diff
==============================================================================
--- maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/trac/TracIssueManagmentSystem.java (original)
+++ maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/trac/TracIssueManagmentSystem.java Tue Jun 14 18:30:09 2011
@@ -23,7 +23,7 @@ import org.apache.maven.plugin.changes.I
import org.apache.maven.plugin.issues.AbstractIssueManagementSystem;
/**
- * The standard issue types for TRAC. (probably wrong).
+ * The Trac issue management system.
*/
public class TracIssueManagmentSystem
extends AbstractIssueManagementSystem
@@ -35,6 +35,7 @@ public class TracIssueManagmentSystem
public TracIssueManagmentSystem()
{
super();
+ // The standard issue types for Trac (probably wrong)
issueTypeMap.put( DEFAULT_ADD_TYPE, IssueType.ADD );
issueTypeMap.put( DEFAULT_FIX_TYPE, IssueType.FIX );
issueTypeMap.put( DEFAULT_UPDATE_TYPE, IssueType.UPDATE );