PersianDate (Persian Date Time 1.0.0 API)

java.lang.Object
- com.github.mfathi91.PersianDate

All Implemented Interfaces:

Comparable<PersianDate>
```
@Immutable
public final class PersianDate
extends Object
implements Comparable<PersianDate>
```
This is an implementation of Solar Hijri calendar (also known as Jalali calendar, Persian calendar).
PersianDate is an immutable date-time object that represents a date, often viewed as year-month-day.
In order to simplify usage of this class, it is tried to make API of this class the same as JDK8 LocalDate class.
This class is immutable and can be used in multi-threaded programs.

Author:

Mahmoud Fathi

Field Summary

Fields
Modifier and Type Field and Description

static PersianDate MAX
The minimum supported persian date.

static PersianDate MIN
The maximum supported persian date.

Fields
Modifier and Type	Field and Description
`static PersianDate`	`MAX` The minimum supported persian date.
`static PersianDate`	`MIN` The maximum supported persian date.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(PersianDate other)` Compares this persian date to another persian date.
`boolean`	`equals(Object obj)` Checks if this date is equal to another date.
`int`	`getDayOfMonth()`
`DayOfWeek`	`getDayOfWeek()` Returns day-of-week as an enum `DayOfWeek`.
`int`	`getDayOfYear()`
`PersianMonth`	`getMonth()`
`int`	`getMonthValue()`
`int`	`getYear()`
`static PersianDate`	`gregorianToPersian(LocalDate ld)` Returns an equivalent Persian date and time as an instance of `PersianDate`.
`int`	`hashCode()` A hash code for this persian date.
`boolean`	`isAfter(PersianDate other)` Checks whether this persian date is after the specified persian date.
`boolean`	`isBefore(PersianDate other)` Checks whether this persian date is before the specified persian date.
`boolean`	`isEqual(PersianDate other)` Checks whether this persian date has the same date with the specified persian date.
`boolean`	`isLeapYear()` Returns true if `year` is a leap year in Persian calendar.
`static boolean`	`isLeapYear(int year)` Returns true if `year` is a leap year in Persian calendar.
`static PersianDate`	`now()` Obtains current Persian date from the system clock in the default time zone.
`static PersianDate`	`of(int year, int month, int dayOfMonth)` Obtains an instance of `PersianDate` with year, month, day of month, hour, minute and second.
`static PersianDate`	`of(int year, PersianMonth month, int dayOfMonth)` Obtains an instance of `PersianDate` with year, month, day of month, hour, minute and second.
`LocalDate`	`toGregorian()` Returns an equivalent Gregorian date and time as an instance of `LocalDate`.
`String`	`toString()` Returns the string representation of this persian date.

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

- Field Detail
  - MIN
```
public static final PersianDate MIN
```
    The maximum supported persian date.
  - MAX
```
public static final PersianDate MAX
```
    The minimum supported persian date.
- Method Detail
  - getYear
```
public int getYear()
```
    Returns:
    
    the year
  - getMonth
```
public PersianMonth getMonth()
```
    Returns:
    
    the month-of-year field using the Month enum.
    
    See Also:
    
    getMonthValue()
  - getMonthValue
```
public int getMonthValue()
```
    Returns:
    
    the month-of-year, from 1 to 12
    
    See Also:
    
    getMonth()
  - getDayOfMonth
```
public int getDayOfMonth()
```
    Returns:
    
    day-of-month, from 1 to 31
  - getDayOfYear
```
public int getDayOfYear()
```
    Returns:
    
    day-of-year, from 1 to 365 or 366 in a leap year
  - getDayOfWeek
```
public DayOfWeek getDayOfWeek()
```
    Returns day-of-week as an enum DayOfWeek. This avoids confusion as to what int means. If you need access to the primitive int value then the enum provides the int value.
    
    Returns:
    
    day-of-week, which is an enum DayOfWeek
  - now
```
public static PersianDate now()
```
    Obtains current Persian date from the system clock in the default time zone.
    
    Returns:
    
    current Persian date from the system clock in the default time zone
  - of
```
public static PersianDate of(int year,
                             int month,
                             int dayOfMonth)
```
    Obtains an instance of PersianDate with year, month, day of month, hour, minute and second. The value of month must be between 1 and 12. Value 1 would be PersianMonth.FARVARDIN and value 12 represents PersianMonth.ESFAND.
    
    Parameters:
    
    year - the year to represent, from 1 to MAX_YEAR
    
    month - the value of month, from 1 to 12
    
    dayOfMonth - the dayOfMonth to represent, from 1 to 31
    
    Returns:
    
    an instance of PersianDate
    
    Throws:
    
    DateTimeException - if the passed parameters do not form a valid date or time.
  - of
```
public static PersianDate of(int year,
                             PersianMonth month,
                             int dayOfMonth)
```
    Obtains an instance of PersianDate with year, month, day of month, hour, minute and second.
    
    Parameters:
    
    year - the year to represent, from 1 to MAX_YEAR
    
    month - the month-of-year to represent, an instance of PersianMonth
    
    dayOfMonth - the dayOfMonth to represent, from 1 to 31
    
    Returns:
    
    an instance of PersianDate
    
    Throws:
    
    DateTimeException - if the passed parameters do not form a valid date or time.
  - toGregorian
```
public LocalDate toGregorian()
```
    Returns an equivalent Gregorian date and time as an instance of LocalDate. Calling this method has no effect on the object that calls this.
    
    Returns:
    
    the equivalent Gregorian date as an instance of LocalDate
  - gregorianToPersian
```
public static PersianDate gregorianToPersian(LocalDate ld)
```
    Returns an equivalent Persian date and time as an instance of PersianDate. Calling this method has no effect on the class and other instances of this class.
    
    Parameters:
    
    ld - Gregorian date and time
    
    Returns:
    
    an equivalent Persian date and time as an instance of PersianDate
  - isLeapYear
```
public boolean isLeapYear()
```
    Returns true if year is a leap year in Persian calendar.
    
    Returns:
    
    true if year is a leap year in Persian calendar
  - isLeapYear
```
public static boolean isLeapYear(int year)
```
    Returns true if year is a leap year in Persian calendar.
    
    Parameters:
    
    year - the year to be checked whether is a leap year or not
    
    Returns:
    
    true if year is a leap year in Persian calendar
    
    Throws:
    
    IllegalArgumentException - if argument is a negative value
  - compareTo
```
public int compareTo(PersianDate other)
```
    Compares this persian date to another persian date.
    Newer persian date is considered greater.
    
    Specified by:
    
    compareTo in interface Comparable<PersianDate>
    
    Parameters:
    
    other - the other persian date to compare to, not null
    
    Returns:
    
    the comparator value, negative if less, positive if greater and zero if equals
  - isEqual
```
public boolean isEqual(PersianDate other)
```
    Checks whether this persian date has the same date with the specified persian date.
    
    Parameters:
    
    other - instance of persian date to compare to
    
    Returns:
    
    true, if this persian date and specified persian dates have the same date value.
  - isBefore
```
public boolean isBefore(PersianDate other)
```
    Checks whether this persian date is before the specified persian date.
```
     PersianDate a = PersianDate.of(1396, 3, 15);
     PersianDate b = PersianDate.of(1396, 6, 10);
     a.isBefore(b) - true
     a.isBefore(a) - false
     b.isBefore(a) - false
 
```
    Parameters:
    
    other - instance of PersianDate to compare to
    
    Returns:
    
    true, if persian date is before the specified persian date
  - isAfter
```
public boolean isAfter(PersianDate other)
```
    Checks whether this persian date is after the specified persian date.
```
     PersianDate a = PersianDate.of(1396, 3, 15);
     PersianDate b = PersianDate.of(1396, 6, 10);
     a.isAfter(b) - false
     a.isAfter(a) - false
     b.isAfter(a) - true
 
```
    Parameters:
    
    other - instance of PersianDate to compare to
    
    Returns:
    
    true, if persian date is after the specified persian date
  - equals
```
public boolean equals(Object obj)
```
    Checks if this date is equal to another date.
    Compares this LocalDate with another ensuring that the date is the same.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object to check, null returns false
    
    Returns:
    
    true if this is equal to the other date
  - hashCode
```
public int hashCode()
```
    A hash code for this persian date.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a suitable hash code
  - toString
```
public String toString()
```
    Returns the string representation of this persian date. The string contains of ten characters whose format is "XXXX-YY-ZZ", where XXXX is the year, YY is the month-of-year and ZZ is day-of-month. (Each of the capital characters represents a single decimal digit.)
    If any of the three parts of this persian date is too small to fill up its field, the field is padded with leading zeros.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a suitable representation of this persian date

Class PersianDate

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN

MAX

Method Detail

getYear

getMonth

getMonthValue

getDayOfMonth

getDayOfYear

getDayOfWeek

now

of

of

toGregorian

gregorianToPersian

isLeapYear

isLeapYear

compareTo

isEqual

isBefore

isAfter

equals

hashCode

toString