AbstractCalendar (kona-crypto 1.0.7.1 API)

java.lang.Object
- com.tencent.kona.sun.util.calendar.CalendarSystem
- - com.tencent.kona.sun.util.calendar.AbstractCalendar

Direct Known Subclasses:

BaseCalendar
```
public abstract class AbstractCalendar
extends CalendarSystem
```
The AbstractCalendar class provides a framework for implementing a concrete calendar system.
Fixed Date
For implementing a concrete calendar system, each calendar must have the common date numbering, starting from midnight the onset of Monday, January 1, 1 (Gregorian). It is called a fixed date in this class. January 1, 1 (Gregorian) is fixed date 1. (See Nachum Dershowitz and Edward M. Reingold, CALENDRICAL CALCULATION The Millennium Edition, Section 1.2 for details.)

Since:

1.5

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractCalendar()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractCalendar()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`CalendarDate`	`getCalendarDate()`
`CalendarDate`	`getCalendarDate(long millis)` Calculates calendar fields from the specified number of milliseconds since the Epoch, January 1, 1970 00:00:00 UTC (Gregorian).
`CalendarDate`	`getCalendarDate(long millis, CalendarDate date)`
`CalendarDate`	`getCalendarDate(long millis, java.util.TimeZone zone)`
`protected abstract void`	`getCalendarDateFromFixedDate(CalendarDate date, long fixedDate)` Calculates calendar fields from the specified fixed date.
`static long`	`getDayOfWeekDateOnOrBefore(long fixedDate, int dayOfWeek)` Returns a date of the given day of week on or before the given fixed date.
`Era`	`getEra(java.lang.String eraName)` Returns the `Era` designated by the era name that has to be known to this calendar system.
`Era[]`	`getEras()` Returns valid `Era`s of this calendar system.
`protected abstract long`	`getFixedDate(CalendarDate date)` Returns the fixed date calculated with the specified calendar date.
`CalendarDate`	`getNthDayOfWeek(int nth, int dayOfWeek, CalendarDate date)` Returns a `CalendarDate` of the n-th day of week which is on, after or before the specified date.
`long`	`getTime(CalendarDate date)` Returns the number of milliseconds since the Epoch, January 1, 1970 00:00:00 UTC (Gregorian), represented by the specified `CalendarDate`.
`protected long`	`getTimeOfDay(CalendarDate date)`
`long`	`getTimeOfDayValue(CalendarDate date)`
`int`	`getWeekLength()` Returns 7 in this default implementation.
`protected abstract boolean`	`isLeapYear(CalendarDate date)`
`void`	`setEra(CalendarDate date, java.lang.String eraName)`
`protected void`	`setEras(Era[] eras)`
`CalendarDate`	`setTimeOfDay(CalendarDate cdate, int fraction)`
`boolean`	`validateTime(CalendarDate date)`

Methods inherited from class com.tencent.kona.sun.util.calendar.CalendarSystem
forName, getGregorianCalendar, getMonthLength, getName, getYearLength, getYearLengthInMonths, newCalendarDate, newCalendarDate, normalize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractCalendar
```
protected AbstractCalendar()
```
- Method Detail
  - getEra
```
public Era getEra(java.lang.String eraName)
```
    Description copied from class: CalendarSystem
    
    Returns the Era designated by the era name that has to be known to this calendar system. If no Era is applicable to this calendar system, null is returned.
    
    Specified by:
    
    getEra in class CalendarSystem
    
    Parameters:
    
    eraName - the name of the era
    
    Returns:
    
    the Era designated by eraName, or null if no Era is applicable to this calendar system or the specified era name is not known to this calendar system.
  - getEras
```
public Era[] getEras()
```
    Description copied from class: CalendarSystem
    
    Returns valid Eras of this calendar system. The return value is sorted in the descendant order. (i.e., the first element of the returned array is the oldest era.) If no era is applicable to this calendar system, null is returned.
    
    Specified by:
    
    getEras in class CalendarSystem
    
    Returns:
    
    an array of valid Eras, or null if no era is applicable to this calendar system.
  - setEra
```
public void setEra(CalendarDate date,
                   java.lang.String eraName)
```
    Specified by:
    
    setEra in class CalendarSystem
    
    See Also:
    
    Era
  - setEras
```
protected void setEras(Era[] eras)
```
  - getCalendarDate
```
public CalendarDate getCalendarDate()
```
    Specified by:
    
    getCalendarDate in class CalendarSystem
  - getCalendarDate
```
public CalendarDate getCalendarDate(long millis)
```
    Description copied from class: CalendarSystem
    
    Calculates calendar fields from the specified number of milliseconds since the Epoch, January 1, 1970 00:00:00 UTC (Gregorian). This method doesn't check overflow or underflow when adjusting the millisecond value (representing UTC) with the time zone offsets (i.e., the GMT offset and amount of daylight saving).
    
    Specified by:
    
    getCalendarDate in class CalendarSystem
    
    Parameters:
    
    millis - the offset value in milliseconds from January 1, 1970 00:00:00 UTC (Gregorian).
    
    Returns:
    
    a CalendarDate instance that contains the calculated calendar field values.
  - getCalendarDate
```
public CalendarDate getCalendarDate(long millis,
                                    java.util.TimeZone zone)
```
    Specified by:
    
    getCalendarDate in class CalendarSystem
  - getCalendarDate
```
public CalendarDate getCalendarDate(long millis,
                                    CalendarDate date)
```
    Specified by:
    
    getCalendarDate in class CalendarSystem
  - getTime
```
public long getTime(CalendarDate date)
```
    Description copied from class: CalendarSystem
    
    Returns the number of milliseconds since the Epoch, January 1, 1970 00:00:00 UTC (Gregorian), represented by the specified CalendarDate.
    
    Specified by:
    
    getTime in class CalendarSystem
    
    Parameters:
    
    date - the CalendarDate from which the time value is calculated
    
    Returns:
    
    the number of milliseconds since the Epoch.
  - getTimeOfDay
```
protected long getTimeOfDay(CalendarDate date)
```
  - getTimeOfDayValue
```
public long getTimeOfDayValue(CalendarDate date)
```
  - setTimeOfDay
```
public CalendarDate setTimeOfDay(CalendarDate cdate,
                                 int fraction)
```
    Specified by:
    
    setTimeOfDay in class CalendarSystem
  - getWeekLength
```
public int getWeekLength()
```
    Returns 7 in this default implementation.
    
    Specified by:
    
    getWeekLength in class CalendarSystem
    
    Returns:
    
    7
  - isLeapYear
```
protected abstract boolean isLeapYear(CalendarDate date)
```
  - getNthDayOfWeek
```
public CalendarDate getNthDayOfWeek(int nth,
                                    int dayOfWeek,
                                    CalendarDate date)
```
    Description copied from class: CalendarSystem
    Returns a CalendarDate of the n-th day of week which is on, after or before the specified date. For example, the first Sunday in April 2002 (Gregorian) can be obtained as below:
```
 Gregorian cal = CalendarSystem.getGregorianCalendar();
 CalendarDate date = cal.newCalendarDate();
 date.setDate(2004, cal.APRIL, 1);
 CalendarDate firstSun = cal.getNthDayOfWeek(1, cal.SUNDAY, date);
 // firstSun represents April 4, 2004.
 
```
    This method returns a new CalendarDate instance and doesn't modify the original date.
    Specified by:
    
    getNthDayOfWeek in class CalendarSystem
    
    Parameters:
    
    nth - specifies the n-th one. A positive number specifies on or after the date. A non-positive number specifies on or before the date.
    
    dayOfWeek - the day of week
    
    date - the date
    
    Returns:
    
    the date of the nth dayOfWeek after or before the specified CalendarDate
  - getDayOfWeekDateOnOrBefore
```
public static long getDayOfWeekDateOnOrBefore(long fixedDate,
                                              int dayOfWeek)
```
    Returns a date of the given day of week on or before the given fixed date.
    
    Parameters:
    
    fixedDate - the fixed date
    
    dayOfWeek - the day of week
    
    Returns:
    
    the calculated date
  - getFixedDate
```
protected abstract long getFixedDate(CalendarDate date)
```
    Returns the fixed date calculated with the specified calendar date. If the specified date is not normalized, its date fields are normalized.
    
    Parameters:
    
    date - a CalendarDate with which the fixed date is calculated
    
    Returns:
    
    the calculated fixed date
    
    See Also:
    
    AbstractCalendar.html#fixed_date
  - getCalendarDateFromFixedDate
```
protected abstract void getCalendarDateFromFixedDate(CalendarDate date,
                                                     long fixedDate)
```
    Calculates calendar fields from the specified fixed date. This method stores the calculated calendar field values in the specified CalendarDate.
    
    Parameters:
    
    date - a CalendarDate to stored the calculated calendar fields.
    
    fixedDate - a fixed date to calculate calendar fields
    
    See Also:
    
    AbstractCalendar.html#fixed_date
  - validateTime
```
public boolean validateTime(CalendarDate date)
```

Class AbstractCalendar

Constructor Summary

Method Summary

Methods inherited from class com.tencent.kona.sun.util.calendar.CalendarSystem

Methods inherited from class java.lang.Object

Constructor Detail

AbstractCalendar

Method Detail

getEra

getEras

setEra

setEras

getCalendarDate

getCalendarDate

getCalendarDate

getCalendarDate

getTime

getTimeOfDay

getTimeOfDayValue

setTimeOfDay

getWeekLength

isLeapYear

getNthDayOfWeek

getDayOfWeekDateOnOrBefore

getFixedDate

getCalendarDateFromFixedDate

validateTime