Package org.opencms.util

Class CmsDateUtil

java.lang.Object
org.opencms.util.CmsDateUtil
public final class CmsDateUtil extends Object
Utilities to get and set formated dates in OpenCms.

Since:
6.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final TimeZone
    GMT_TIMEZONE
    The "GMT" time zone, used when formatting http headers.
    protected static final DateFormat
    HEADER_DEFAULT
    The default format to use when formatting http headers.
    protected static final DateFormat
    OLD_COOKIE
    The default format to use when formatting old cookies.

  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    getDate(Date date, int format, Locale locale)
    Returns a formated date String from a Date value, the formatting based on the provided options.
    static String
    getDateShort(long time)
    Returns a formated date String form a timestamp value, the formatting based on the OpenCms system default locale and the DateFormat.SHORT date format.
    static String
    getDateTime(Date date, int format, Locale locale)
    Returns a formated date and time String from a Date value, the formatting based on the provided options.
    static String
    getDateTimeShort(long time)
    Returns a formated date and time String form a timestamp value, the formatting based on the OpenCms system default locale and the DateFormat.SHORT date format.
    static int
    getDaysPassedSince(Date dateLastModified)
    Returns the number of days passed since a specific date.
    static String
    getHeaderDate(long time)
    Returns a formated date and time String form a timestamp value based on the HTTP-Header date format.
    static String
    getOldCookieDate(long time)
    Returns a formatted date and time String form a timestamp value based on the (old) Netscape cookie date format.
    static long
    parseDate(int year, int month, int date)
    Returns the long value of a date created by the given integer values.
    static long
    parseHeaderDate(String timestamp)
    Parses a formated date and time string in HTTP-Header date format and returns the time value.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • GMT_TIMEZONE

      protected static final TimeZone GMT_TIMEZONE
      The "GMT" time zone, used when formatting http headers.

    • HEADER_DEFAULT

      protected static final DateFormat HEADER_DEFAULT
      The default format to use when formatting http headers.

  • Method Details

    • getDate

      public static String getDate(Date date, int format, Locale locale)
      Returns a formated date String from a Date value, the formatting based on the provided options.

      Parameters:
      date - the Date object to format as String
      format - the format to use, see DateFormat for possible values
      locale - the locale to use
      Returns:
      the formatted date

    • getDateShort

      public static String getDateShort(long time)
      Returns a formated date String form a timestamp value, the formatting based on the OpenCms system default locale and the DateFormat.SHORT date format.

      Parameters:
      time - the time value to format as date
      Returns:
      the formatted date

    • getDateTime

      public static String getDateTime(Date date, int format, Locale locale)
      Returns a formated date and time String from a Date value, the formatting based on the provided options.

      Parameters:
      date - the Date object to format as String
      format - the format to use, see DateFormat for possible values
      locale - the locale to use
      Returns:
      the formatted date

    • getDateTimeShort

      public static String getDateTimeShort(long time)
      Returns a formated date and time String form a timestamp value, the formatting based on the OpenCms system default locale and the DateFormat.SHORT date format.

      Parameters:
      time - the time value to format as date
      Returns:
      the formatted date

    • getDaysPassedSince

      public static int getDaysPassedSince(Date dateLastModified)
      Returns the number of days passed since a specific date.

      Parameters:
      dateLastModified - the date to compute the passed days from
      Returns:
      the number of days passed since a specific date

    • getHeaderDate

      public static String getHeaderDate(long time)
      Returns a formated date and time String form a timestamp value based on the HTTP-Header date format.

      Parameters:
      time - the time value to format as date
      Returns:
      the formatted date

    • getOldCookieDate

      public static String getOldCookieDate(long time)
      Returns a formatted date and time String form a timestamp value based on the (old) Netscape cookie date format.

      Parameters:
      time - the time value to format as date
      Returns:
      the formatted date

    • parseDate

      public static long parseDate(int year, int month, int date)
      Returns the long value of a date created by the given integer values.

      Parameters:
      year - the integer value of year
      month - the integer value of month
      date - the integer value of date
      Returns:
      the long value of a date created by the given integer values

    • parseHeaderDate

      public static long parseHeaderDate(String timestamp) throws ParseException
      Parses a formated date and time string in HTTP-Header date format and returns the time value.

      Parameters:
      timestamp - the timestamp in HTTP-Header date format
      Returns:
      time value as long
      Throws:
      ParseException - if parsing fails