CalendarDateUnit (NetCDF-Java CDM Public API v5.5.4-SNAPSHOT)

java.lang.Object
- ucar.nc2.time.CalendarDateUnit

```
@Immutable
public class CalendarDateUnit
extends java.lang.Object
```
A Calendar Date Unit: "unit since date"
```
 UNIT since [-]Y[Y[Y[Y]]]-MM-DD[(T| )hh[:mm[:ss[.sss*]]][ [+|-]hh[[:]mm]]]

 UNIT = "msecs" | "msec" |
          "seconds" | "second" | "secs" | "sec" | "s" |
          "minutes" | "minute" | "mins" | "min" |
          "hours" | "hour" | "hrs" | "hr" | "h" |
          "days" | "day" | "d"
 
```
"months since base_date by calendar field" "years since base_date by calendar field" bob simon's proposal: "calendar_month since base_date" "calendar_year since base_date" * only integer values are allowed (?) jon blowers comment: In your view would the solution to add "by calendar field" to the existing udunits string be acceptable? It’s backward-compatible with the current interpretation and adds clarification for the cases in which we *do* want to do calendar-field arithmetic (instead of adding fixed intervals). There’s an alternative proposition, in which the new units of calendar_month and calendar_year are added, with the same semantic effect. (However, personally I like the "by calendar field" solution since it allows other fields to vary between calendars, e.g. because of leap-seconds.)
Since:

3/18/11

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String udunitPatternString

static CalendarDateUnit unixDateUnit

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`udunitPatternString`
`static CalendarDateUnit`	`unixDateUnit`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`CalendarDate`	`getBaseCalendarDate()`
`Calendar`	`getCalendar()`
`CalendarPeriod.Field`	`getCalendarField()`
`CalendarPeriod`	`getCalendarPeriod()`
`java.lang.String`	`getUdUnit()`
`int`	`hashCode()`
`boolean`	`isCalendarField()`
`CalendarDate`	`makeCalendarDate(double value)`
`CalendarDate`	`makeCalendarDate(int value)`
`double`	`makeOffsetFromRefDate(CalendarDate date)`
`static CalendarDateUnit`	`of(Calendar calt, CalendarPeriod.Field periodField, CalendarDate baseDate)` Create a CalendarDateUnit from a calendar, a CalendarPeriod.Field, and a base date
`static CalendarDateUnit`	`of(java.lang.String calendarName, java.lang.String udunitString)` Create a CalendarDateUnit from a calendar name and a udunit string = "unit since calendarDate"
`java.lang.String`	`toString()`
`static CalendarDateUnit`	`withCalendar(Calendar calt, java.lang.String udunitString)` Create a CalendarDateUnit from a calendar and a udunit string = "unit since calendarDate"

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - udunitPatternString
```
public static final java.lang.String udunitPatternString
```
    See Also:
    
    Constant Field Values
  - unixDateUnit
```
public static final CalendarDateUnit unixDateUnit
```
- Method Detail
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - getBaseCalendarDate
```
public CalendarDate getBaseCalendarDate()
```
  - getCalendar
```
public Calendar getCalendar()
```
  - getCalendarField
```
public CalendarPeriod.Field getCalendarField()
```
  - getCalendarPeriod
```
public CalendarPeriod getCalendarPeriod()
```
  - getUdUnit
```
public java.lang.String getUdUnit()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - isCalendarField
```
public boolean isCalendarField()
```
  - makeCalendarDate
```
public CalendarDate makeCalendarDate(double value)
```
  - makeCalendarDate
```
public CalendarDate makeCalendarDate(int value)
```
  - makeOffsetFromRefDate
```
public double makeOffsetFromRefDate(CalendarDate date)
```
  - of
```
public static CalendarDateUnit of(Calendar calt,
                                  CalendarPeriod.Field periodField,
                                  CalendarDate baseDate)
```
    Create a CalendarDateUnit from a calendar, a CalendarPeriod.Field, and a base date
    
    Parameters:
    
    calt - use this Calendar, or null for default calendar
    
    periodField - a CalendarPeriod.Field like Hour or second
    
    baseDate - "since baseDate"
    
    Returns:
    
    CalendarDateUnit
  - of
```
public static CalendarDateUnit of(java.lang.String calendarName,
                                  java.lang.String udunitString)
```
    Create a CalendarDateUnit from a calendar name and a udunit string = "unit since calendarDate"
    
    Parameters:
    
    calendarName - must match a calendar enum, or one of its aliases, see ucar.nc2.time.Calendar.get()
    
    udunitString - "unit since calendarDate"
    
    Returns:
    
    CalendarDateUnit
    
    Throws:
    
    java.lang.IllegalArgumentException - if udunitString is not paresable
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - withCalendar
```
public static CalendarDateUnit withCalendar(Calendar calt,
                                            java.lang.String udunitString)
```
    Create a CalendarDateUnit from a calendar and a udunit string = "unit since calendarDate"
    
    Parameters:
    
    calt - use this Calendar, or null for default calendar
    
    udunitString - "unit since calendarDate"
    
    Returns:
    
    CalendarDateUnit
    
    Throws:
    
    java.lang.IllegalArgumentException - if udunitString is not paresable

Class CalendarDateUnit

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

udunitPatternString

unixDateUnit

Method Detail

equals

getBaseCalendarDate

getCalendar

getCalendarField

getCalendarPeriod

getUdUnit

hashCode

isCalendarField

makeCalendarDate

makeCalendarDate

makeOffsetFromRefDate

of

of

toString

withCalendar