/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowledgement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgement may appear in the software itself,
 *    if and wherever such third-party acknowledgements normally appear.
 *
 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */
package org.apache.commons.lang.time;

import java.util.Date;
import java.util.Locale;
import java.util.TimeZone;

/**
 * <p>日付と時間のフォーマットを行うユーティリティと定数です。
 * {@primary  Date and time formatting utilites and constants.}</p>
 *
 * <p>フォーマットは {@link org.apache.commons.lang.time.FastDateFormat}
 * クラスを使用して行われます。
 * {@primary Formatting is performed using the
 * {@link org.apache.commons.lang.time.FastDateFormat} class.}</p>
 *
 * @author Apache Ant - DateUtils
 * @author <a href="mailto:sbailliez@apache.org">Stephane Bailliez</a>
 * @author <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a>
 * @author Stephen Colebourne
 * @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
 * @translator 日置 聡
 * @status firstdraft
 * @update 2003/09/21
 * @memo 2.0新規
 * @since 2.0
 * @version $Id: DateFormatUtils.java,v 1.1.1.1 2004/02/13 10:02:05 hioki Exp $
 */
public class DateFormatUtils {

    /**
     * タイムゾーンを含まない ISO8601 の日付-時間のフォーマッターです。
     * 使用されるフォーマットは <tt>yyyy-MM-dd'T'HH:mm:ss</tt> です。
     * {@primary ISO8601 formatter for date-time witout time zone.
     * The format used is <tt>yyyy-MM-dd'T'HH:mm:ss</tt>.}
     */
    public static final FastDateFormat ISO_DATETIME_FORMAT
            = FastDateFormat.getInstance("yyyy-MM-dd'T'HH:mm:ss");

    /**
     * タイムゾーンを含む ISO8601 の日付-時間のフォーマッターです。
     * 使用されるフォーマットは <tt>yyyy-MM-dd'T'HH:mm:ssZZ</tt> です。
     * {@primary ISO8601 formatter for date-time with time zone.
     * The format used is <tt>yyyy-MM-dd'T'HH:mm:ssZZ</tt>.}
     */
    public static final FastDateFormat ISO_DATETIME_TIME_ZONE_FORMAT
            = FastDateFormat.getInstance("yyyy-MM-dd'T'HH:mm:ssZZ");

    /**
     * タイムゾーンを含まない ISO8601 の日付のフォーマッターです。
     * 使用されるフォーマットは <tt>yyyy-MM-dd</tt> です。
     * {@primary ISO8601 formatter for date without time zone.
     * The format used is <tt>yyyy-MM-dd</tt>.}
     */
    public static final FastDateFormat ISO_DATE_FORMAT
            = FastDateFormat.getInstance("yyyy-MM-dd");

    /**
     * タイムゾーンを含む ISO8601 に似た日付のフォーマッターです。
     * 使用されるフォーマットは <tt>yyyy-MM-ddZZ</tt> です。
     * 正式な ISO8601 の仕様では時間を省略した場合のタイムゾーンの指定を許可しないためこのパターンは仕様に準じていません。
     * {@primary ISO8601-like formatter for date with time zone.
     * The format used is <tt>yyyy-MM-ddZZ</tt>.
     * This pattern does not comply with the formal ISO8601 specification
     * as the standard does not allow a time zone  without a time.}
     */
    public static final FastDateFormat ISO_DATE_TIME_ZONE_FORMAT
            = FastDateFormat.getInstance("yyyy-MM-ddZZ");

    /**
     * タイムゾーンを含まない ISO8601 の時間のフォーマッターです。
     * 使用されるフォーマットは <tt>'T'HH:mm:ss</tt> です。
     * {@primary ISO8601 formatter for time without time zone.
     * The format used is <tt>'T'HH:mm:ss</tt>.}
     */
    public static final FastDateFormat ISO_TIME_FORMAT
            = FastDateFormat.getInstance("'T'HH:mm:ss");

    /**
     * タイムゾーンを含む ISO8601 の時間のフォーマッターです。
     * 使用されるフォーマットは <tt>'T'HH:mm:ssZZ</tt> です。
     * {@primary ISO8601 formatter for time with time zone.
     * The format used is <tt>'T'HH:mm:ssZZ</tt>.}
     */
    public static final FastDateFormat ISO_TIME_TIME_ZONE_FORMAT
            = FastDateFormat.getInstance("'T'HH:mm:ssZZ");

    /**
     * タイムゾーンを含まない ISO8601 に似た時間のフォーマッターです。
     * 使用されるフォーマットは <tt>HH:mm:ss</tt> です。
     * 正式な ISO8601 の仕様では時間には 'T' プレフィックスを要求するため、このパターンは仕様に準じていません。
     * {@primary ISO8601-like formatter for time without time zone.
     * The format used is <tt>HH:mm:ss</tt>.
     * This pattern does not comply with the formal ISO8601 specification
     * as the standard requires the 'T' prefix for times.}
     */
    public static final FastDateFormat ISO_TIME_NO_T_FORMAT
            = FastDateFormat.getInstance("HH:mm:ss");

    /**
     * タイムゾーンを含む ISO8601 に似た時間のフォーマッターです。
     * 使用されるフォーマットは <tt>HH:mm:ssZZ</tt> です。
     * 正式な ISO8601 の仕様では時間には 'T' プレフィックスを要求するため、このパターンは仕様に準じていません。
     * {@primary ISO8601-like formatter for time with time zone.
     * The format used is <tt>HH:mm:ssZZ</tt>.
     * This pattern does not comply with the formal ISO8601 specification
     * as the standard requires the 'T' prefix for times.}
     */
    public static final FastDateFormat ISO_TIME_NO_T_TIME_ZONE_FORMAT
            = FastDateFormat.getInstance("HH:mm:ssZZ");

    /**
     * SMTP(等で使用される)日付のヘッダの様式です。
     * US ロケールでは <tt>EEE, dd MMM yyyy HH:mm:ss Z</tt> のフォーマットが使用されます。
     * {@primary SMTP (and probably other) date headers.
     * The format used is <tt>EEE, dd MMM yyyy HH:mm:ss Z</tt> in US locale.}
     */
    public static final FastDateFormat SMTP_DATETIME_FORMAT
            = FastDateFormat.getInstance("EEE, dd MMM yyyy HH:mm:ss Z", Locale.US);

    //-----------------------------------------------------------------------
    /**
     * <p>DateFormatUtils のインスタンスは一般的なプログラムからは生成すべきではありません。
     * {@primary DateFormatUtils instances should NOT be constructed in standard programming.}</p>
     *
     * <p>このコンストラクタは、処理のために JavaBean インスタンスを必要とするツールのために
     * public になっています。 
     * {@primary This constructor is public to permit tools that require a JavaBean instance
     * to operate.}</p>
     */
    public DateFormatUtils() {
    }

    /**
     * <p>指定されたパターンと UTC タイムゾーンを用いて日付/時間をフォーマットします。
     * {@primary Format a date/time into a specific pattern using the UTC time zone.}</p>
     * 
     * @param millis  ミリセカンドで表現されたフォーマットの対象となる日付
     * {@primary the date to format expressed in milliseconds}
     * @param pattern  日付をフォーマットする際に使用されるパターン
     * {@primary the pattern to use to format the date}
     * @return フォーマットされた日付
     * {@primary the formatted date}
     */
    public static String formatUTC(long millis, String pattern) {
        return format(new Date(millis), pattern, DateUtils.UTC_TIME_ZONE, null);
    }

    /**
     * <p>指定されたパターンと UTC タイムゾーンを用いて日付/時間をフォーマットします。
     * {@primary Format a date/time into a specific pattern using the UTC time zone.}</p>
     * 
     * @param date  フォーマットの対象となる日付
     * {@primary the date to format}
     * @param pattern  日付をフォーマットする際に使用されるパターン
     * {@primary the pattern to use to format the date}
     * @return フォーマットされた日付
     * {@primary the formatted date}
     */
    public static String formatUTC(Date date, String pattern) {
        return format(date, pattern, DateUtils.UTC_TIME_ZONE, null);
    }
    
    /**
     * <p>指定されたパターンと UTC タイムゾーンを用いて日付/時間をフォーマットします。
     * {@primary Format a date/time into a specific pattern using the UTC time zone.}</p>
     * 
     * @param millis  ミリセカンドで表現されたフォーマットの対象となる日付
     * {@primary the date to format expressed in milliseconds}
     * @param pattern  日付をフォーマットする際に使用されるパターン
     * {@primary the pattern to use to format the date}
     * @param locale  使用するロケール、 <code>null</code> を許容します。
     * {@primary the locale to use, may be <code>null</code>}
     * @return フォーマットされた日付
     * {@primary the formatted date}
     */
    public static String formatUTC(long millis, String pattern, Locale locale) {
        return format(new Date(millis), pattern, DateUtils.UTC_TIME_ZONE, locale);
    }

    /**
     * <p>指定されたパターンと UTC タイムゾーンを用いて日付/時間をフォーマットします。
     * {@primary Format a date/time into a specific pattern using the UTC time zone.}</p>
     * 
     * @param date  フォーマットの対象となる日付
     * {@primary the date to format}
     * @param pattern  日付をフォーマットする際に使用されるパターン
     * {@primary the pattern to use to format the date}
     * @param locale  使用するロケール、 <code>null</code> を許容します。
     * {@primary the locale to use, may be <code>null</code>}
     * @return フォーマットされた日付
     * {@primary the formatted date}
     */
    public static String formatUTC(Date date, String pattern, Locale locale) {
        return format(date, pattern, DateUtils.UTC_TIME_ZONE, locale);
    }
    
    /**
     * <p>指定されたパターンで日付/時間をフォーマットします。
     * {@primary Format a date/time into a specific pattern.}</p>
     * 
     * @param millis  ミリセカンドで表現されたフォーマットの対象となる日付
     * {@primary the date to format expressed in milliseconds}
     * @param pattern  日付をフォーマットする際に使用されるパターン
     * {@primary the pattern to use to format the date}
     * @return フォーマットされた日付
     * {@primary the formatted date}
     */
    public static String format(long millis, String pattern) {
        return format(new Date(millis), pattern, null, null);
    }

    /**
     * <p>指定されたパターンで日付/時間をフォーマットします。
     * {@primary Format a date/time into a specific pattern.}</p>
     * 
     * @param date  フォーマットの対象となる日付
     * {@primary the date to format}
     * @param pattern  日付をフォーマットする際に使用されるパターン
     * {@primary the pattern to use to format the date}
     * @return フォーマットされた日付
     * {@primary the formatted date}
     */
    public static String format(Date date, String pattern) {
        return format(date, pattern, null, null);
    }
    
    /**
     * <p>指定されたパターンと指定されたタイムゾーンを用いて日付/時間をフォーマットします。
     * {@primary Format a date/time into a specific pattern in a time zone.}</p>
     * 
     * @param millis  ミリセカンドで表現されたフォーマットの対象となる日付
     * {@primary the date to format expressed in milliseconds}
     * @param pattern  日付をフォーマットする際に使用されるパターン
     * {@primary the pattern to use to format the date}
     * @param timeZone  使用するタイムゾーン、 <code>null</code> を許容します。
     * {@primary the time zone  to use, may be <code>null</code>}
     * @return フォーマットされた日付
     * {@primary the formatted date}
     */
    public static String format(long millis, String pattern, TimeZone timeZone) {
        return format(new Date(millis), pattern, timeZone, null);
    }

    /**
     * <p>指定されたパターンと指定されたタイムゾーンを用いて日付/時間をフォーマットします。
     * {@primary Format a date/time into a specific pattern in a time zone.}</p>
     * 
     * @param date  フォーマットの対象となる日付
     * {@primary the date to format}
     * @param pattern  日付をフォーマットする際に使用されるパターン
     * {@primary the pattern to use to format the date}
     * @param timeZone  使用するタイムゾーン、 <code>null</code> を許容します。
     * {@primary the time zone  to use, may be <code>null</code>}
     * @return フォーマットされた日付
     * {@primary the formatted date}
     */
    public static String format(Date date, String pattern, TimeZone timeZone) {
        return format(date, pattern, timeZone, null);
    }

    /**
     * <p>指定されたパターンと指定されたロケールを用いて日付/時間をフォーマットします。
     * {@primary Format a date/time into a specific pattern in a locale.}</p>
     * 
     * @param millis  ミリセカンドで表現されたフォーマットの対象となる日付
     * {@primary the date to format expressed in milliseconds}
     * @param pattern  日付をフォーマットする際に使用されるパターン
     * {@primary the pattern to use to format the date}
     * @param locale  使用するロケール、 <code>null</code> を許容します。
     * {@primary the locale to use, may be <code>null</code>}
     * @return フォーマットされた日付
     * {@primary the formatted date}
     */
    public static String format(long millis, String pattern, Locale locale) {
        return format(new Date(millis), pattern, null, locale);
    }

    /**
     * <p>指定されたパターンと指定されたロケールを用いて日付/時間をフォーマットします。
     * {@primary Format a date/time into a specific pattern in a locale.}</p>
     * 
     * @param date  フォーマットの対象となる日付
     * {@primary the date to format}
     * @param pattern  日付をフォーマットする際に使用されるパターン
     * {@primary the pattern to use to format the date}
     * @param locale  使用するロケール、 <code>null</code> を許容します。
     * {@primary the locale to use, may be <code>null</code>}
     * @return フォーマットされた日付
     * {@primary the formatted date}
     */
    public static String format(Date date, String pattern, Locale locale) {
        return format(date, pattern, null, locale);
    }

    /**
     * <p>指定されたパターン、タイムゾーン、ロケールを用いて日付/時間をフォーマットします。
     * {@primary Format a date/time into a specific pattern in a time zone  and locale.}</p>
     * 
     * @param millis  ミリセカンドで表現されたフォーマットの対象となる日付
     * {@primary the date to format expressed in milliseconds}
     * @param pattern  日付をフォーマットする際に使用されるパターン
     * {@primary the pattern to use to format the date}
     * @param timeZone  使用するタイムゾーン、 <code>null</code> を許容します。
     * {@primary the time zone  to use, may be <code>null</code>}
     * @param locale  使用するロケール、 <code>null</code> を許容します。
     * {@primary the locale to use, may be <code>null</code>}
     * @return フォーマットされた日付
     * {@primary the formatted date}
     */
    public static String format(long millis, String pattern, TimeZone timeZone, Locale locale) {
        return format(new Date(millis), pattern, timeZone, locale);
    }

    /**
     * <p>指定されたパターン、タイムゾーン、ロケールを用いて日付/時間をフォーマットします。
     * {@primary Format a date/time into a specific pattern in a time zone  and locale.}</p>
     * 
     * @param date  フォーマットの対象となる日付
     * {@primary the date to format}
     * @param pattern  日付をフォーマットする際に使用されるパターン
     * {@primary the pattern to use to format the date}
     * @param timeZone  使用するタイムゾーン、 <code>null</code> を許容します。
     * {@primary the time zone  to use, may be <code>null</code>}
     * @param locale  使用するロケール、 <code>null</code> を許容します。
     * {@primary the locale to use, may be <code>null</code>}
     * @return フォーマットされた日付
     * {@primary the formatted date}
     */
    public static String format(Date date, String pattern, TimeZone timeZone, Locale locale) {
        FastDateFormat df = FastDateFormat.getInstance(pattern, timeZone, locale);
        return df.format(date);
    }

}