com.google.api.ads.dfp.lib.utils

Class DateTimesHelper<T,D>

java.lang.Object

com.google.api.ads.dfp.lib.utils.DateTimesHelper<T,D>

Type Parameters:

T - the DateTime type

D - the Date type

public class DateTimesHelper<T,D>
extends Object

A utility class for handling DateTime objects.

Constructor Summary

Constructors

Constructor and Description
DateTimesHelper(Class<T> dateTimeClass, Class<D> dateClass) Constructor.

Method Summary

Modifier and Type	Method and Description
String	dateToString(D date) Returns string representation of this date.
Calendar	toCalendar(T dateTime) Gets a calendar for a DateTime using the default locale, i.e.
Calendar	toCalendar(T dateTime, Locale locale) Gets a calendar for a DateTime in the supplied locale.
T	toDateTime(Calendar calendar) Converts a Calendar object to an API date time preserving the time zone.
T	toDateTime(org.joda.time.DateTime dateTime) Converts a DateTime object to an API date time preserving the time zone.
T	toDateTime(org.joda.time.Instant instant, String timeZoneId) Converts an Instant object to an API date time in the time zone supplied.
T	toDateTime(String dateTime, String timeZoneId) Converts a string in the form of yyyy-MM-dd'T'HH:mm:ss to an API date time in the time zone supplied.
org.joda.time.DateTime	toDateTime(T dateTime) Converts an API date time to a DateTime preserving the time zone.
T	toDateTimeWithTimeZone(String dateTime) Converts a string in the form of yyyy-MM-dd'T'HH:mm:ss±HH:mm to an API date time in the time zone supplied.
String	toString(T dateTime) Returns string representation of this date time.
String	toStringForTimeZone(T dateTime, String newZoneID) Returns string representation of this date time with a different time zone, preserving the millisecond instant.
String	toStringWithTimeZone(T dateTime) Returns string representation of this date time with time zone.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTimesHelper

public DateTimesHelper(Class<T> dateTimeClass,
                       Class<D> dateClass)

Constructor.

Parameters:

dateTimeClass - the date time class

dateClass - the date class

Method Detail

toDateTime

public T toDateTime(Calendar calendar)

Converts a Calendar object to an API date time preserving the time zone.

toDateTime

public T toDateTime(org.joda.time.Instant instant,
                    String timeZoneId)

Converts an Instant object to an API date time in the time zone supplied.

toDateTime

public T toDateTime(org.joda.time.DateTime dateTime)

Converts a DateTime object to an API date time preserving the time zone.

toDateTime

public T toDateTime(String dateTime,
                    String timeZoneId)

Converts a string in the form of yyyy-MM-dd'T'HH:mm:ss to an API date time in the time zone supplied.

toDateTimeWithTimeZone

public T toDateTimeWithTimeZone(String dateTime)

Converts a string in the form of yyyy-MM-dd'T'HH:mm:ss±HH:mm to an API date time in the time zone supplied.

dateToString

public String dateToString(D date)

Returns string representation of this date.

Parameters:

date - the date to stringify

Returns:

a string representation of the Date in yyyy-MM-dd

toDateTime

public org.joda.time.DateTime toDateTime(T dateTime)

Converts an API date time to a DateTime preserving the time zone.

toCalendar

public Calendar toCalendar(T dateTime)

Gets a calendar for a DateTime using the default locale, i.e. Locale.getDefault().

toCalendar

public Calendar toCalendar(T dateTime,
                           Locale locale)

Gets a calendar for a DateTime in the supplied locale.

toString

public String toString(T dateTime)

Returns string representation of this date time. The string representation does not include the time zone since using date times for filtering does not use the time zone. If you need to convert the date time into another time zone before filtering on it, please use toStringForTimeZone(Object, String) instead.

Parameters:

dateTime - the date time to stringify

Returns:

a string representation of the DateTime in yyyy-MM-dd'T'HH:mm:ss

toStringWithTimeZone

public String toStringWithTimeZone(T dateTime)

Returns string representation of this date time with time zone. If you need to convert the date time into another time zone before filtering on it, please use toStringForTimeZone(Object, String) instead.

Parameters:

dateTime - the date time to stringify

Returns:

a string representation of the DateTime in yyyy-MM-dd'T'HH:mm:ss±HH:mm, i.e. 2013-09-013T12:02:03+08:00

toStringForTimeZone

public String toStringForTimeZone(T dateTime,
                                  String newZoneID)

Returns string representation of this date time with a different time zone, preserving the millisecond instant.

This method is useful for finding the local time in another time zone, especially for filtering.

For example, if this date time holds 12:30 in Europe/London, the result from this method with Europe/Paris would be 13:30. You may also want to use this with your network's time zone, i.e.

 String timeZoneId = networkService.getCurrentNetwork().getTimeZone();
 String statementPart =
     "startDateTime > "
         + DateTimes.toString(apiDateTime, timeZoneId);
 //...
 statementBuilder.where(statementPart);
 

This method is in the same style of DateTime.withZone(org.joda.time.DateTimeZone).

Parameters:

dateTime - the date time to stringify into a new time zone

newZoneID - the time zone ID of the new zone

Returns:

a string representation of the DateTime in yyyy-MM-dd'T'HH:mm:ss