org.finra.herd.core

Class HerdDateUtils

java.lang.Object

org.apache.commons.lang3.time.DateUtils

org.finra.herd.core.HerdDateUtils

public class HerdDateUtils
extends org.apache.commons.lang3.time.DateUtils

Provides additional utility methods for dates and times.

Field Summary

Fields inherited from class org.apache.commons.lang3.time.DateUtils

MILLIS_PER_DAY, MILLIS_PER_HOUR, MILLIS_PER_MINUTE, MILLIS_PER_SECOND, RANGE_MONTH_MONDAY, RANGE_MONTH_SUNDAY, RANGE_WEEK_CENTER, RANGE_WEEK_MONDAY, RANGE_WEEK_RELATIVE, RANGE_WEEK_SUNDAY, SEMI_MONTH

Constructor Summary

Constructors

Constructor and Description
HerdDateUtils()

Method Summary

Modifier and Type	Method and Description
static Timestamp	addDays(Timestamp timestamp, int amount) Adds a number of days to a timestamp returning a new object.
static Timestamp	addMinutes(Timestamp timestamp, int amount) Adds a number of minutes to a timestamp returning a new object.
static Boolean	containsTimePortion(XMLGregorianCalendar xmlGregorianCalendar) Determines if a provided XMLGregorianCalendar calendar object contains a time portion
static Timestamp	convertToTimestamp(XMLGregorianCalendar xmlGregorianCalendar) Converts a provided XMLGregorianCalendar calendar object to a Timestamp object
static String	formatDuration(long duration) Formats a "total milliseconds" duration.
static Calendar	getCurrentCalendarNoTime() Returns a calendar for the current day that does not have the time set.
static XMLGregorianCalendar	getXMLGregorianCalendarValue(Date date) Gets an instance of XMLGregorianCalendar class initialized per the specified java.util.Date value.
static XMLGregorianCalendar	now() Gets the current date/time as an XMLGregorianCalendar with the default time zone in the default locale.
static Timestamp	resetTimeToMidnight(XMLGregorianCalendar xmlGregorianCalendar) Removes time portion of the date time object.

Methods inherited from class org.apache.commons.lang3.time.DateUtils

addDays, addHours, addMilliseconds, addMinutes, addMonths, addSeconds, addWeeks, addYears, ceiling, ceiling, ceiling, getFragmentInDays, getFragmentInDays, getFragmentInHours, getFragmentInHours, getFragmentInMilliseconds, getFragmentInMilliseconds, getFragmentInMinutes, getFragmentInMinutes, getFragmentInSeconds, getFragmentInSeconds, isSameDay, isSameDay, isSameInstant, isSameInstant, isSameLocalTime, iterator, iterator, iterator, parseDate, parseDate, parseDateStrictly, parseDateStrictly, round, round, round, setDays, setHours, setMilliseconds, setMinutes, setMonths, setSeconds, setYears, toCalendar, toCalendar, truncate, truncate, truncate, truncatedCompareTo, truncatedCompareTo, truncatedEquals, truncatedEquals

Methods inherited from class java.lang.Object

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

Constructor Detail

HerdDateUtils

public HerdDateUtils()

Method Detail

getCurrentCalendarNoTime

public static Calendar getCurrentCalendarNoTime()

Returns a calendar for the current day that does not have the time set.

Returns:

the current date.

formatDuration

public static String formatDuration(long duration)

Formats a "total milliseconds" duration.

Parameters:

duration - the duration in milliseconds to format.

Returns:

The formatted duration.

now

public static XMLGregorianCalendar now()

Gets the current date/time as an XMLGregorianCalendar with the default time zone in the default locale.

Returns:

the current date/time.

getXMLGregorianCalendarValue

public static XMLGregorianCalendar getXMLGregorianCalendarValue(Date date)

Gets an instance of XMLGregorianCalendar class initialized per the specified java.util.Date value. Returns the current date/time if date is null.

Parameters:

date - the java.util.Date value to be converted into XMLGregorianCalendar.

Returns:

the XMLGregorianCalendar instance initialized per specified date value

addDays

public static Timestamp addDays(Timestamp timestamp,
                                int amount)

Adds a number of days to a timestamp returning a new object. The original Timestamp is unchanged.

Parameters:

timestamp - the timestamp, not null

amount - the amount to add, may be negative

Returns:

the new Timestamp with the amount added

addMinutes

public static Timestamp addMinutes(Timestamp timestamp,
                                   int amount)

Adds a number of minutes to a timestamp returning a new object. The original Timestamp is unchanged.

Parameters:

timestamp - the timestamp, not null

amount - the amount to add, may be negative

Returns:

the new Timestamp with the amount added

resetTimeToMidnight

public static Timestamp resetTimeToMidnight(XMLGregorianCalendar xmlGregorianCalendar)

Removes time portion of the date time object.

Parameters:

xmlGregorianCalendar - the xmlGregorianCalendar, not null

Returns:

the new Timestamp with reset time portion

convertToTimestamp

public static Timestamp convertToTimestamp(XMLGregorianCalendar xmlGregorianCalendar)

Converts a provided XMLGregorianCalendar calendar object to a Timestamp object

Parameters:

xmlGregorianCalendar - the specified XMLGregorianCalendar object

Returns:

the converted Timestamp object

containsTimePortion

public static Boolean containsTimePortion(XMLGregorianCalendar xmlGregorianCalendar)

Determines if a provided XMLGregorianCalendar calendar object contains a time portion

Parameters:

xmlGregorianCalendar - the specified XMLGregorianCalendar object

Returns:

true if the specified calendar object contains a time portion, otherwise false