com.cloudhopper.commons.util

Class DateTimeUtil

java.lang.Object

com.cloudhopper.commons.util.DateTimeUtil

public class DateTimeUtil
extends Object

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Constructor Summary

Constructors

Constructor and Description
DateTimeUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static org.joda.time.DateTime	copy(org.joda.time.DateTime value) Null-safe method of copying a DateTime NOTE: The timestamp also should be in UTC.
static org.joda.time.DateTime	floorToDay(org.joda.time.DateTime value) Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest day.
static org.joda.time.DateTime	floorToFiveMinutes(org.joda.time.DateTime value) Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest 5 minutes.
static org.joda.time.DateTime	floorToHalfHour(org.joda.time.DateTime value) Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest half hour (30 minutes).
static org.joda.time.DateTime	floorToHour(org.joda.time.DateTime value) Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest hour.
static org.joda.time.DateTime	floorToMinute(org.joda.time.DateTime value) Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest minute.
static org.joda.time.DateTime	floorToMinutePeriod(org.joda.time.DateTime value, int periodInMinutes) Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest specified period in minutes.
static org.joda.time.DateTime	floorToMonth(org.joda.time.DateTime value) Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest month.
static org.joda.time.DateTime	floorToQuarterHour(org.joda.time.DateTime value) Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest 15 minutes.
static org.joda.time.DateTime	floorToSecond(org.joda.time.DateTime value) Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest second.
static org.joda.time.DateTime	floorToTenMinutes(org.joda.time.DateTime value) Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest 10 minutes.
static org.joda.time.DateTime	floorToYear(org.joda.time.DateTime value) Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest year.
static org.joda.time.DateTime	now() Get the current time as a DateTime.
static org.joda.time.DateTime	parseEmbedded(String string0) Parses a string for an embedded date and/or time contained within a string such as "app.2008-05-01.log".
static org.joda.time.DateTime	parseEmbedded(String string0, String pattern, org.joda.time.DateTimeZone zone) Parses a string for an embedded date and/or time contained within a string such as "app.2008-05-01.log" or "app-20090624-051112.log.gz".
static org.joda.time.DateTime	toDateTime(Timestamp value) Null-safe method of converting a SQL Timestamp into a DateTime that it set specifically to be in UTC.
static Timestamp	toTimestamp(org.joda.time.DateTime dt) Null-safe method of converting a DateTime to a Timestamp.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTimeUtil

public DateTimeUtil()

Method Detail

toDateTime

public static org.joda.time.DateTime toDateTime(Timestamp value)

Null-safe method of converting a SQL Timestamp into a DateTime that it set specifically to be in UTC.
NOTE: The timestamp also should be in UTC.

Returns:

A UTC DateTime

copy

public static org.joda.time.DateTime copy(org.joda.time.DateTime value)

Null-safe method of copying a DateTime
NOTE: The timestamp also should be in UTC.

Returns:

A UTC DateTime

toTimestamp

public static Timestamp toTimestamp(org.joda.time.DateTime dt)

Null-safe method of converting a DateTime to a Timestamp.
NOTE: The timestamp also should be in UTC.

Returns:

A UTC DateTime

now

public static org.joda.time.DateTime now()

Get the current time as a DateTime.

Returns:

A UTC DateTime

parseEmbedded

public static org.joda.time.DateTime parseEmbedded(String string0)
                                            throws IllegalArgumentException

Parses a string for an embedded date and/or time contained within a string such as "app.2008-05-01.log". This method expects the string to contain a pattern of "yyyy-MM-dd". All dates will be interpreted to be in the UTC timezone.

Parameters:

string0 - The string to parse

Returns:

The parsed DateTime value

Throws:

IllegalArgumentException - Thrown if the string did not contain an embedded date.

parseEmbedded

public static org.joda.time.DateTime parseEmbedded(String string0,
                                   String pattern,
                                   org.joda.time.DateTimeZone zone)
                                            throws IllegalArgumentException

Parses a string for an embedded date and/or time contained within a string such as "app.2008-05-01.log" or "app-20090624-051112.log.gz". This method accepts a variety of date and time patterns that are valid within the Joda DateTime library. For example, the string "app.2008-05-01.log" would be a pattern of "yyyy-MM-dd" and the string "app-20090624-151112.log.gz" would be a pattern of "yyyy-MM-dd-HHmmss".

Parameters:

string0 - The string to parse

pattern - The DateTime pattern embedded in the string such as "yyyy-MM-dd". The pattern must be a valid DateTime Joda pattern.

zone - The timezone the parsed date will be in

Returns:

The parsed DateTime value

Throws:

IllegalArgumentException - Thrown if the pattern is invalid or if string did not contain an embedded date.

floorToYear

public static org.joda.time.DateTime floorToYear(org.joda.time.DateTime value)

Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest year. Note that the nearest valid year is actually the first of that given year (Jan 1). The time zone of the returned DateTime instance will be the same as the argument. Similar to a floor() function on a float.
Examples:

• null -> null
• "2009-06-24 13:24:51.476 -8:00" -> "2009-01-01 00:00:00.000 -8:00"

Parameters:

value - The DateTime value to round downward

Returns:

Null if the argument is null or a new instance of the DateTime value rounded downwards to the nearest year.

floorToMonth

public static org.joda.time.DateTime floorToMonth(org.joda.time.DateTime value)

Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest month. Note that the nearest valid month is actually the first of that given month (1st day of month). The time zone of the returned DateTime instance will be the same as the argument. Similar to a floor() function on a float.
Examples:

• null -> null
• "2009-06-24 13:24:51.476 -8:00" -> "2009-06-01 00:00:00.000 -8:00"

Parameters:

value - The DateTime value to round downward

Returns:

Null if the argument is null or a new instance of the DateTime value rounded downwards to the nearest month.

floorToDay

public static org.joda.time.DateTime floorToDay(org.joda.time.DateTime value)

Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest day. The time zone of the returned DateTime instance will be the same as the argument. Similar to a floor() function on a float.
Examples:

• null -> null
• "2009-06-24 13:24:51.476 -8:00" -> "2009-06-24 00:00:00.000 -8:00"

Parameters:

value - The DateTime value to round downward

Returns:

Null if the argument is null or a new instance of the DateTime value rounded downwards to the nearest day.

floorToHour

public static org.joda.time.DateTime floorToHour(org.joda.time.DateTime value)

Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest hour. The time zone of the returned DateTime instance will be the same as the argument. Similar to a floor() function on a float.
Examples:

• null -> null
• "2009-06-24 13:24:51.476 -8:00" -> "2009-06-24 13:00:00.000 -8:00"

Parameters:

value - The DateTime value to round downward

Returns:

Null if the argument is null or a new instance of the DateTime value rounded downwards to the nearest hour.

floorToHalfHour

public static org.joda.time.DateTime floorToHalfHour(org.joda.time.DateTime value)

Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest half hour (30 minutes). The time zone of the returned DateTime instance will be the same as the argument. Similar to a floor() function on a float.
Examples:

• null -> null
• "2009-06-24 13:29:51.476 -8:00" -> "2009-06-24 13:00:00.000 -8:00"

Parameters:

value - The DateTime value to round downward

Returns:

Null if the argument is null or a new instance of the DateTime value rounded downwards to the nearest 30 minutes.

floorToQuarterHour

public static org.joda.time.DateTime floorToQuarterHour(org.joda.time.DateTime value)

Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest 15 minutes. The time zone of the returned DateTime instance will be the same as the argument. Similar to a floor() function on a float.
Examples:

• null -> null
• "2009-06-24 13:29:51.476 -8:00" -> "2009-06-24 13:15:00.000 -8:00"

Parameters:

value - The DateTime value to round downward

Returns:

Null if the argument is null or a new instance of the DateTime value rounded downwards to the nearest 15 minutes.

floorToTenMinutes

public static org.joda.time.DateTime floorToTenMinutes(org.joda.time.DateTime value)

Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest 10 minutes. The time zone of the returned DateTime instance will be the same as the argument. Similar to a floor() function on a float.
Examples:

• null -> null
• "2009-06-24 13:29:51.476 -8:00" -> "2009-06-24 13:20:00.000 -8:00"

Parameters:

value - The DateTime value to round downward

Returns:

Null if the argument is null or a new instance of the DateTime value rounded downwards to the nearest 10 minutes.

floorToFiveMinutes

public static org.joda.time.DateTime floorToFiveMinutes(org.joda.time.DateTime value)

Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest 5 minutes. The time zone of the returned DateTime instance will be the same as the argument. Similar to a floor() function on a float.
Examples:

• null -> null
• "2009-06-24 13:24:51.476 -8:00" -> "2009-06-24 13:20:00.000 -8:00"

Parameters:

value - The DateTime value to round downward

Returns:

Null if the argument is null or a new instance of the DateTime value rounded downwards to the nearest 5 minutes.

floorToMinutePeriod

public static org.joda.time.DateTime floorToMinutePeriod(org.joda.time.DateTime value,
                                         int periodInMinutes)

Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest specified period in minutes. For example, if a period of 5 minutes is requested, a time of "2009-06-24 13:24:51.476 -8:00" would return a datetime of "2009-06-24 13:20:00.000 -8:00". The time zone of the returned DateTime instance will be the same as the argument. Similar to a floor() function on a float.
NOTE: While any period in minutes between 1 and 59 can be passed into this method, its only useful if the value can be evenly divided into 60 to make it as useful as possible.
Examples:

• null -> null
• 5: "2009-06-24 13:39:51.476 -8:00" -> "2009-06-24 13:35:00.000 -8:00"
• 10: "2009-06-24 13:39:51.476 -8:00" -> "2009-06-24 13:30:00.000 -8:00"
• 15: "2009-06-24 13:39:51.476 -8:00" -> "2009-06-24 13:30:00.000 -8:00"
• 20: "2009-06-24 13:39:51.476 UTC" -> "2009-06-24 13:20:00.000 UTC"

Parameters:

value - The DateTime value to round downward

Returns:

Null if the argument is null or a new instance of the DateTime value rounded downwards to the nearest period in minutes.

floorToMinute

public static org.joda.time.DateTime floorToMinute(org.joda.time.DateTime value)

Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest minute. The time zone of the returned DateTime instance will be the same as the argument. Similar to a floor() function on a float.
Examples:

• null -> null
• "2009-06-24 13:24:51.476 -8:00" -> "2009-06-24 13:24:00.000 -8:00"

Parameters:

value - The DateTime value to round downward

Returns:

Null if the argument is null or a new instance of the DateTime value rounded downwards to the nearest minute.

floorToSecond

public static org.joda.time.DateTime floorToSecond(org.joda.time.DateTime value)

Null-safe method that returns a new instance of a DateTime object rounded downwards to the nearest second. The time zone of the returned DateTime instance will be the same as the argument. Similar to a floor() function on a float.
Examples:

• null -> null
• "2009-06-24 13:24:51.476 -8:00" -> "2009-06-24 13:24:51.000 -8:00"

Parameters:

value - The DateTime value to round downward

Returns:

Null if the argument is null or a new instance of the DateTime value rounded downwards to the nearest second.