Package org.apache.maven.scm.plugin
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 java.lang.String
dateFormat
Date Format in changelog output of scm tool.private static java.lang.String
DEFAULT_DATE_FORMAT
private java.lang.String
endDate
End Date.private java.lang.String
endScmVersion
End Scm Version.private java.lang.String
endScmVersionType
End Scm Version Type.private java.lang.Integer
limit
The number of change log items to return.private java.lang.Integer
numDays
The number of days to look back for change log items to return.private java.lang.String
scmBranch
The branch name (TODO find out what this is for).private java.lang.String
scmVersion
The version (revision number/branch name/tag name).private java.lang.String
scmVersionType
The version type (branch/tag) of scmVersion.private java.lang.String
startDate
Start Date.private java.lang.String
startScmVersion
Start Scm Version.private java.lang.String
startScmVersionType
Start Scm Version Type.private java.lang.String
userDateFormat
Date format to use for the specified startDate and/or endDate.-
Fields inherited from class org.apache.maven.scm.plugin.AbstractScmMojo
VALID_VERSION_TYPES, VERSION_TYPE_BRANCH, VERSION_TYPE_REVISION, VERSION_TYPE_TAG
-
-
Constructor Summary
Constructors Constructor Description ChangeLogMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute()
private java.util.Date
parseDate(java.text.SimpleDateFormat format, java.lang.String date)
Converts the localized date string pattern to date object.-
Methods inherited from class org.apache.maven.scm.plugin.AbstractScmMojo
checkResult, getBasedir, getConnectionUrl, getExcludes, getFileSet, getIncludes, getScmManager, getScmRepository, getScmVersion, getWorkingDirectory, handleExcludesIncludesAfterCheckoutAndExport, setConnectionType, setConnectionUrl, setExcludes, setIncludes, setWorkingDirectory
-
-
-
-
Field Detail
-
DEFAULT_DATE_FORMAT
private static final java.lang.String DEFAULT_DATE_FORMAT
- See Also:
- Constant Field Values
-
startDate
@Parameter(property="startDate") private java.lang.String startDate
Start Date.
-
endDate
@Parameter(property="endDate") private java.lang.String endDate
End Date.
-
startScmVersion
@Parameter(property="startScmVersion") private java.lang.String startScmVersion
Start Scm Version.
-
endScmVersion
@Parameter(property="endScmVersion") private java.lang.String endScmVersion
End Scm Version.
-
startScmVersionType
@Parameter(property="startScmVersionType") private java.lang.String startScmVersionType
Start Scm Version Type.
-
endScmVersionType
@Parameter(property="endScmVersionType") private java.lang.String endScmVersionType
End Scm Version Type.
-
dateFormat
@Parameter(property="dateFormat") private java.lang.String dateFormat
Date Format in changelog output of scm tool.
-
userDateFormat
@Parameter(property="userDateFormat", defaultValue="yyyy-MM-dd") private java.lang.String userDateFormat
Date format to use for the specified startDate and/or endDate.
-
scmVersionType
@Parameter(property="scmVersionType") private java.lang.String scmVersionType
The version type (branch/tag) of scmVersion.
-
scmVersion
@Parameter(property="scmVersion") private java.lang.String scmVersion
The version (revision number/branch name/tag name).
-
scmBranch
@Parameter(property="scmBranch") private java.lang.String scmBranch
The branch name (TODO find out what this is for).
-
limit
@Parameter(property="limit") private java.lang.Integer limit
The number of change log items to return.
-
numDays
@Parameter(property="numDays") private java.lang.Integer numDays
The number of days to look back for change log items to return.
-
-
Method Detail
-
execute
public void execute() throws org.apache.maven.plugin.MojoExecutionException
- Specified by:
execute
in interfaceorg.apache.maven.plugin.Mojo
- Overrides:
execute
in classAbstractScmMojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
-
parseDate
private java.util.Date parseDate(java.text.SimpleDateFormat format, java.lang.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
-
-