PersianCalendar (PersianCalendar 2.1.7 API)

java.lang.Object
- com.ibm.icu.util.Calendar
- - com.ghasemkiani.util.icu.PersianCalendar

All Implemented Interfaces:: PersianCalendarConstants, Serializable, Cloneable, Comparable<com.ibm.icu.util.Calendar>

public class PersianCalendar
extends com.ibm.icu.util.Calendar
implements PersianCalendarConstants

This is an arithmetic implementation of the Persian Calendar (also known as the Iranian or Jalali Calendar) based on the calendar framework of ICU4J (IBM's International Components for Unicode for Java), version 3.2.

ICU4J is copyright International Business Machines Corporation (IBM). Please see the file icu4j_3_2_license.html included with this software package for information about ICU4J license.

An astronomical version of the Persian Calendar may be implemented in a future release.

Usage Example

The following code snippet shows how to use the PersianCalendar class:

        import java.util.Date;
        import com.ibm.icu.util.TimeZone;
        import com.ibm.icu.util.ULocale;
        import com.ibm.icu.text.DateFormat;
        import com.ghasemkiani.util.icu.PersianCalendar;
        // ...

        PersianCalendar pc = new PersianCalendar(TimeZone.getTimeZone("Asia/Tehran"));
        DateFormat df = pc.getDateTimeFormat(DateFormat.FULL, DateFormat.DEFAULT, new ULocale("fa", "IR", ""));
        String result = df.format(new Date());
        // ...

Some possible results are shown below:

possible results
Locale	Formatted String
فارسی	جمعه، ۷ اسفند ۱۳۸۳ ۱۲:۰۰:۳۹
فارسی (افغانستان)	جمعه، ۷ حوت ۱۳۸۳ ۱۲:۰۰:۳۹
العربية	الجمعة, ٧ إسفند, ١٣٨٣ ١٢:٠٠:٣٩ م
English	Friday, Esfand 7, 1383 12:00:39 PM
Français	vendredi 7 Esfand 1383 12:00:39
Deutsch	Freitag, 7. Esfand 1383 12:00:39
Русский	7 Эсфанд 1383 г. 12:00:39
Türkçe	07 Isfend 1383 Cuma 12:00:39
Esperanto	vendredo, 7-a de esfando 1383 12:00:39

Version:: 2.1
Author:: Ghasem Kiani
See Also:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.ibm.icu.util.Calendar
  com.ibm.icu.util.Calendar.FormatConfiguration

Field Summary

Fields
Modifier and Type Field and Description

static int AH
After Hijra Era.

static int BH
Before Hijra Era.
- Fields inherited from class com.ibm.icu.util.Calendar
  AM, AM_PM, APRIL, AUGUST, BASE_FIELD_COUNT, DATE, DAY_OF_MONTH, DAY_OF_WEEK, DAY_OF_WEEK_IN_MONTH, DAY_OF_YEAR, DECEMBER, DOW_LOCAL, DST_OFFSET, EPOCH_JULIAN_DAY, ERA, EXTENDED_YEAR, FEBRUARY, FRIDAY, GREATEST_MINIMUM, HOUR, HOUR_OF_DAY, INTERNALLY_SET, IS_LEAP_MONTH, JAN_1_1_JULIAN_DAY, JANUARY, JULIAN_DAY, JULY, JUNE, LEAST_MAXIMUM, MARCH, MAX_DATE, MAX_FIELD_COUNT, MAX_JULIAN, MAX_MILLIS, MAXIMUM, MAY, MILLISECOND, MILLISECONDS_IN_DAY, MIN_DATE, MIN_JULIAN, MIN_MILLIS, MINIMUM, MINIMUM_USER_STAMP, MINUTE, MONDAY, MONTH, NOVEMBER, OCTOBER, ONE_DAY, ONE_HOUR, ONE_MINUTE, ONE_SECOND, ONE_WEEK, PM, RESOLVE_REMAP, SATURDAY, SECOND, SEPTEMBER, SUNDAY, THURSDAY, TUESDAY, UNDECIMBER, UNSET, WALLTIME_FIRST, WALLTIME_LAST, WALLTIME_NEXT_VALID, WEDNESDAY, WEEK_OF_MONTH, WEEK_OF_YEAR, WEEKDAY, WEEKEND, WEEKEND_CEASE, WEEKEND_ONSET, YEAR, YEAR_WOY, ZONE_OFFSET
- Fields inherited from interface com.ghasemkiani.util.PersianCalendarConstants
  ABAN, AZAR, BAHMAN, DEY, ESFAND, FARVARDIN, KHORDAD, MEHR, MORDAD, ORDIBEHESHT, SHAHRIVAR, TIR

Fields
Modifier and Type	Field and Description
`static int`	`AH` After Hijra Era.
`static int`	`BH` Before Hijra Era.

Constructor Summary

Constructors
Constructor and Description
`PersianCalendar()` Constructs a Persian calendar with the default time zone and locale.
`PersianCalendar(Date date)` Constructs a Persian calendar with the default time zone and locale and sets its time to the specified date-time.
`PersianCalendar(int year, int month, int date)` Constructs a Persian calendar with the default time zone and locale and sets its time to the specified date.
`PersianCalendar(int year, int month, int date, int hour, int minute, int second)` Constructs a Persian calendar with the default time zone and locale and sets its time to the specified time.
`PersianCalendar(Locale aLocale)` Constructs a Persian calendar with the default time zone and the specified locale.
`PersianCalendar(com.ibm.icu.util.TimeZone zone)` Constructs a Persian calendar with the specified time zone and the default locale.
`PersianCalendar(com.ibm.icu.util.TimeZone zone, Locale aLocale)` Constructs a Persian calendar with the specified time zone and locale.
`PersianCalendar(com.ibm.icu.util.TimeZone zone, com.ibm.icu.util.ULocale locale)` Constructs a Persian calendar with the specified time zone and locale.
`PersianCalendar(com.ibm.icu.util.ULocale locale)` Constructs a Persian calendar with the default time zone and the specified locale.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(int field, int amount)` Adds the specified amount to the specified field of this calendar.
`String`	`getType()` Type of this calendar.
`protected void`	`handleComputeFields(int julianDay)`
`protected int`	`handleComputeMonthStart(int extendedYear, int month, boolean useMonth)`
`protected com.ibm.icu.text.DateFormat`	`handleGetDateFormat(String pattern, com.ibm.icu.util.ULocale locale)`
`protected int`	`handleGetExtendedYear()`
`protected int`	`handleGetLimit(int field, int limitType)`
`protected int`	`handleGetMonthLength(int extendedYear, int month)`
`protected int`	`handleGetYearLength(int extendedYear)`

Methods inherited from class com.ibm.icu.util.Calendar
after, before, clear, clear, clone, compareTo, complete, computeFields, computeGregorianFields, computeGregorianMonthStart, computeJulianDay, computeMillisInDay, computeTime, computeZoneOffset, equals, fieldDifference, fieldName, floorDivide, floorDivide, floorDivide, floorDivide, get, getActualMaximum, getActualMinimum, getAvailableLocales, getAvailableULocales, getDateTimeFormat, getDateTimeFormat, getDateTimePattern, getDayOfWeekType, getDefaultDayInMonth, getDefaultMonthInYear, getDisplayName, getDisplayName, getFieldCount, getFieldResolutionTable, getFirstDayOfWeek, getGreatestMinimum, getGregorianDayOfMonth, getGregorianDayOfYear, getGregorianMonth, getGregorianYear, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getKeywordValuesForLocale, getLeastMaximum, getLimit, getLocale, getMaximum, getMinimalDaysInFirstWeek, getMinimum, getRepeatedWallTimeOption, getSkippedWallTimeOption, getStamp, getTime, getTimeInMillis, getTimeZone, getWeekendTransition, gregorianMonthLength, gregorianPreviousMonthLength, handleComputeJulianDay, handleCreateFields, handleGetDateFormat, handleGetDateFormat, handleGetDateFormat, hashCode, internalGet, internalGet, internalGetTimeInMillis, internalSet, isEquivalentTo, isGregorianLeapYear, isLenient, isSet, isWeekend, isWeekend, julianDayToDayOfWeek, julianDayToMillis, millisToJulianDay, newerField, newestStamp, pinField, prepareGetActual, resolveFields, roll, roll, set, set, set, set, setFirstDayOfWeek, setLenient, setMinimalDaysInFirstWeek, setRepeatedWallTimeOption, setSkippedWallTimeOption, setTime, setTimeInMillis, setTimeZone, toString, validateField, validateField, validateFields, weekNumber, weekNumber

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

- Field Detail
  - BH
```
public static final int BH
```
    Before Hijra Era.
    
    See Also:
    Constant Field Values
  - AH
```
public static final int AH
```
    After Hijra Era.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - PersianCalendar
```
public PersianCalendar()
```
    Constructs a Persian calendar with the default time zone and locale.
  - PersianCalendar
```
public PersianCalendar(com.ibm.icu.util.TimeZone zone)
```
    Constructs a Persian calendar with the specified time zone and the default locale.
    
    Parameters:
    zone - the desired timezone.
  - PersianCalendar
```
public PersianCalendar(Locale aLocale)
```
    Constructs a Persian calendar with the default time zone and the specified locale.
    
    Parameters:
    aLocale - the desired locale.
  - PersianCalendar
```
public PersianCalendar(com.ibm.icu.util.ULocale locale)
```
    Constructs a Persian calendar with the default time zone and the specified locale.
    
    Parameters:
    locale - the desired locale.
  - PersianCalendar
```
public PersianCalendar(com.ibm.icu.util.TimeZone zone,
               Locale aLocale)
```
    Constructs a Persian calendar with the specified time zone and locale.
    
    Parameters:
    zone - the desired timezone.
    aLocale - the desired locale.
  - PersianCalendar
```
public PersianCalendar(com.ibm.icu.util.TimeZone zone,
               com.ibm.icu.util.ULocale locale)
```
    Constructs a Persian calendar with the specified time zone and locale.
    
    Parameters:
    zone - the desired timezone.
    locale - the desired locale.
  - PersianCalendar
```
public PersianCalendar(Date date)
```
    Constructs a Persian calendar with the default time zone and locale and sets its time to the specified date-time.
    
    Parameters:
    date - the date of this calendar object.
  - PersianCalendar
```
public PersianCalendar(int year,
               int month,
               int date)
```
    Constructs a Persian calendar with the default time zone and locale and sets its time to the specified date.
    
    Parameters:
    year - the Persian year.
    month - the Persian month (zero-based).
    date - the Persian day of month.
  - PersianCalendar
```
public PersianCalendar(int year,
               int month,
               int date,
               int hour,
               int minute,
               int second)
```
    Constructs a Persian calendar with the default time zone and locale and sets its time to the specified time.
    
    Parameters:
    year - the Persian year.
    month - the Persian month (zero-based).
    date - the Persian day of month.
    hour - the hours part of time.
    minute - the minutes part of time.
    second - the seconds part of time.
- Method Detail
  - handleGetLimit
```
protected int handleGetLimit(int field,
                 int limitType)
```
    Specified by:
    
    handleGetLimit in class com.ibm.icu.util.Calendar
  - handleGetMonthLength
```
protected int handleGetMonthLength(int extendedYear,
                       int month)
```
    Overrides:
    
    handleGetMonthLength in class com.ibm.icu.util.Calendar
  - handleGetYearLength
```
protected int handleGetYearLength(int extendedYear)
```
    Overrides:
    
    handleGetYearLength in class com.ibm.icu.util.Calendar
  - handleComputeMonthStart
```
protected int handleComputeMonthStart(int extendedYear,
                          int month,
                          boolean useMonth)
```
    Specified by:
    
    handleComputeMonthStart in class com.ibm.icu.util.Calendar
  - handleGetExtendedYear
```
protected int handleGetExtendedYear()
```
    Specified by:
    
    handleGetExtendedYear in class com.ibm.icu.util.Calendar
  - handleComputeFields
```
protected void handleComputeFields(int julianDay)
```
    Overrides:
    
    handleComputeFields in class com.ibm.icu.util.Calendar
  - handleGetDateFormat
```
protected com.ibm.icu.text.DateFormat handleGetDateFormat(String pattern,
                                              com.ibm.icu.util.ULocale locale)
```
    Overrides:
    
    handleGetDateFormat in class com.ibm.icu.util.Calendar
  - add
```
public void add(int field,
       int amount)
```
    Adds the specified amount to the specified field of this calendar. This is overriden to correct the behavior at the end of the leap years.
    
    Overrides:
    
    add in class com.ibm.icu.util.Calendar
    
    Parameters:
    field - the field index.
    amount - the amount to add.
  - getType
```
public String getType()
```
    Type of this calendar.
    
    Type is used for loading resources. Since there is no calendar data for this type ("persian"), the CalendarData will use the fallback type ("gregorian"). This is fine, just the month names and era names must be changed. This is taken care of by PersianDateFormatSymbols, which uses a java resource bundle in its turn.
    
    Overrides:
    
    getType in class com.ibm.icu.util.Calendar
    
    Returns:
    type of this calendar ("persian").

Class PersianCalendar

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.icu.util.Calendar

Field Summary

Fields inherited from class com.ibm.icu.util.Calendar

Fields inherited from interface com.ghasemkiani.util.PersianCalendarConstants

Constructor Summary

Method Summary

Methods inherited from class com.ibm.icu.util.Calendar

Methods inherited from class java.lang.Object

Field Detail

BH

AH

Constructor Detail

PersianCalendar

PersianCalendar

PersianCalendar

PersianCalendar

PersianCalendar

PersianCalendar

PersianCalendar

PersianCalendar

PersianCalendar

Method Detail

handleGetLimit

handleGetMonthLength

handleGetYearLength

handleComputeMonthStart

handleGetExtendedYear

handleComputeFields

handleGetDateFormat

add

getType