com.numericalmethod.suanshu.time

Class JodaTimeUtils

java.lang.Object

com.numericalmethod.suanshu.time.JodaTimeUtils

public class JodaTimeUtils
extends java.lang.Object

These are the utility functions to manipulate JodaTime.

Field Summary

Fields

Modifier and Type	Field and Description
static org.joda.time.DateTime	BEGINNING_OF_TIME This represents a time before all (representable) times.
static long	BEGINNING_OF_TIME_LONG This represents a time before all (representable) times, in long representation.
static org.joda.time.DateTime	ENDING_OF_TIME This represents a time after all (representable) times.
static long	ENDING_OF_TIME_LONG This represents a time after all (representable) times, in long representation.
static org.joda.time.DateTimeZone	EST EST
static org.joda.time.DateTimeZone	GMT GMT
static org.joda.time.DateTime	ORIGIN This is the reference time "origin": 1970 January 1, midnight, UTC.

Method Summary

Modifier and Type	Method and Description
static org.joda.time.DateTime	getDate(int year, int month, int day, org.joda.time.DateTimeZone tz) Construct a DateTime instance with year, month, day, and time zone.
static org.joda.time.DateTime	getDateTime(java.lang.String str) Construct a DateTime instance from a string which ends in TimeZone specification.
static org.joda.time.DateTime	getDateTime(java.lang.String str, java.text.DateFormat format, org.joda.time.DateTimeZone tz) Construct a DateTime instance from a string with no TimeZone specified.
static org.joda.time.DateTime	getLastDayOfMonth(org.joda.time.DateTime t) Get the last day of the month which contain a time.
static org.joda.time.DateTime	getLastMillisecondOfDay(org.joda.time.DateTime t) Get the last millisecond the day which contain a time.
static int	getNumberOfPeriodsBetween(org.joda.time.DateTime t1, org.joda.time.DateTime t2, org.joda.time.Period period) Return the number of periods between two times, rounding up.
static boolean	isWeekend(org.joda.time.DateTime time) Check if the given time is a weekend.
static java.util.List<org.joda.time.DateTime>	makePeriodicInstants(org.joda.time.DateTime startTime, org.joda.time.Period period, int nPeriods) Make a list of periodic time instants.
static org.joda.time.DateTime	max(org.joda.time.DateTime t1, org.joda.time.DateTime t2) Return the later of two DateTime instances.
static org.joda.time.DateTime	min(org.joda.time.DateTime t1, org.joda.time.DateTime t2) Return the earlier of two DateTime instances.
static org.joda.time.DateTime	minusWeekdayPeriod(org.joda.time.DateTime time, org.joda.time.Period period) Subtract a weekday-period (i.e., skipping weekends) from a DateTime.
static org.joda.time.DateTime	nextWeekDay(org.joda.time.DateTime time) Get the next weekday, i.e., skipping Saturdays and Sundays.
static org.joda.time.DateTime	plusWeekdayPeriod(org.joda.time.DateTime time, org.joda.time.Period period) Add a weekday-period (i.e., skipping weekends) to a DateTime.
static org.joda.time.DateTime	previousWeekDay(org.joda.time.DateTime time) Get the previous weekday, i.e., skipping Saturdays and Sundays.

Methods inherited from class java.lang.Object

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

Field Detail

GMT

public static final org.joda.time.DateTimeZone GMT

GMT

EST

public static final org.joda.time.DateTimeZone EST

EST

ORIGIN

public static final org.joda.time.DateTime ORIGIN

This is the reference time "origin": 1970 January 1, midnight, UTC.

BEGINNING_OF_TIME

public static final org.joda.time.DateTime BEGINNING_OF_TIME

This represents a time before all (representable) times.

BEGINNING_OF_TIME_LONG

public static final long BEGINNING_OF_TIME_LONG

This represents a time before all (representable) times, in long representation.

ENDING_OF_TIME

public static final org.joda.time.DateTime ENDING_OF_TIME

This represents a time after all (representable) times.

ENDING_OF_TIME_LONG

public static final long ENDING_OF_TIME_LONG

This represents a time after all (representable) times, in long representation.

Method Detail

getDate

public static org.joda.time.DateTime getDate(int year,
                                             int month,
                                             int day,
                                             org.joda.time.DateTimeZone tz)

Construct a DateTime instance with year, month, day, and time zone. It is set to mid-night.

Parameters:

year - year

month - month of the year

day - day of the month

tz - time zone

Returns:

a DateTime object

getDateTime

public static org.joda.time.DateTime getDateTime(java.lang.String str)
                                          throws java.text.ParseException

Construct a DateTime instance from a string which ends in TimeZone specification.

Parameters:

str - the date-time string

Returns:

a DateTime representation

Throws:

java.text.ParseException - if there is an error parsing the string

getDateTime

public static org.joda.time.DateTime getDateTime(java.lang.String str,
                                                 java.text.DateFormat format,
                                                 org.joda.time.DateTimeZone tz)
                                          throws java.text.ParseException

Construct a DateTime instance from a string with no TimeZone specified.

Parameters:

str - the date-time string

format - the formatter

tz - the time zone; null if default time zone

Returns:

a DateTime representation

Throws:

java.text.ParseException - if there is an error parsing the string

nextWeekDay

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

Get the next weekday, i.e., skipping Saturdays and Sundays.

Parameters:

time - a DateTime

Returns:

next weekday

previousWeekDay

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

Get the previous weekday, i.e., skipping Saturdays and Sundays.

Parameters:

time - a DateTime

Returns:

the previous weekday

plusWeekdayPeriod

public static org.joda.time.DateTime plusWeekdayPeriod(org.joda.time.DateTime time,
                                                       org.joda.time.Period period)

Add a weekday-period (i.e., skipping weekends) to a DateTime. For example, adding a weekday-period of 2 days and 4 hours to a time instant representing Thursday 5pm results in a time instant at next Monday 9pm.

Parameters:

time - the original time instant

period - the period to be added

Returns:

the DateTime after the period added

minusWeekdayPeriod

public static org.joda.time.DateTime minusWeekdayPeriod(org.joda.time.DateTime time,
                                                        org.joda.time.Period period)

Subtract a weekday-period (i.e., skipping weekends) from a DateTime. For example, subtracting a weekday-period of 2 days and 4 hours from a time instant representing Monday 9pm results in a time instant at previous Thursday 5pm.

Parameters:

time - the original time instant

period - the period to be added

Returns:

the DateTime after the period subtracted

isWeekend

public static boolean isWeekend(org.joda.time.DateTime time)

Check if the given time is a weekend.

Parameters:

time - a time

Returns:

true if the given time is a weekend

min

public static org.joda.time.DateTime min(org.joda.time.DateTime t1,
                                         org.joda.time.DateTime t2)

Return the earlier of two DateTime instances.

Parameters:

t1 - time 1

t2 - time 2

Returns:

the earlier of t1 and t2

max

public static org.joda.time.DateTime max(org.joda.time.DateTime t1,
                                         org.joda.time.DateTime t2)

Return the later of two DateTime instances.

Parameters:

t1 - time 1

t2 - time 2

Returns:

the later of t1 and t2

getNumberOfPeriodsBetween

public static int getNumberOfPeriodsBetween(org.joda.time.DateTime t1,
                                            org.joda.time.DateTime t2,
                                            org.joda.time.Period period)

Return the number of periods between two times, rounding up.

Parameters:

t1 - time 1

t2 - time 2

period - a duration

Returns:

the number of periods between t1 and t2

makePeriodicInstants

public static java.util.List<org.joda.time.DateTime> makePeriodicInstants(org.joda.time.DateTime startTime,
                                                                          org.joda.time.Period period,
                                                                          int nPeriods)

Make a list of periodic time instants.

Parameters:

startTime - start time

period - the period

nPeriods - the number of instants, excluding start time

Returns:

a list of periodic time instants

getLastDayOfMonth

public static org.joda.time.DateTime getLastDayOfMonth(org.joda.time.DateTime t)

Get the last day of the month which contain a time.

Parameters:

t - a time

Returns:

the last day of the month t is in

getLastMillisecondOfDay

public static org.joda.time.DateTime getLastMillisecondOfDay(org.joda.time.DateTime t)

Get the last millisecond the day which contain a time.

Parameters:

t - a time

Returns:

the last millisecond of the day t is in