Package org.apache.maven.plugins.changes.model

Class Action

java.lang.Object
org.apache.maven.plugins.changes.model.AbstractAction
org.apache.maven.plugins.changes.model.Action
All Implemented Interfaces:
Serializable
public class Action extends AbstractAction implements Serializable
A single action done on the project, during this release.
Version:
$Revision$ $Date$
See Also:

  • Constructor Details

    • Action

      public Action()

  • Method Details

    • getAction

      public String getAction()
      Get a short description of the action taken.
      Returns:
      String

    • getDate

      public String getDate()
      Get fix date.
      Returns:
      String

    • getDev

      public String getDev()
      Get name of developer who committed the change.

      This can be either the id of the developer, as specified in the developers section of the pom.xml file, or the name of the developer. If you generate a changes report and specify the id of the developer, a link is created to that developer in the team.html page.

      Returns:
      String

    • getDueTo

      public String getDueTo()
      Get name of the person to be credited for this change. This can be used when a patch is submitted by a non-committer. Can be a comma separated list.
      Specified by:
      getDueTo in class AbstractAction
      Returns:
      String

    • getDueToEmail

      public String getDueToEmail()
      Get email of the person to be credited for this change. Can be a comma separated list.
      Specified by:
      getDueToEmail in class AbstractAction
      Returns:
      String

    • getFixedIssuesString

      public String getFixedIssuesString()
      Get a comma separated list of fixed issues.
      Specified by:
      getFixedIssuesString in class AbstractAction
      Returns:
      String

    • getIssue

      public String getIssue()
      Get id of the issue related to this change. This is the id in your issue tracking system.

      The Changes plugin will generate a URL out of this id. The URL is constructed using the value of the issueLinkTemplate parameter.

      See the changes-report mojo for more details.

      Returns:
      String

    • getSystem

      public String getSystem()
      Get id of issue tracking system. If empty 'default' value will be used.

      The Changes plugin will generate a URL out of this id. The URL is constructed using the value of the issueLinkTemplatePerSystem parameter.

      See the changes-report mojo for more details.

      Returns:
      String

    • getType

      public String getType()
      Get supported action types are the following:
      • add: added functionality to the project.
      • fix: bug fix for the project.
      • update: updated some part of the project.
      • remove: removed some functionality from the project.
      Returns:
      String

    • setAction

      public void setAction(String action)
      Set a short description of the action taken.
      Parameters:
      action - a action object.

    • setDate

      public void setDate(String date)
      Set fix date.
      Parameters:
      date - a date object.

    • setDev

      public void setDev(String dev)
      Set name of developer who committed the change.

      This can be either the id of the developer, as specified in the developers section of the pom.xml file, or the name of the developer. If you generate a changes report and specify the id of the developer, a link is created to that developer in the team.html page.

      Parameters:
      dev - a dev object.

    • setDueTo

      public void setDueTo(String dueTo)
      Set name of the person to be credited for this change. This can be used when a patch is submitted by a non-committer. Can be a comma separated list.
      Parameters:
      dueTo - a dueTo object.

    • setDueToEmail

      public void setDueToEmail(String dueToEmail)
      Set email of the person to be credited for this change. Can be a comma separated list.
      Parameters:
      dueToEmail - a dueToEmail object.

    • setFixedIssuesString

      public void setFixedIssuesString(String fixedIssuesString)
      Set a comma separated list of fixed issues.
      Parameters:
      fixedIssuesString - a fixedIssuesString object.

    • setIssue

      public void setIssue(String issue)
      Set id of the issue related to this change. This is the id in your issue tracking system.

      The Changes plugin will generate a URL out of this id. The URL is constructed using the value of the issueLinkTemplate parameter.

      See the changes-report mojo for more details.

      Parameters:
      issue - a issue object.

    • setSystem

      public void setSystem(String system)
      Set id of issue tracking system. If empty 'default' value will be used.

      The Changes plugin will generate a URL out of this id. The URL is constructed using the value of the issueLinkTemplatePerSystem parameter.

      See the changes-report mojo for more details.

      Parameters:
      system - a system object.

    • setType

      public void setType(String type)
      Set supported action types are the following:
      • add: added functionality to the project.
      • fix: bug fix for the project.
      • update: updated some part of the project.
      • remove: removed some functionality from the project.
      Parameters:
      type - a type object.