Class ChangeLogMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.scm.plugin.AbstractScmMojo

org.apache.maven.scm.plugin.ChangeLogMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="changelog",
      aggregator=true)
public class ChangeLogMojo
extends AbstractScmMojo

Dump changelog contents to console. It is mainly used to test maven-scm-api's changelog command.

Field Summary

Fields

Modifier and Type	Field	Description
private String	dateFormat	Date Format in changelog output of scm tool.
private static final String	DEFAULT_DATE_FORMAT
private String	endDate	End Date.
private String	endScmVersion	End Scm Version.
private String	endScmVersionType	End Scm Version Type.
private Integer	limit	The number of change log items to return.
private Integer	numDays	The number of days to look back for change log items to return.
private String	scmBranch	The branch name (TODO find out what this is for).
private String	scmVersion	The version (revision number/branch name/tag name).
private String	scmVersionType	The version type (branch/tag) of scmVersion.
private String	startDate	Start Date.
private String	startScmVersion	Start Scm Version.
private String	startScmVersionType	Start Scm Version Type.
private String	userDateFormat	Date format to use for the specified startDate and/or endDate.

Fields inherited from class AbstractScmMojo

VALID_VERSION_TYPES, VERSION_TYPE_BRANCH, VERSION_TYPE_REVISION, VERSION_TYPE_TAG

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
ChangeLogMojo(ScmManager manager, org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

Method Summary

Modifier and Type	Method	Description
void	execute()
private Date	parseDate(SimpleDateFormat format, String date)	Converts the localized date string pattern to date object.

Methods inherited from class AbstractScmMojo

checkResult, getBasedir, getConnectionUrl, getExcludes, getFileSet, getIncludes, getScmManager, getScmRepository, getScmVersion, getWorkingDirectory, handleExcludesIncludesAfterCheckoutAndExport, setConnectionType, setConnectionUrl, setExcludes, setIncludes, setWorkingDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

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

Field Details

DEFAULT_DATE_FORMAT

private static final String DEFAULT_DATE_FORMAT

See Also:

• Constant Field Values

startDate

@Parameter(property="startDate")
private String startDate

Start Date.

endDate

@Parameter(property="endDate")
private String endDate

End Date.

startScmVersion

@Parameter(property="startScmVersion")
private String startScmVersion

Start Scm Version.

endScmVersion

@Parameter(property="endScmVersion")
private String endScmVersion

End Scm Version.

startScmVersionType

@Parameter(property="startScmVersionType")
private String startScmVersionType

Start Scm Version Type.

endScmVersionType

@Parameter(property="endScmVersionType")
private String endScmVersionType

End Scm Version Type.

dateFormat

@Parameter(property="dateFormat")
private String dateFormat

Date Format in changelog output of scm tool.

userDateFormat

@Parameter(property="userDateFormat",
           defaultValue="yyyy-MM-dd")
private String userDateFormat

Date format to use for the specified startDate and/or endDate.

scmVersionType

@Parameter(property="scmVersionType")
private String scmVersionType

The version type (branch/tag) of scmVersion.

scmVersion

@Parameter(property="scmVersion")
private String scmVersion

The version (revision number/branch name/tag name).

scmBranch

@Parameter(property="scmBranch")
private String scmBranch

The branch name (TODO find out what this is for).

limit

@Parameter(property="limit")
private Integer limit

The number of change log items to return.

numDays

@Parameter(property="numDays")
private Integer numDays

The number of days to look back for change log items to return.

Constructor Details

ChangeLogMojo

@Inject
public ChangeLogMojo(ScmManager manager,
 org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractScmMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

parseDate

private Date parseDate(SimpleDateFormat format,
 String date)
                throws org.apache.maven.plugin.MojoExecutionException

Converts the localized date string pattern to date object.

Returns:

a date

Throws:

org.apache.maven.plugin.MojoExecutionException