er.extensions.foundation

Class ERXTimestampUtilities

java.lang.Object

er.extensions.foundation.ERXTimestampUtilities

public class ERXTimestampUtilities
extends Object

Collection of NSTimestamp utilities.

Constructor Summary

Constructors

Constructor and Description
ERXTimestampUtilities()

Method Summary

Modifier and Type	Method and Description
static GregorianCalendar	calendarForTimestamp(NSTimestamp t)
static long	compareDatesInCommonEra(NSTimestamp t1, NSTimestamp t2, int mode)
static int	dayOfCommonEra(NSTimestamp t)
static int	dayOfMonth(NSTimestamp t)
static int	dayOfWeek(NSTimestamp t)
static int	dayOfYear(NSTimestamp t)
static long	differenceByDay(NSTimestamp t1, NSTimestamp t2)
static long	differenceByMonth(NSTimestamp t1, NSTimestamp t2)
static long	differenceByWeek(NSTimestamp t1, NSTimestamp t2)
static long	differenceByYear(NSTimestamp t1, NSTimestamp t2)
static NSTimestamp	epoch() Utility method used to return the epoch, Jan 1st, 1970
static NSTimestamp	firstDateInNextMonth(NSTimestamp value)
static NSTimestamp	firstDateInSameMonth(NSTimestamp value)
static NSTimestamp	firstDateInSameWeek(NSTimestamp value)
static NSTimestampFormatter	gregorianDateFormatterForJavaDate() Utility method to return a standard timestamp formatter for the default string representation of java dates.
static int	hourOfDay(NSTimestamp t)
static boolean	isWeekDay(NSTimestamp t)
static int	minuteOfHour(NSTimestamp t)
static int	monthOfCommonEra(NSTimestamp t)
static int	monthOfYear(NSTimestamp t)
static long	offsetForDateInCommonEra(NSTimestamp t, int mode)
static int	secondOfMinute(NSTimestamp t)
static String	simpleDateFormatForNSTimestampFormat(String timestampFormatterPattern) Returns the SimpleDateFormat pattern given an NSTimestampFormatter pattern.
static NSTimestamp	timestampByAddingTime(NSTimestamp ts, NSTimestamp t1) Adds the time (hours, minutes and seconds) from the second timestamp to the first timestamp.
static NSTimestamp	timestampForString(String defaultValue) Calculates a timestamp given a string.
static NSTimestamp	today() Timestamp representing today (12:00 AM).
static NSTimestamp	tomorrow() Timestamp representing tomorrow (12:00 AM).
static NSTimestamp	unixDate(Number helpedNSNumber) Converts an offset from the epoch into a timestamp.
static Integer	unixTimestamp(NSTimestamp ts) Converts a timestamp into the equivalent unix offset from the epoch.
static int	weekOfCommonEra(NSTimestamp t)
static int	weekOfMonth(NSTimestamp t)
static int	weekOfYear(NSTimestamp t)
static int	yearOfCommonEra(NSTimestamp t)
static NSTimestamp	yesterday() Timestamp representing yesterday (12:00 AM).

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXTimestampUtilities

public ERXTimestampUtilities()

Method Detail

timestampForString

public static NSTimestamp timestampForString(String defaultValue)

Calculates a timestamp given a string. Currently supports the strings: now, today, yesterday, tomorrow, distantPast and distantFuture.

Parameters:

defaultValue - string given above

Returns:

timestamp equivalent to the string

today

public static NSTimestamp today()

Timestamp representing today (12:00 AM). Implementation wise this method subtracts the current hours, minutes and seconds from the current time.

Returns:

timestamp for today.

tomorrow

public static NSTimestamp tomorrow()

Timestamp representing tomorrow (12:00 AM). Implementation wise this method subtracts the current hours, minutes and seconds from the current time and then adds one day.

Returns:

timestamp for tomorrow.

yesterday

public static NSTimestamp yesterday()

Timestamp representing yesterday (12:00 AM). Implementation wise this method subtracts the current hours, minutes and seconds from the current time and then subtracts one day.

Returns:

timestamp for yesterday.

timestampByAddingTime

public static NSTimestamp timestampByAddingTime(NSTimestamp ts,
                                                NSTimestamp t1)

Adds the time (hours, minutes and seconds) from the second timestamp to the first timestamp.

Parameters:

ts - timestamp to have the time added too.

t1 - timestamp to add the time from

Returns:

the first timestamp with the time of the second added to it.

epoch

public static NSTimestamp epoch()

Utility method used to return the epoch, Jan 1st, 1970

Returns:

the epoch as an NSTimestamp

unixDate

public static NSTimestamp unixDate(Number helpedNSNumber)

Converts an offset from the epoch into a timestamp.

Parameters:

helpedNSNumber - number offset from the epoch

Returns:

timestamp representation of the offset from the epoch.

unixTimestamp

public static Integer unixTimestamp(NSTimestamp ts)

Converts a timestamp into the equivalent unix offset from the epoch.

Parameters:

ts - timestamp to be converted

Returns:

timestamp represented as an integer offset from the epoch.

simpleDateFormatForNSTimestampFormat

public static String simpleDateFormatForNSTimestampFormat(String timestampFormatterPattern)

Returns the SimpleDateFormat pattern given an NSTimestampFormatter pattern. Note that these are not 100% compatible -- SimpleDateFormat properly implements DST and TimeZones whereas NSTimestampFormatter is ... kind of whacked, so you may notice your dates are off by a DST amount.

Parameters:

timestampFormatterPattern - the NSTimestampFormatter pattern

Returns:

a SimpleDateFormat pattern

calendarForTimestamp

public static GregorianCalendar calendarForTimestamp(NSTimestamp t)

offsetForDateInCommonEra

public static long offsetForDateInCommonEra(NSTimestamp t,
                                            int mode)

differenceByDay

public static long differenceByDay(NSTimestamp t1,
                                   NSTimestamp t2)

differenceByWeek

public static long differenceByWeek(NSTimestamp t1,
                                    NSTimestamp t2)

differenceByMonth

public static long differenceByMonth(NSTimestamp t1,
                                     NSTimestamp t2)

differenceByYear

public static long differenceByYear(NSTimestamp t1,
                                    NSTimestamp t2)

firstDateInSameWeek

public static NSTimestamp firstDateInSameWeek(NSTimestamp value)

firstDateInSameMonth

public static NSTimestamp firstDateInSameMonth(NSTimestamp value)

firstDateInNextMonth

public static NSTimestamp firstDateInNextMonth(NSTimestamp value)

compareDatesInCommonEra

public static long compareDatesInCommonEra(NSTimestamp t1,
                                           NSTimestamp t2,
                                           int mode)

dayOfCommonEra

public static int dayOfCommonEra(NSTimestamp t)

monthOfCommonEra

public static int monthOfCommonEra(NSTimestamp t)

weekOfCommonEra

public static int weekOfCommonEra(NSTimestamp t)

isWeekDay

public static boolean isWeekDay(NSTimestamp t)

dayOfWeek

public static int dayOfWeek(NSTimestamp t)

dayOfMonth

public static int dayOfMonth(NSTimestamp t)

weekOfYear

public static int weekOfYear(NSTimestamp t)

weekOfMonth

public static int weekOfMonth(NSTimestamp t)

dayOfYear

public static int dayOfYear(NSTimestamp t)

hourOfDay

public static int hourOfDay(NSTimestamp t)

minuteOfHour

public static int minuteOfHour(NSTimestamp t)

secondOfMinute

public static int secondOfMinute(NSTimestamp t)

monthOfYear

public static int monthOfYear(NSTimestamp t)

yearOfCommonEra

public static int yearOfCommonEra(NSTimestamp t)

gregorianDateFormatterForJavaDate

public static NSTimestampFormatter gregorianDateFormatterForJavaDate()

Utility method to return a standard timestamp formatter for the default string representation of java dates.

Returns:

timestamp formatter for java dates.