- /* ====================================================================
- * 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>Date and time formatting utilites and constants.</p>
- *
- * <p>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>
- * @since 2.0
- * @version $Id: DateFormatUtils.java,v 1.7 2003/08/18 02:22:25 bayard Exp $
- */
- public class DateFormatUtils {
-
- /**
- * 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 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 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-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 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 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-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-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 (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 instances should NOT be constructed in standard programming.</p>
- *
- * <p>This constructor is public to permit tools that require a JavaBean instance
- * to operate.</p>
- */
- public DateFormatUtils() {
- }
-
- /**
- * <p>Format a date/time into a specific pattern using the UTC time zone.</p>
- *
- * @param millis the date to format expressed in milliseconds
- * @param pattern the pattern to use to format the date
- * @return the formatted date
- */
- public static String formatUTC(long millis, String pattern) {
- return format(new Date(millis), pattern, DateUtils.UTC_TIME_ZONE, null);
- }
-
- /**
- * <p>Format a date/time into a specific pattern using the UTC time zone.</p>
- *
- * @param date the date to format
- * @param pattern the pattern to use to format the date
- * @return the formatted date
- */
- public static String formatUTC(Date date, String pattern) {
- return format(date, pattern, DateUtils.UTC_TIME_ZONE, null);
- }
-
- /**
- * <p>Format a date/time into a specific pattern using the UTC time zone.</p>
- *
- * @param millis the date to format expressed in milliseconds
- * @param pattern the pattern to use to format the date
- * @param locale the locale to use, may be <code>null</code>
- * @return 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>Format a date/time into a specific pattern using the UTC time zone.</p>
- *
- * @param date the date to format
- * @param pattern the pattern to use to format the date
- * @param locale the locale to use, may be <code>null</code>
- * @return the formatted date
- */
- public static String formatUTC(Date date, String pattern, Locale locale) {
- return format(date, pattern, DateUtils.UTC_TIME_ZONE, locale);
- }
-
- /**
- * <p>Format a date/time into a specific pattern.</p>
- *
- * @param millis the date to format expressed in milliseconds
- * @param pattern the pattern to use to format the date
- * @return the formatted date
- */
- public static String format(long millis, String pattern) {
- return format(new Date(millis), pattern, null, null);
- }
-
- /**
- * <p>Format a date/time into a specific pattern.</p>
- *
- * @param date the date to format
- * @param pattern the pattern to use to format the date
- * @return the formatted date
- */
- public static String format(Date date, String pattern) {
- return format(date, pattern, null, null);
- }
-
- /**
- * <p>Format a date/time into a specific pattern in a time zone.</p>
- *
- * @param millis the time expressed in milliseconds
- * @param pattern the pattern to use to format the date
- * @param timeZone the time zone to use, may be <code>null</code>
- * @return the formatted date
- */
- public static String format(long millis, String pattern, TimeZone timeZone) {
- return format(new Date(millis), pattern, timeZone, null);
- }
-
- /**
- * <p>Format a date/time into a specific pattern in a time zone.</p>
- *
- * @param date the date to format
- * @param pattern the pattern to use to format the date
- * @param timeZone the time zone to use, may be <code>null</code>
- * @return the formatted date
- */
- public static String format(Date date, String pattern, TimeZone timeZone) {
- return format(date, pattern, timeZone, null);
- }
-
- /**
- * <p>Format a date/time into a specific pattern in a locale.</p>
- *
- * @param millis the date to format expressed in milliseconds
- * @param pattern the pattern to use to format the date
- * @param locale the locale to use, may be <code>null</code>
- * @return the formatted date
- */
- public static String format(long millis, String pattern, Locale locale) {
- return format(new Date(millis), pattern, null, locale);
- }
-
- /**
- * <p>Format a date/time into a specific pattern in a locale.</p>
- *
- * @param date the date to format
- * @param pattern the pattern to use to format the date
- * @param locale the locale to use, may be <code>null</code>
- * @return the formatted date
- */
- public static String format(Date date, String pattern, Locale locale) {
- return format(date, pattern, null, locale);
- }
-
- /**
- * <p>Format a date/time into a specific pattern in a time zone and locale.</p>
- *
- * @param millis the date to format expressed in milliseconds
- * @param pattern the pattern to use to format the date
- * @param timeZone the time zone to use, may be <code>null</code>
- * @param locale the locale to use, may be <code>null</code>
- * @return the formatted date
- */
- public static String format(long millis, String pattern, TimeZone timeZone, Locale locale) {
- return format(new Date(millis), pattern, timeZone, locale);
- }
-
- /**
- * <p>Format a date/time into a specific pattern in a time zone and locale.</p>
- *
- * @param date the date to format
- * @param pattern the pattern to use to format the date
- * @param timeZone the time zone to use, may be <code>null</code>
- * @param locale the locale to use, may be <code>null</code>
- * @return 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);
- }
-
- }