com.google.api.client.util

Class DateTime

  • All Implemented Interfaces:
    Serializable 

    public final class DateTime
extends Object
implements Serializable
    Immutable representation of a date with an optional time and an optional time zone based on RFC 3339.

    Implementation is immutable and therefore thread-safe.

    Since:
    1.0
    See Also:
    Serialized Form

    • Constructor Detail

      • DateTime

        public DateTime(Date date,
                TimeZone zone)
        Instantiates DateTime from a Date and TimeZone.
        Parameters:
        date - date and time
        zone - time zone; if null, it is interpreted as TimeZone.getDefault().

      • DateTime

        public DateTime(long value)
        Instantiates DateTime from the number of milliseconds since the Unix epoch.

        The time zone is interpreted as TimeZone.getDefault(), which may vary with implementation.

        Parameters:
        value - number of milliseconds since the Unix epoch (January 1, 1970, 00:00:00 GMT)

      • DateTime

        public DateTime(Date value)
        Instantiates DateTime from a Date.

        The time zone is interpreted as TimeZone.getDefault(), which may vary with implementation.

        Parameters:
        value - date and time

      • DateTime

        public DateTime(long value,
                int tzShift)
        Instantiates DateTime from the number of milliseconds since the Unix epoch, and a shift from UTC in minutes.
        Parameters:
        value - number of milliseconds since the Unix epoch (January 1, 1970, 00:00:00 GMT)
        tzShift - time zone, represented by the number of minutes off of UTC.

      • DateTime

        public DateTime(boolean dateOnly,
                long value,
                Integer tzShift)
        Instantiates DateTime, which may represent a date-only value, from the number of milliseconds since the Unix epoch, and a shift from UTC in minutes.
        Parameters:
        dateOnly - specifies if this should represent a date-only value
        value - number of milliseconds since the Unix epoch (January 1, 1970, 00:00:00 GMT)
        tzShift - time zone, represented by the number of minutes off of UTC, or null for TimeZone.getDefault().

      • DateTime

        public DateTime(String value)
        Instantiates DateTime from an RFC 3339 date/time value.

        Upgrade warning: in prior version 1.17, this method required milliseconds to be exactly 3 digits (if included), and did not throw an exception for all types of invalid input values, but starting in version 1.18, the parsing done by this method has become more strict to enforce that only valid RFC3339 strings are entered, and if not, it throws a NumberFormatException. Also, in accordance with the RFC3339 standard, any number of milliseconds digits is now allowed.

        Parameters:
        value - an RFC 3339 date/time value.
        Since:
        1.11

    • Method Detail

      • getValue

        public long getValue()
        Returns the date/time value expressed as the number of milliseconds since the Unix epoch.

        If the time zone is specified, this value is normalized to UTC, so to format this date/time value, the time zone shift has to be applied.

        Since:
        1.5

      • isDateOnly

        public boolean isDateOnly()
        Returns whether this is a date-only value.
        Since:
        1.5

      • getTimeZoneShift

        public int getTimeZoneShift()
        Returns the time zone shift from UTC in minutes or 0 for date-only value.
        Since:
        1.5

      • toStringRfc3339

        public String toStringRfc3339()
        Formats the value as an RFC 3339 date/time string.

      • toString

        public String toString()

      • equals

        public boolean equals(Object o)

        A check is added that the time zone is the same. If you ONLY want to check equality of time value, check equality on the getValue().

      • hashCode

        public int hashCode()

      • parseRfc3339

        public static DateTime parseRfc3339(String str)
                             throws NumberFormatException
        Parses an RFC3339 date/time value.

        Upgrade warning: in prior version 1.17, this method required milliseconds to be exactly 3 digits (if included), and did not throw an exception for all types of invalid input values, but starting in version 1.18, the parsing done by this method has become more strict to enforce that only valid RFC3339 strings are entered, and if not, it throws a NumberFormatException. Also, in accordance with the RFC3339 standard, any number of milliseconds digits is now allowed.

        For the date-only case, the time zone is ignored and the hourOfDay, minute, second, and millisecond parameters are set to zero.

        Parameters:
        str - Date/time string in RFC3339 format
        Throws:
        NumberFormatException - if str doesn't match the RFC3339 standard format; an exception is thrown if str doesn't match RFC3339_REGEX or if it contains a time zone shift but no time.