Package org.codehaus.mojo.buildhelper

Class TimestampPropertyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.buildhelper.AbstractDefinePropertyMojo

org.codehaus.mojo.buildhelper.TimestampPropertyMojo

All Implemented Interfaces:

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

@Mojo(name="timestamp-property",
      defaultPhase=VALIDATE,
      threadSafe=true)
public class TimestampPropertyMojo
extends AbstractDefinePropertyMojo

Sets a property based on the current date and time.

Since:

1.7

Field Summary

Fields

Modifier and Type	Field	Description
private String	locale	The locale to use, for example en,US.
private org.apache.maven.execution.MavenSession	mavenSession	The Maven Session.
private String	name	The property to set.
private int	offset	An offset to apply to the current time.
private String	pattern	The date/time pattern to be used.
private String	timeSource	The source of the time.
private String	timeZone	The timezone to use for displaying time.
private String	unit	The unit of the offset to be applied to the current time.

Fields inherited from class org.codehaus.mojo.buildhelper.AbstractDefinePropertyMojo

project

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

ROLE

Constructor Summary

Constructors

Constructor	Description
TimestampPropertyMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

Methods inherited from class org.codehaus.mojo.buildhelper.AbstractDefinePropertyMojo

defineProperty, getProject

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

Field Details

name

@Parameter(required=true)
private String name

The property to set.

pattern

@Parameter
private String pattern

The date/time pattern to be used. The values are as defined by the Java SimpleDateFormat class.

timeZone

@Parameter(defaultValue="GMT")
private String timeZone

The timezone to use for displaying time. The values are as defined by the Java {$link TimeZone} class.

offset

@Parameter(defaultValue="0")
private int offset

An offset to apply to the current time.

unit

@Parameter(defaultValue="second")
private String unit

The unit of the offset to be applied to the current time. Valid Values are

• millisecond
• second
• minute
• hour
• day
• week
• month
• year

timeSource

@Parameter(defaultValue="current")
private String timeSource

The source of the time. Valid Values are

• current
• build

Since:

3.2.0

locale

@Parameter
private String locale

The locale to use, for example en,US.

mavenSession

@Parameter(readonly=true,
           defaultValue="${session}")
private org.apache.maven.execution.MavenSession mavenSession

The Maven Session.

Since:

3.2.0

Constructor Details

TimestampPropertyMojo

public TimestampPropertyMojo()

Method Details

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException