com.ibm.icu.util.BuddhistCalendar Maven / Gradle / Ivy
The newest version!
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
* Copyright (C) 1996-2012, International Business Machines Corporation and *
* others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.util;
import java.util.Date;
import java.util.Locale;
/**
* BuddhistCalendar is a subclass of GregorianCalendar
* that numbers years since the birth of the Buddha. This is the civil calendar
* in some predominantly Buddhist countries such as Thailand, and it is used for
* religious purposes elsewhere.
*
* The Buddhist calendar is identical to the Gregorian calendar in all respects
* except for the year and era. Years are numbered since the birth of the
* Buddha in 543 BC (Gregorian), so that 1 AD (Gregorian) is equivalent to 544
* BE (Buddhist Era) and 1998 AD is 2541 BE.
*
* The Buddhist Calendar has only one allowable era: BE. If the
* calendar is not in lenient mode (see setLenient), dates before
* 1/1/1 BE are rejected with an IllegalArgumentException.
*
* This class should not be subclassed.
*
* BuddhistCalendar usually should be instantiated using
* {@link com.ibm.icu.util.Calendar#getInstance(ULocale)} passing in a ULocale
* with the tag "@calendar=buddhist".
*
* @see com.ibm.icu.util.Calendar
* @see com.ibm.icu.util.GregorianCalendar
*
* @author Laura Werner
* @author Alan Liu
* @stable ICU 2.8
*/
public class BuddhistCalendar extends GregorianCalendar {
// jdk1.4.2 serialver
private static final long serialVersionUID = 2583005278132380631L;
//-------------------------------------------------------------------------
// Constructors...
//-------------------------------------------------------------------------
/**
* Constant for the Buddhist Era. This is the only allowable ERA
* value for the Buddhist calendar.
*
* @see com.ibm.icu.util.Calendar#ERA
* @stable ICU 2.8
*/
public static final int BE = 0;
/**
* Constructs a BuddhistCalendar using the current time
* in the default time zone with the default locale.
* @stable ICU 2.8
*/
public BuddhistCalendar() {
super();
}
/**
* Constructs a BuddhistCalendar based on the current time
* in the given time zone with the default locale.
*
* @param zone the given time zone.
* @stable ICU 2.8
*/
public BuddhistCalendar(TimeZone zone) {
super(zone);
}
/**
* Constructs a BuddhistCalendar based on the current time
* in the default time zone with the given locale.
*
* @param aLocale the given locale.
* @stable ICU 2.8
*/
public BuddhistCalendar(Locale aLocale) {
super(aLocale);
}
/**
* Constructs a BuddhistCalendar based on the current time
* in the default time zone with the given locale.
*
* @param locale the given ulocale.
* @stable ICU 3.2
*/
public BuddhistCalendar(ULocale locale) {
super(locale);
}
/**
* Constructs a BuddhistCalendar based on the current time
* in the given time zone with the given locale.
*
* @param zone the given time zone.
*
* @param aLocale the given locale.
* @stable ICU 2.8
*/
public BuddhistCalendar(TimeZone zone, Locale aLocale) {
super(zone, aLocale);
}
/**
* Constructs a BuddhistCalendar based on the current time
* in the given time zone with the given locale.
*
* @param zone the given time zone.
*
* @param locale the given ulocale.
* @stable ICU 3.2
*/
public BuddhistCalendar(TimeZone zone, ULocale locale) {
super(zone, locale);
}
/**
* Constructs a BuddhistCalendar with the given date set
* in the default time zone with the default locale.
*
* @param date The date to which the new calendar is set.
* @stable ICU 2.8
*/
public BuddhistCalendar(Date date) {
this();
setTime(date);
}
/**
* Constructs a BuddhistCalendar with the given date set
* in the default time zone with the default locale.
*
* @param year The value used to set the calendar's {@link #YEAR YEAR} time field.
*
* @param month The value used to set the calendar's {@link #MONTH MONTH} time field.
* The value is 0-based. e.g., 0 for January.
*
* @param date The value used to set the calendar's {@link #DATE DATE} time field.
* @stable ICU 2.8
*/
public BuddhistCalendar(int year, int month, int date) {
super(year, month, date);
}
/**
* Constructs a BuddhistCalendar with the given date
* and time set for the default time zone with the default locale.
*
* @param year The value used to set the calendar's {@link #YEAR YEAR} time field.
*
* @param month The value used to set the calendar's {@link #MONTH MONTH} time field.
* The value is 0-based. e.g., 0 for January.
*
* @param date The value used to set the calendar's {@link #DATE DATE} time field.
*
* @param hour The value used to set the calendar's {@link #HOUR_OF_DAY HOUR_OF_DAY} time field.
*
* @param minute The value used to set the calendar's {@link #MINUTE MINUTE} time field.
*
* @param second The value used to set the calendar's {@link #SECOND SECOND} time field.
* @stable ICU 2.8
*/
public BuddhistCalendar(int year, int month, int date, int hour,
int minute, int second)
{
super(year, month, date, hour, minute, second);
}
//-------------------------------------------------------------------------
// The only practical difference from a Gregorian calendar is that years
// are numbered since the birth of the Buddha. A couple of overrides will
// take care of that....
//-------------------------------------------------------------------------
// Starts in -543 AD, ie 544 BC
private static final int BUDDHIST_ERA_START = -543;
// Use 1970 as the default value of EXTENDED_YEAR
private static final int GREGORIAN_EPOCH = 1970;
/**
* @stable ICU 2.8
*/
protected int handleGetExtendedYear() {
// EXTENDED_YEAR in BuddhistCalendar is a Gregorian year
// The default value of EXTENDED_YEAR is 1970 (Buddhist 2513)
int year;
if (newerField(EXTENDED_YEAR, YEAR) == EXTENDED_YEAR) {
year = internalGet(EXTENDED_YEAR, GREGORIAN_EPOCH);
} else {
year = internalGet(YEAR, GREGORIAN_EPOCH - BUDDHIST_ERA_START)
+ BUDDHIST_ERA_START;
}
return year;
}
// Return JD of start of given month/year
/**
* @stable ICU 2.8
*/
protected int handleComputeMonthStart(int eyear, int month, boolean useMonth) {
return super.handleComputeMonthStart(eyear, month, useMonth);
}
/**
* @stable ICU 2.8
*/
protected void handleComputeFields(int julianDay) {
super.handleComputeFields(julianDay);
int y = internalGet(EXTENDED_YEAR) - BUDDHIST_ERA_START;
internalSet(ERA, 0);
internalSet(YEAR, y);
}
/**
* Override GregorianCalendar. There is only one Buddhist ERA. We
* should really handle YEAR, YEAR_WOY, and EXTENDED_YEAR here too to
* implement the 1..5000000 range, but it's not critical.
* @stable ICU 2.8
*/
protected int handleGetLimit(int field, int limitType) {
if (field == ERA) {
return BE;
}
return super.handleGetLimit(field, limitType);
}
/**
* {@inheritDoc}
* @stable ICU 3.8
*/
public String getType() {
return "buddhist";
}
}