Package org.apache.maven.plugins.changes

Class ChangesCheckMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.changes.AbstractChangesMojo

org.apache.maven.plugins.changes.ChangesCheckMojo

All Implemented Interfaces:

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

@Mojo(name="changes-check",
      threadSafe=true)
public class ChangesCheckMojo
extends AbstractChangesMojo

Goal which checks that the changes.xml file has the necessary data to generate an announcement or a report for the current release.

Since:

2.4

Author:

Justin Edelson, Dennis Lundberg

Field Summary

Fields inherited from class org.apache.maven.plugins.changes.AbstractChangesMojo

basedir, mavenSession, runOnlyAtExecutionRoot

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

ROLE

Constructor Summary

Constructors

Constructor	Description
ChangesCheckMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Check that the latest release contains a valid release date.
protected static boolean	isValidDate(String string, String pattern)	Use the pattern to try to parse a Date from the given string.
protected static boolean	isValidDate(String string, String pattern, String locale)	Use the pattern to try to parse a Date from the given string using the given Locale.

Methods inherited from class org.apache.maven.plugins.changes.AbstractChangesMojo

isThisTheExecutionRoot

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Details

ChangesCheckMojo

public ChangesCheckMojo()

Method Details

execute

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

Check that the latest release contains a valid release date.

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of errors.

isValidDate

protected static boolean isValidDate(String string,
 String pattern)

Use the pattern to try to parse a Date from the given string. Kept for backward compatibility with existing unit tests.

Parameters:

string - A date as text

pattern - A pattern that can be used by SimpleDateFormat

Returns:

true if the string can be parsed as a date using the pattern, otherwise false

isValidDate

protected static boolean isValidDate(String string,
 String pattern,
 String locale)

Use the pattern to try to parse a Date from the given string using the given Locale.

Parameters:

string - A date as text

pattern - A pattern that can be used by SimpleDateFormat

locale - A locale that can be used by SimpleDateFormat

Returns:

true if the string can be parsed as a date using the pattern, otherwise false