Class DateTime
- java.lang.Object
-
- com.google.api.client.util.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
- Author:
- Yaniv Inbar
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DateTime(boolean dateOnly, long value, Integer tzShift)
InstantiatesDateTime
, which may represent a date-only value, from the number of milliseconds since the Unix epoch, and a shift from UTC in minutes.DateTime(long value)
InstantiatesDateTime
from the number of milliseconds since the Unix epoch.DateTime(long value, int tzShift)
InstantiatesDateTime
from the number of milliseconds since the Unix epoch, and a shift from UTC in minutes.DateTime(String value)
DateTime(Date value)
DateTime(Date date, TimeZone zone)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
int
getTimeZoneShift()
Returns the time zone shift from UTC in minutes or0
for date-only value.long
getValue()
Returns the date/time value expressed as the number of milliseconds since the Unix epoch.int
hashCode()
boolean
isDateOnly()
Returns whether this is a date-only value.static DateTime
parseRfc3339(String str)
Parses an RFC3339 date/time value.String
toString()
String
toStringRfc3339()
Formats the value as an RFC 3339 date/time string.
-
-
-
Constructor Detail
-
DateTime
public DateTime(Date date, TimeZone zone)
- Parameters:
date
- date and timezone
- time zone; ifnull
, it is interpreted asTimeZone.getDefault()
.
-
DateTime
public DateTime(long value)
InstantiatesDateTime
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)
InstantiatesDateTime
from aDate
.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)
InstantiatesDateTime
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)
InstantiatesDateTime
, 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 valuevalue
- 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, ornull
forTimeZone.getDefault()
.
-
DateTime
public DateTime(String value)
InstantiatesDateTime
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 or0
for date-only value.- Since:
- 1.5
-
toStringRfc3339
public String toStringRfc3339()
Formats the value as an RFC 3339 date/time string.
-
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()
.
-
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
- ifstr
doesn't match the RFC3339 standard format; an exception is thrown ifstr
doesn't matchRFC3339_REGEX
or if it contains a time zone shift but no time.
-
-