CalendarDate (CDM core library 4.6.0 API)

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

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`MILLISECS_IN_DAY`
`static double`	`MILLISECS_IN_HOUR`
`static double`	`MILLISECS_IN_MINUTE`
`static double`	`MILLISECS_IN_MONTH`
`static double`	`MILLISECS_IN_SECOND`
`static double`	`MILLISECS_IN_YEAR`

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()`
`int`	`getDayOfMonth()`
`long`	`getDifferenceInMsecs(CalendarDate o)` Get difference between two calendar dates in millisecs
`int`	`getFieldValue(CalendarPeriod.Field fld)`
`int`	`getHourOfDay()` Get the hour of day (0-23) field for this chronology.
`long`	`getMillis()` Gets the milliseconds of the datetime instant from the Java epoch of 1970-01-01T00:00:00Z.
`String`	`getTimeUnits()` udunits formatting
`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)` Get Calendar date from fields.
`static CalendarDate`	`of(Calendar cal, long msecs)` Create CalendarDate from msecs since epoch Uses the given Calendar.
`static CalendarDate`	`of(Date date)` Create CalendarDate from a java.util.Date.
`static CalendarDate`	`of(long msecs)` Create CalendarDate from msecs since epoch Uses standard Calendar.
`static CalendarDate`	`parseISOformat(String calendarName, String isoDateString)` Get CalendarDate from ISO date string
`static CalendarDate`	`parseISOformatOld(String calendarName, String isoDateString)`
`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()` Get the equivilent java.util.Date
`String`	`toString()` ISO formatted string
`CalendarDate`	`truncate(CalendarPeriod.Field fld)` truncate the CalendarDate, by zeroing all the fields that are less than the field.
`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

- Field Detail
  - MILLISECS_IN_SECOND
```
public static final double MILLISECS_IN_SECOND
```
    See Also:
    Constant Field Values
  - MILLISECS_IN_MINUTE
```
public static final double MILLISECS_IN_MINUTE
```
    See Also:
    Constant Field Values
  - MILLISECS_IN_HOUR
```
public static final double MILLISECS_IN_HOUR
```
    See Also:
    Constant Field Values
  - MILLISECS_IN_DAY
```
public static final double MILLISECS_IN_DAY
```
    See Also:
    Constant Field Values
  - MILLISECS_IN_YEAR
```
public static final double MILLISECS_IN_YEAR
```
    See Also:
    Constant Field Values
  - MILLISECS_IN_MONTH
```
public static final double MILLISECS_IN_MONTH
```
    See Also:
    Constant Field Values
- Method Detail
  - present
```
public static CalendarDate present()
```
    Get a CalendarDate representing the present moment
    
    Returns:
    CalendarDate representing the present moment in UTC
  - of
```
public static CalendarDate of(Calendar cal,
              int year,
              int monthOfYear,
              int dayOfMonth,
              int hourOfDay,
              int minuteOfHour,
              int secondOfMinute)
```
    Get Calendar date from fields. Uses UTZ time zone
    
    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. Uses standard Calendar.
    
    Parameters:
    date - java.util.Date
    
    Returns:
    CalendarDate in UTC
  - of
```
public static CalendarDate of(long msecs)
```
    Create CalendarDate from msecs since epoch Uses standard Calendar.
    
    Parameters:
    msecs - milliseconds from 1970-01-01T00:00:00Z
    
    Returns:
    CalendarDate in UTC
  - of
```
public static CalendarDate of(Calendar cal,
              long msecs)
```
    Create CalendarDate from msecs since epoch Uses the given Calendar.
    
    Parameters:
    cal - calendar to use, or null for default
    msecs - milliseconds from 1970-01-01T00:00:00Z
    
    Returns:
    CalendarDate in UTC time zone.
  - 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
  - parseISOformatOld
```
public static CalendarDate parseISOformatOld(String calendarName,
                             String isoDateString)
```
  - 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()
```
  - getMillis
```
public long getMillis()
```
    Gets the milliseconds of the datetime instant from the Java epoch of 1970-01-01T00:00:00Z.
    
    Returns:
    the number of milliseconds since 1970-01-01T00:00:00Z
  - 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)
  - getTimeUnits
```
public String getTimeUnits()
```
    udunits formatting
    
    Returns:
    udunits formatted date
  - getHourOfDay
```
public int getHourOfDay()
```
    Get the hour of day (0-23) field for this chronology.
    
    Returns:
    hour of day (0-23)
  - getFieldValue
```
public int getFieldValue(CalendarPeriod.Field fld)
```
  - getDayOfMonth
```
public int getDayOfMonth()
```
  - add
```
public CalendarDate add(double value,
               CalendarPeriod.Field unit)
```
  - add
```
public CalendarDate add(CalendarPeriod period)
```
  - subtract
```
public CalendarDate subtract(CalendarPeriod period)
```
  - truncate
```
public CalendarDate truncate(CalendarPeriod.Field fld)
```
    truncate the CalendarDate, by zeroing all the fields that are less than the field. So 2013-03-01T19:30 becomes 2013-03-01T00:00 if the field is "day"
    
    Parameters:
    fld - set to 0 all fields less than this one
    
    Returns:
    truncated result
  - toDate
```
public Date toDate()
```
    Get the equivilent java.util.Date
    
    Returns:
    the equivalent Date
  - 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)
```

Class CalendarDate

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MILLISECS_IN_SECOND

MILLISECS_IN_MINUTE

MILLISECS_IN_HOUR

MILLISECS_IN_DAY

MILLISECS_IN_YEAR

MILLISECS_IN_MONTH

Method Detail

present

of

withDoy

of

of

of

parseISOformat

parseISOformatOld

parseUdunits

getCalendar

getMillis

compareTo

isAfter

isBefore

equals

hashCode

toString

getTimeUnits

getHourOfDay

getFieldValue

getDayOfMonth

add

add

subtract

truncate

toDate

getDifferenceInMsecs

main