Coverage Report - org.apache.commons.lang3.time.DateFormatUtils
 
Classes in this File Line Coverage Branch Coverage Complexity
DateFormatUtils
97%
43/44
N/A
1
 
 1  
 /*
 2  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 3  
  * contributor license agreements.  See the NOTICE file distributed with
 4  
  * this work for additional information regarding copyright ownership.
 5  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 6  
  * (the "License"); you may not use this file except in compliance with
 7  
  * the License.  You may obtain a copy of the License at
 8  
  * 
 9  
  *      http://www.apache.org/licenses/LICENSE-2.0
 10  
  * 
 11  
  * Unless required by applicable law or agreed to in writing, software
 12  
  * distributed under the License is distributed on an "AS IS" BASIS,
 13  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14  
  * See the License for the specific language governing permissions and
 15  
  * limitations under the License.
 16  
  */
 17  
 package org.apache.commons.lang3.time;
 18  
 
 19  
 import java.util.Calendar;
 20  
 import java.util.Date;
 21  
 import java.util.Locale;
 22  
 import java.util.TimeZone;
 23  
 
 24  
 /**
 25  
  * <p>Date and time formatting utilities and constants.</p>
 26  
  *
 27  
  * <p>Formatting is performed using the thread-safe
 28  
  * {@link org.apache.commons.lang3.time.FastDateFormat} class.</p>
 29  
  *
 30  
  * <p>Note that the JDK has a bug wherein calling Calendar.get(int) will 
 31  
  * override any previously called Calendar.clear() calls. See LANG-755.</p>
 32  
  *
 33  
  * @since 2.0
 34  
  */
 35  
 public class DateFormatUtils {
 36  
 
 37  
     /**
 38  
      * The UTC time zone (often referred to as GMT).
 39  
      * This is private as it is mutable.
 40  
      */
 41  1
     private static final TimeZone UTC_TIME_ZONE = TimeZone.getTimeZone("GMT");
 42  
 
 43  
     /**
 44  
      * ISO 8601 formatter for date-time without time zone.
 45  
      *
 46  
      * <p>
 47  
      * The format used is {@code yyyy-MM-dd'T'HH:mm:ss}. This format uses the
 48  
      * default TimeZone in effect at the time of loading DateFormatUtils class.
 49  
      * </p>
 50  
      *
 51  
      * @since 3.5
 52  
      */
 53  1
     public static final FastDateFormat ISO_8601_EXTENDED_DATETIME_FORMAT
 54  1
             = FastDateFormat.getInstance("yyyy-MM-dd'T'HH:mm:ss");
 55  
 
 56  
     /**
 57  
      * @deprecated - as of 4.0, ISO_DATETIME_FORMAT will be replaced by ISO_8601_EXTENDED_DATETIME_FORMAT.
 58  
      */
 59  
     @Deprecated
 60  1
     public static final FastDateFormat ISO_DATETIME_FORMAT = ISO_8601_EXTENDED_DATETIME_FORMAT;
 61  
 
 62  
     /**
 63  
      * ISO 8601 formatter for date-time with time zone.
 64  
      *
 65  
      * <p>
 66  
      * The format used is {@code yyyy-MM-dd'T'HH:mm:ssZZ}. This format uses the
 67  
      * default TimeZone in effect at the time of loading DateFormatUtils class.
 68  
      * </p>
 69  
      *
 70  
      * @since 3.5
 71  
      */
 72  1
     public static final FastDateFormat ISO_8601_EXTENDED_DATETIME_TIME_ZONE_FORMAT
 73  1
             = FastDateFormat.getInstance("yyyy-MM-dd'T'HH:mm:ssZZ");
 74  
 
 75  
     /**
 76  
      * @deprecated - as of 4.0, ISO_DATETIME_TIME_ZONE_FORMAT will be replaced by ISO_8601_EXTENDED_DATETIME_TIME_ZONE_FORMAT.
 77  
      */
 78  
     @Deprecated
 79  1
     public static final FastDateFormat ISO_DATETIME_TIME_ZONE_FORMAT = ISO_8601_EXTENDED_DATETIME_TIME_ZONE_FORMAT;
 80  
 
 81  
     /**
 82  
      * ISO 8601 formatter for date without time zone.
 83  
      *
 84  
      * <p>
 85  
      * The format used is {@code yyyy-MM-dd}. This format uses the
 86  
      * default TimeZone in effect at the time of loading DateFormatUtils class.
 87  
      * </p>
 88  
      *
 89  
      * @since 3.5
 90  
      */
 91  1
     public static final FastDateFormat ISO_8601_EXTENDED_DATE_FORMAT
 92  1
             = FastDateFormat.getInstance("yyyy-MM-dd");
 93  
 
 94  
     /**
 95  
      * @deprecated - as of 4.0, ISO_DATE_FORMAT will be replaced by ISO_8601_EXTENDED_DATE_FORMAT.
 96  
      */
 97  
     @Deprecated
 98  1
     public static final FastDateFormat ISO_DATE_FORMAT = ISO_8601_EXTENDED_DATE_FORMAT;
 99  
 
 100  
     /**
 101  
      * ISO 8601-like formatter for date with time zone.
 102  
      *
 103  
      * <p>
 104  
      * The format used is {@code yyyy-MM-ddZZ}. This pattern does not comply
 105  
      * with the formal ISO 8601 specification as the standard does not allow
 106  
      * a time zone  without a time. This format uses the default TimeZone in
 107  
      * effect at the time of loading DateFormatUtils class.
 108  
      * </p>
 109  
      *
 110  
      * @deprecated - as of 4.0, ISO_DATE_TIME_ZONE_FORMAT will be removed.
 111  
      */
 112  
     @Deprecated
 113  1
     public static final FastDateFormat ISO_DATE_TIME_ZONE_FORMAT
 114  1
             = FastDateFormat.getInstance("yyyy-MM-ddZZ");
 115  
 
 116  
     /**
 117  
      * Non-compliant formatter for time without time zone (ISO 8601 does not
 118  
      * prefix 'T' for standalone time value).
 119  
      *
 120  
      * <p>
 121  
      * The format used is {@code 'T'HH:mm:ss}. This format uses the default
 122  
      * TimeZone in effect at the time of loading DateFormatUtils class.
 123  
      * </p>
 124  
      *
 125  
      * @deprecated - as of 4.0, ISO_TIME_FORMAT will be removed.
 126  
      */
 127  
     @Deprecated
 128  1
     public static final FastDateFormat ISO_TIME_FORMAT
 129  1
             = FastDateFormat.getInstance("'T'HH:mm:ss");
 130  
 
 131  
     /**
 132  
      * Non-compliant formatter for time with time zone (ISO 8601 does not
 133  
      * prefix 'T' for standalone time value).
 134  
      *
 135  
      * <p>
 136  
      * The format used is {@code 'T'HH:mm:ssZZ}. This format uses the default
 137  
      * TimeZone in effect at the time of loading DateFormatUtils class.
 138  
      * </p>
 139  
      *
 140  
      * @deprecated - as of 4.0, ISO_TIME_TIME_ZONE_FORMAT will be removed.
 141  
      */
 142  
     @Deprecated
 143  1
     public static final FastDateFormat ISO_TIME_TIME_ZONE_FORMAT
 144  1
             = FastDateFormat.getInstance("'T'HH:mm:ssZZ");
 145  
 
 146  
     /**
 147  
      * ISO 8601 formatter for time without time zone.
 148  
      *
 149  
      * <p>
 150  
      * The format used is {@code HH:mm:ss}. This format uses the default
 151  
      * TimeZone in effect at the time of loading DateFormatUtils class.
 152  
      * </p>
 153  
      *
 154  
      * @since 3.5
 155  
      */
 156  1
     public static final FastDateFormat ISO_8601_EXTENDED_TIME_FORMAT
 157  1
             = FastDateFormat.getInstance("HH:mm:ss");
 158  
 
 159  
     /**
 160  
      * @deprecated - as of 4.0, ISO_TIME_NO_T_FORMAT will be replaced by ISO_8601_EXTENDED_TIME_FORMAT.
 161  
      */
 162  
     @Deprecated
 163  1
     public static final FastDateFormat ISO_TIME_NO_T_FORMAT = ISO_8601_EXTENDED_TIME_FORMAT;
 164  
 
 165  
     /**
 166  
      * ISO 8601 formatter for time with time zone.
 167  
      *
 168  
      * <p>
 169  
      * The format used is {@code HH:mm:ssZZ}. This format uses the default
 170  
      * TimeZone in effect at the time of loading DateFormatUtils class.
 171  
      * </p>
 172  
      *
 173  
      * @since 3.5
 174  
      */
 175  1
     public static final FastDateFormat ISO_8601_EXTENDED_TIME_TIME_ZONE_FORMAT
 176  1
             = FastDateFormat.getInstance("HH:mm:ssZZ");
 177  
 
 178  
     /**
 179  
      * @deprecated - as of 4.0, ISO_TIME_NO_T_TIME_ZONE_FORMAT will be replaced by ISO_8601_EXTENDED_TIME_TIME_ZONE_FORMAT.
 180  
      */
 181  
     @Deprecated
 182  1
     public static final FastDateFormat ISO_TIME_NO_T_TIME_ZONE_FORMAT = ISO_8601_EXTENDED_TIME_TIME_ZONE_FORMAT;
 183  
 
 184  
     /**
 185  
      * SMTP (and probably other) date headers.
 186  
      *
 187  
      * <p>
 188  
      * The format used is {@code EEE, dd MMM yyyy HH:mm:ss Z} in US locale.
 189  
      * This format uses the default TimeZone in effect at the time of loading
 190  
      * DateFormatUtils class.
 191  
      * </p>
 192  
      */
 193  2
     public static final FastDateFormat SMTP_DATETIME_FORMAT
 194  1
             = FastDateFormat.getInstance("EEE, dd MMM yyyy HH:mm:ss Z", Locale.US);
 195  
 
 196  
     //-----------------------------------------------------------------------
 197  
     /**
 198  
      * <p>DateFormatUtils instances should NOT be constructed in standard programming.</p>
 199  
      *
 200  
      * <p>This constructor is public to permit tools that require a JavaBean instance
 201  
      * to operate.</p>
 202  
      */
 203  
     public DateFormatUtils() {
 204  1
         super();
 205  1
     }
 206  
 
 207  
     /**
 208  
      * <p>Formats a date/time into a specific pattern using the UTC time zone.</p>
 209  
      * 
 210  
      * @param millis  the date to format expressed in milliseconds
 211  
      * @param pattern  the pattern to use to format the date, not null
 212  
      * @return the formatted date
 213  
      */
 214  
     public static String formatUTC(final long millis, final String pattern) {
 215  1
         return format(new Date(millis), pattern, UTC_TIME_ZONE, null);
 216  
     }
 217  
 
 218  
     /**
 219  
      * <p>Formats a date/time into a specific pattern using the UTC time zone.</p>
 220  
      * 
 221  
      * @param date  the date to format, not null
 222  
      * @param pattern  the pattern to use to format the date, not null
 223  
      * @return the formatted date
 224  
      */
 225  
     public static String formatUTC(final Date date, final String pattern) {
 226  1
         return format(date, pattern, UTC_TIME_ZONE, null);
 227  
     }
 228  
     
 229  
     /**
 230  
      * <p>Formats a date/time into a specific pattern using the UTC time zone.</p>
 231  
      * 
 232  
      * @param millis  the date to format expressed in milliseconds
 233  
      * @param pattern  the pattern to use to format the date, not null
 234  
      * @param locale  the locale to use, may be <code>null</code>
 235  
      * @return the formatted date
 236  
      */
 237  
     public static String formatUTC(final long millis, final String pattern, final Locale locale) {
 238  1
         return format(new Date(millis), pattern, UTC_TIME_ZONE, locale);
 239  
     }
 240  
 
 241  
     /**
 242  
      * <p>Formats a date/time into a specific pattern using the UTC time zone.</p>
 243  
      * 
 244  
      * @param date  the date to format, not null
 245  
      * @param pattern  the pattern to use to format the date, not null
 246  
      * @param locale  the locale to use, may be <code>null</code>
 247  
      * @return the formatted date
 248  
      */
 249  
     public static String formatUTC(final Date date, final String pattern, final Locale locale) {
 250  1
         return format(date, pattern, UTC_TIME_ZONE, locale);
 251  
     }
 252  
     
 253  
     /**
 254  
      * <p>Formats a date/time into a specific pattern.</p>
 255  
      * 
 256  
      * @param millis  the date to format expressed in milliseconds
 257  
      * @param pattern  the pattern to use to format the date, not null
 258  
      * @return the formatted date
 259  
      */
 260  
     public static String format(final long millis, final String pattern) {
 261  1
         return format(new Date(millis), pattern, null, null);
 262  
     }
 263  
 
 264  
     /**
 265  
      * <p>Formats a date/time into a specific pattern.</p>
 266  
      * 
 267  
      * @param date  the date to format, not null
 268  
      * @param pattern  the pattern to use to format the date, not null
 269  
      * @return the formatted date
 270  
      */
 271  
     public static String format(final Date date, final String pattern) {
 272  2
         return format(date, pattern, null, null);
 273  
     }
 274  
 
 275  
     /**
 276  
      * <p>Formats a calendar into a specific pattern.</p>
 277  
      * 
 278  
      * @param calendar  the calendar to format, not null
 279  
      * @param pattern  the pattern to use to format the calendar, not null
 280  
      * @return the formatted calendar
 281  
      * @see FastDateFormat#format(Calendar)
 282  
      * @since 2.4
 283  
      */
 284  
     public static String format(final Calendar calendar, final String pattern) {
 285  1
         return format(calendar, pattern, null, null);
 286  
     }
 287  
     
 288  
     /**
 289  
      * <p>Formats a date/time into a specific pattern in a time zone.</p>
 290  
      * 
 291  
      * @param millis  the time expressed in milliseconds
 292  
      * @param pattern  the pattern to use to format the date, not null
 293  
      * @param timeZone  the time zone  to use, may be <code>null</code>
 294  
      * @return the formatted date
 295  
      */
 296  
     public static String format(final long millis, final String pattern, final TimeZone timeZone) {
 297  17
         return format(new Date(millis), pattern, timeZone, null);
 298  
     }
 299  
 
 300  
     /**
 301  
      * <p>Formats a date/time into a specific pattern in a time zone.</p>
 302  
      * 
 303  
      * @param date  the date to format, not null
 304  
      * @param pattern  the pattern to use to format the date, not null
 305  
      * @param timeZone  the time zone  to use, may be <code>null</code>
 306  
      * @return the formatted date
 307  
      */
 308  
     public static String format(final Date date, final String pattern, final TimeZone timeZone) {
 309  14
         return format(date, pattern, timeZone, null);
 310  
     }
 311  
 
 312  
     /**
 313  
      * <p>Formats a calendar into a specific pattern in a time zone.</p>
 314  
      * 
 315  
      * @param calendar  the calendar to format, not null
 316  
      * @param pattern  the pattern to use to format the calendar, not null
 317  
      * @param timeZone  the time zone  to use, may be <code>null</code>
 318  
      * @return the formatted calendar
 319  
      * @see FastDateFormat#format(Calendar)
 320  
      * @since 2.4
 321  
      */
 322  
     public static String format(final Calendar calendar, final String pattern, final TimeZone timeZone) {
 323  18
         return format(calendar, pattern, timeZone, null);
 324  
     }
 325  
 
 326  
     /**
 327  
      * <p>Formats a date/time into a specific pattern in a locale.</p>
 328  
      * 
 329  
      * @param millis  the date to format expressed in milliseconds
 330  
      * @param pattern  the pattern to use to format the date, not null
 331  
      * @param locale  the locale to use, may be <code>null</code>
 332  
      * @return the formatted date
 333  
      */
 334  
     public static String format(final long millis, final String pattern, final Locale locale) {
 335  1
         return format(new Date(millis), pattern, null, locale);
 336  
     }
 337  
 
 338  
     /**
 339  
      * <p>Formats a date/time into a specific pattern in a locale.</p>
 340  
      * 
 341  
      * @param date  the date to format, not null
 342  
      * @param pattern  the pattern to use to format the date, not null
 343  
      * @param locale  the locale to use, may be <code>null</code>
 344  
      * @return the formatted date
 345  
      */
 346  
     public static String format(final Date date, final String pattern, final Locale locale) {
 347  2
         return format(date, pattern, null, locale);
 348  
     }
 349  
 
 350  
     /**
 351  
      * <p>Formats a calendar into a specific pattern in a locale.</p>
 352  
      * 
 353  
      * @param calendar  the calendar to format, not null
 354  
      * @param pattern  the pattern to use to format the calendar, not null
 355  
      * @param locale  the locale to use, may be <code>null</code>
 356  
      * @return the formatted calendar
 357  
      * @see FastDateFormat#format(Calendar)
 358  
      * @since 2.4
 359  
      */
 360  
     public static String format(final Calendar calendar, final String pattern, final Locale locale) {
 361  1
         return format(calendar, pattern, null, locale);
 362  
     }
 363  
 
 364  
     /**
 365  
      * <p>Formats a date/time into a specific pattern in a time zone  and locale.</p>
 366  
      * 
 367  
      * @param millis  the date to format expressed in milliseconds
 368  
      * @param pattern  the pattern to use to format the date, not null
 369  
      * @param timeZone  the time zone  to use, may be <code>null</code>
 370  
      * @param locale  the locale to use, may be <code>null</code>
 371  
      * @return the formatted date
 372  
      */
 373  
     public static String format(final long millis, final String pattern, final TimeZone timeZone, final Locale locale) {
 374  0
         return format(new Date(millis), pattern, timeZone, locale);
 375  
     }
 376  
 
 377  
     /**
 378  
      * <p>Formats a date/time into a specific pattern in a time zone  and locale.</p>
 379  
      * 
 380  
      * @param date  the date to format, not null
 381  
      * @param pattern  the pattern to use to format the date, not null, not null
 382  
      * @param timeZone  the time zone  to use, may be <code>null</code>
 383  
      * @param locale  the locale to use, may be <code>null</code>
 384  
      * @return the formatted date
 385  
      */
 386  
     public static String format(final Date date, final String pattern, final TimeZone timeZone, final Locale locale) {
 387  41
         final FastDateFormat df = FastDateFormat.getInstance(pattern, timeZone, locale);
 388  41
         return df.format(date);
 389  
     }
 390  
 
 391  
     /**
 392  
      * <p>Formats a calendar into a specific pattern in a time zone  and locale.</p>
 393  
      * 
 394  
      * @param calendar  the calendar to format, not null
 395  
      * @param pattern  the pattern to use to format the calendar, not null
 396  
      * @param timeZone  the time zone  to use, may be <code>null</code>
 397  
      * @param locale  the locale to use, may be <code>null</code>
 398  
      * @return the formatted calendar
 399  
      * @see FastDateFormat#format(Calendar)
 400  
      * @since 2.4
 401  
      */
 402  
     public static String format(final Calendar calendar, final String pattern, final TimeZone timeZone, final Locale locale) {
 403  20
         final FastDateFormat df = FastDateFormat.getInstance(pattern, timeZone, locale);
 404  20
         return df.format(calendar);
 405  
     }
 406  
 
 407  
 }