org.apache.maven.plugins.changes.model
Class Action

java.lang.Object
  org.apache.maven.plugins.changes.model.Action

All Implemented Interfaces:

Serializable

public class Action
extends Object
implements Serializable

A single action done on the project, during this release.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Action()

Method Summary

void	addDueTo(DueTo dueTo) Method addDueTo.
void	addFixedIssue(FixedIssue fixedIssue) Method addFixedIssue.
String	getAction() Get a short description of the action taken.
String	getDate() Get fix date.
String	getDev() Get Name of developer who committed the change.
String	getDueTo() Get name of the person to be credited for this change.
String	getDueToEmail() Get email of the person to be credited for this change.
List<DueTo>	getDueTos() Method getDueTos.
List<FixedIssue>	getFixedIssues() Method getFixedIssues.
String	getIssue() Get Id of the issue related to this change.
String	getSystem() Get Id of issue tracking system.
String	getType() Get supported action types are the following: add : added functionnality to the project.
void	removeDueTo(DueTo dueTo) Method removeDueTo.
void	removeFixedIssue(FixedIssue fixedIssue) Method removeFixedIssue.
void	setAction(String action) Set a short description of the action taken.
void	setDate(String date) Set fix date.
void	setDev(String dev) Set Name of developer who committed the change.
void	setDueTo(String dueTo) Set name of the person to be credited for this change.
void	setDueToEmail(String dueToEmail) Set email of the person to be credited for this change.
void	setDueTos(List<DueTo> dueTos) Set a list of contributors for this issue.
void	setFixedIssues(List<FixedIssue> fixedIssues) Set a list of fix issues.
void	setIssue(String issue) Set Id of the issue related to this change.
void	setSystem(String system) Set Id of issue tracking system.
void	setType(String type) Set supported action types are the following: add : added functionnality to the project.

Methods inherited from class java.lang.Object

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

Constructor Detail

Action

public Action()

Method Detail

addDueTo

public void addDueTo(DueTo dueTo)

Method addDueTo.

Parameters:

dueTo -

addFixedIssue

public void addFixedIssue(FixedIssue fixedIssue)

Method addFixedIssue.

Parameters:

fixedIssue -

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-list.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.

Returns:

String

getDueToEmail

public String getDueToEmail()

Get email of the person to be credited for this change.

Returns:

String

getDueTos

public List<DueTo> getDueTos()

Method getDueTos.

Returns:

List

getFixedIssues

public List<FixedIssue> getFixedIssues()

Method getFixedIssues.

Returns:

List

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 use.

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 functionnality to the project.
• fix : bug fix for the project.
• update : updated some part of the project.
• remove : removed some functionnality from the project.

Returns:

String

removeDueTo

public void removeDueTo(DueTo dueTo)

Method removeDueTo.

Parameters:

dueTo -

removeFixedIssue

public void removeFixedIssue(FixedIssue fixedIssue)

Method removeFixedIssue.

Parameters:

fixedIssue -

setAction

public void setAction(String action)

Set a short description of the action taken.

Parameters:

action -

setDate

public void setDate(String date)

Set fix date.

Parameters:

date -

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-list.html page.

Parameters:

dev -

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.

Parameters:

dueTo -

setDueToEmail

public void setDueToEmail(String dueToEmail)

Set email of the person to be credited for this change.

Parameters:

dueToEmail -

setDueTos

public void setDueTos(List<DueTo> dueTos)

Set a list of contributors for this issue.

Parameters:

dueTos -

setFixedIssues

public void setFixedIssues(List<FixedIssue> fixedIssues)

Set a list of fix issues.

Parameters:

fixedIssues -

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 -

setSystem

public void setSystem(String system)

Set

Id of issue tracking system. If empty 'default' value will be use.

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 -

setType

public void setType(String type)

Set supported action types are the following:

• add : added functionnality to the project.
• fix : bug fix for the project.
• update : updated some part of the project.
• remove : removed some functionnality from the project.

Parameters:

type -