ucar.nc2.time

Class CalendarDate

java.lang.Object

ucar.nc2.time.CalendarDate

All Implemented Interfaces:

Comparable<CalendarDate>

@Immutable
public class CalendarDate
extends Object
implements Comparable<CalendarDate>

A Calendar Date. Replaces java.util.Date. Allows non-standard calendars. Default is Calendar.gregorian. Always in UTC time zone.

Since:

3/21/11

Author:

caron

Method Summary

Methods

Modifier and Type	Method and Description
CalendarDate	add(CalendarPeriod period)
CalendarDate	add(double value, CalendarPeriod.Field unit)
int	compareTo(CalendarDate o)
boolean	equals(Object o)
Calendar	getCalendar()
long	getDifferenceInMsecs(CalendarDate o) Get difference between two calendar dates in millisecs
int	getHourOfDay() Get the hour of day (0-23) field for this chronology.
int	hashCode()
boolean	isAfter(CalendarDate o)
boolean	isBefore(CalendarDate o)
static void	main(String[] args)
static CalendarDate	of(Calendar cal, int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute)
static CalendarDate	of(Date date) Create CalendarDate from a java.util.Date
static CalendarDate	of(long msecs) Create CalendarDate from msecs since epoch
static CalendarDate	parseISOformat(String calendarName, String isoDateString) Get CalendarDate from ISO date string
static CalendarDate	parseUdunits(String calendarName, String udunits) Get CalendarDate from udunit date string
static CalendarDate	present() Get a CalendarDate representing the present moment
CalendarDate	subtract(CalendarPeriod period)
Date	toDate()
String	toString() ISO formatted string
static CalendarDate	withDoy(Calendar cal, int year, int doy, int hourOfDay, int minuteOfHour, int secondOfMinute)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

present

public static CalendarDate present()

Get a CalendarDate representing the present moment

Returns:

CalendarDate representing the present moment

of

public static CalendarDate of(Calendar cal,
              int year,
              int monthOfYear,
              int dayOfMonth,
              int hourOfDay,
              int minuteOfHour,
              int secondOfMinute)

Parameters:

cal - calendar to use, or null for default

year - any integer

monthOfYear - 1-12

dayOfMonth - 1-31

hourOfDay - 0-23

minuteOfHour - 0-59

secondOfMinute - 0-59

Returns:

CalendarDate

withDoy

public static CalendarDate withDoy(Calendar cal,
                   int year,
                   int doy,
                   int hourOfDay,
                   int minuteOfHour,
                   int secondOfMinute)

of

public static CalendarDate of(Date date)

Create CalendarDate from a java.util.Date

Parameters:

date - java.util.Date

Returns:

CalendarDate

of

public static CalendarDate of(long msecs)

Create CalendarDate from msecs since epoch

Parameters:

msecs - milliseconds from 1970-01-01T00:00:00Z

Returns:

CalendarDate

parseISOformat

public static CalendarDate parseISOformat(String calendarName,
                          String isoDateString)

Get CalendarDate from ISO date string

Parameters:

calendarName - get Calendar from Calendar.get(calendarName). may be null

isoDateString - ISO date string

Returns:

CalendarDate

parseUdunits

public static CalendarDate parseUdunits(String calendarName,
                        String udunits)

Get CalendarDate from udunit date string

Parameters:

calendarName - get Calendar from Calendar.get(calendarName). may be null

udunits - must be value (space) udunits string

Returns:

CalendarDate

getCalendar

public Calendar getCalendar()

compareTo

public int compareTo(CalendarDate o)

Specified by:

compareTo in interface Comparable<CalendarDate>

isAfter

public boolean isAfter(CalendarDate o)

isBefore

public boolean isBefore(CalendarDate o)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

ISO formatted string

Overrides:

toString in class Object

Returns:

ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)

getHourOfDay

public int getHourOfDay()

Get the hour of day (0-23) field for this chronology.

Returns:

hour of day (0-23)

add

public CalendarDate add(double value,
               CalendarPeriod.Field unit)

add

public CalendarDate add(CalendarPeriod period)

subtract

public CalendarDate subtract(CalendarPeriod period)

toDate

public Date toDate()

getDifferenceInMsecs

public long getDifferenceInMsecs(CalendarDate o)

Get difference between two calendar dates in millisecs

Parameters:

o - other calendar date

Returns:

(this minus o) difference in millisecs

main

public static void main(String[] args)