DateUtils.java

/*
 *   __               .__       .__  ._____.           
 * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
 * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
 *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
 *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
 *                   \/       \/             \/     \/ 
 *
 * Copyright (c) 2006-2011 Karsten Schmidt
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * http://creativecommons.org/licenses/LGPL/2.1/
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */

package spimedb.util;

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;

/**
 * A Simple timestamp generator/formatter with timezone support.
 */
public class DateUtils {

    public static final TimeZone GMT = TimeZone.getTimeZone("GMT");

    public static final SimpleDateFormat FORMAT = new SimpleDateFormat(
            "yyyyMMdd-HHmmss");

    /**
     * Creates a formatted timestamp string of the current datetime using the
     * local host timezone.
     * 
     * @return timestamp
     */
    public static String timeStamp() {
        return timeStamp(new Date(), null);
    }

    /**
     * Creates a formatted timestamp string of the given date using the local
     * host timezone.
     * 
     * @param date
     * @return timestamp
     */
    public static String timeStamp(Date date) {
        return timeStamp(date, null);
    }

    /**
     * Creates a formatted timestamp string of the given date using the
     * specified timezone.
     * 
     * @param date
     * @param zone
     * @return timestamp
     */
    public static String timeStamp(Date date, TimeZone zone) {
        if (zone == null) {
            zone = TimeZone.getDefault();
        }
        FORMAT.setTimeZone(zone);
        return FORMAT.format(date);
    }

    /**
     * Creates a formatted timestamp string of the given epoch using the local
     * host timezone.
     * 
     * @param t
     *            unix epoch timestamp
     * @return timestamp
     */
    public static String timeStamp(long t) {
        return timeStamp(new Date(t), null);
    }

    /**
     * Creates a formatted timestamp string of the given date using the given
     * timezone ID.
     * 
     * @see TimeZone#getTimeZone(String)
     * 
     * @param zoneID
     * @param date
     * @return timestamp
     */
    public static String timeStampForZone(String zoneID, Date date) {
        return timeStamp(date, TimeZone.getTimeZone(zoneID));
    }

    /**
     * Creates a formatted timestamp string of the current date in GMT.
     * 
     * @return timestamp
     */
    public static String timeStampGMT() {
        return timeStamp(new Date(), GMT);
    }

    /**
     * Creates a formatted timestamp string of the given date in GMT.
     * 
     * @return timestamp
     */
    public static String timeStampGMT(Date date) {
        return timeStamp(date, GMT);
    }

    /**
     * Creates a formatted timestamp string of the given epoch in GMT.
     * 
     * @return timestamp
     */
    public static String timeStampGMT(long t) {
        return timeStamp(new Date(t), GMT);
    }
}