org.codehaus.mojo.buildhelper.TimestampPropertyMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of build-helper-maven-plugin Show documentation
This plugin contains various small independent goals to assist with Maven build lifecycle
There is a newer version: 3.6.0
Show newest version
package org.codehaus.mojo.buildhelper;

/*
 * The MIT License
 *
 * Copyright (c) 2004, The Codehaus
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Locale;
import java.util.TimeZone;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

/**
 * Sets a property based on the current date and time.
 *
 * @author Stephen Connolly
 * @description Sets a property to the current time
 * @since 1.7
 */
@Mojo( name = "timestamp-property", defaultPhase = LifecyclePhase.VALIDATE, threadSafe = true )
public class TimestampPropertyMojo
    extends AbstractDefinePropertyMojo
{

    /**
     * The property to set.
     */
    @Parameter( required = true )
    private String name;

    /**
     * The date/time pattern to be used. The values are as defined by the Java SimpleDateFormat class.
     */
    @Parameter
    private String pattern;

    /**
     * The timezone to use for displaying time. The values are as defined by the Java {$link TimeZone} class.
     */
    @Parameter( defaultValue = "GMT" )
    private String timeZone;

    /**
     * An offset to apply to the current time.
     */
    @Parameter( defaultValue = "0" )
    private int offset;

    /**
     * The unit of the offset to be applied to the current time. Valid Values are
     * 
     * millisecond
     * second
     * minute
     * hour
     * day
     * week
     * month
     * year
     * 
     */
    @Parameter( defaultValue = "second" )
    private String unit;

    /**
     * The locale to use, for example en,US.
     */
    @Parameter
    private String locale;

    /**
     * {@inheritDoc}
     */
    public void execute()
        throws MojoExecutionException, MojoFailureException
    {
        Locale locale;
        if ( this.locale != null )
        {
            String[] bits = this.locale.split( "[,_]" );
            if ( bits.length == 1 )
            {
                locale = new Locale( bits[0].trim() );
            }
            else if ( bits.length == 2 )
            {
                locale = new Locale( bits[0].trim(), bits[1].trim() );
            }
            else if ( bits.length == 3 )
            {
                locale = new Locale( bits[0].trim(), bits[1].trim(), bits[2].trim() );
            }
            else
            {
                throw new MojoExecutionException( "expecting language,country,variant but got more than three parts" );
            }
        }
        else
        {
            locale = Locale.getDefault();
            getLog().warn( "Using platform locale (" + locale.toString()
                               + " actually) to format date/time, i.e. build is platform dependent!" );
        }

        DateFormat format;
        if ( pattern == null )
        {
            format = DateFormat.getDateTimeInstance( DateFormat.SHORT, DateFormat.SHORT, locale );
        }
        else
        {
            try
            {
                format = new SimpleDateFormat( pattern, locale );
            }
            catch ( IllegalArgumentException e )
            {
                throw new MojoExecutionException( e.getMessage(), e );
            }
        }

        TimeZone timeZone;
        if ( this.timeZone != null )
        {
            timeZone = TimeZone.getTimeZone( this.timeZone );
        }
        else
        {
            timeZone = TimeZone.getTimeZone( "GMT" );
        }

        Date now = new Date();
        Calendar calendar = new GregorianCalendar();
        calendar.setTime( now );
        calendar.setTimeZone( timeZone );
        if ( offset != 0 && unit != null )
        {
            unit = unit.toLowerCase();
            if ( unit.indexOf( "millisecond" ) == 0 )
            {
                calendar.add( Calendar.MILLISECOND, offset );
            }
            else if ( unit.indexOf( "second" ) == 0 )
            {
                calendar.add( Calendar.SECOND, offset );
            }
            else if ( unit.indexOf( "minute" ) == 0 )
            {
                calendar.add( Calendar.MINUTE, offset );
            }
            else if ( unit.indexOf( "hour" ) == 0 )
            {
                calendar.add( Calendar.HOUR, offset );
            }
            else if ( unit.indexOf( "day" ) == 0 )
            {
                calendar.add( Calendar.DAY_OF_MONTH, offset );
            }
            else if ( unit.indexOf( "week" ) == 0 )
            {
                calendar.add( Calendar.WEEK_OF_YEAR, offset );
            }
            else if ( unit.indexOf( "month" ) == 0 )
            {
                calendar.add( Calendar.MONTH, offset );
            }
            else if ( unit.indexOf( "year" ) == 0 )
            {
                calendar.add( Calendar.YEAR, offset );
            }
        }

        format.setTimeZone( timeZone );

        defineProperty( name, format.format( calendar.getTime() ) );
    }

}