com.github.eloyzone.jalalicalendar

Class DateConverter

java.lang.Object

com.github.eloyzone.jalalicalendar.DateConverter

public class DateConverter
extends Object

Created by Eloy on 4/17/2017.

This class is a main class of jeloy calendar as it converts jalali to gregorian and gregorian to jalali. In order to handel gregorian's date it uses java8's LocalDate, for converted jalali date it uses JalaliDate class which is a class that holds attributes of specific jalali date.

Author:

Eloy (Elyas Hadizadeh Tasbiti)

See Also:

LocalDate, JalaliDate

Constructor Summary

Constructors

Constructor and Description
DateConverter()

Method Summary

Modifier and Type	Method and Description
protected DayOfWeekPersian	getDayOfWeekPersian(JalaliDate jalaliDate)
JalaliDate	gregorianToJalali(int year, int month, int day) converts gregorian date based on input arguments to jalali date.
JalaliDate	gregorianToJalali(int year, java.time.Month month, int day) converts gregorian date based on input arguments to jalali date.
java.time.LocalDate	jalaliToGregorian(int year, int month, int day) converts jalali date based on input arguments to gregorian date.
java.time.LocalDate	jalaliToGregorian(int year, MonthPersian month, int day) converts jalali date based on input arguments to gregorian date.
java.time.LocalDate	jalaliToGregorian(JalaliDate jalaliDate) converts jalali date based on input arguments to gregorian date.
protected boolean	leapPersiana(double year) checks whether provided year is leap year or not.
java.time.LocalDate	nowAsGregorian() returns current gregorian date based on Java8's LocalDate.
JalaliDate	nowAsJalali() returns current date based on jalali Date.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DateConverter

public DateConverter()

Method Detail

jalaliToGregorian

public java.time.LocalDate jalaliToGregorian(JalaliDate jalaliDate)

converts jalali date based on input arguments to gregorian date.

Parameters:

jalaliDate - will be converted to suitable form of gregorian date.

Returns:

LocalDate version of gregorian date will be returned.

jalaliToGregorian

public java.time.LocalDate jalaliToGregorian(int year,
                                             MonthPersian month,
                                             int day)

converts jalali date based on input arguments to gregorian date.

Parameters:

year - positive jalali year value

month - is jeloy's MonthPersian which is similar to java8's Month

day - positive jalali day, it can be more than 31 and automatically it tries to shift to next month

Returns:

LocalDate version of gregorian date will be returned.

Throws:

IllegalArgumentException - if values are negative.

jalaliToGregorian

public java.time.LocalDate jalaliToGregorian(int year,
                                             int month,
                                             int day)

converts jalali date based on input arguments to gregorian date.

It's smart enough to calculate target date with every input so instead of month from 1 to 12 it's possible to enter 13 in this case it automatically shift to next year, it works for days in a same way. although, for your own comfort it is recommended to use proper values

Parameters:

year - positive jalali year value

month - starts from 1 to 12, but it can be more than 12 as it tires to shift to next year

day - positive jalali day, it can be more than 31 and automatically it tries to shift to next month

Returns:

JalaliDate object

Throws:

IllegalArgumentException - if values are negative.

See Also:

JalaliDate

gregorianToJalali

public JalaliDate gregorianToJalali(int year,
                                    int month,
                                    int day)

converts gregorian date based on input arguments to jalali date. It's smart enough to calculate target date with every input so instead of month from 1 to 12 it's possible to enter 13 in this case it automatically shift to next year, it works for days in a same way. although, for your own comfort it is recommended to use proper values

Parameters:

year - gregorian positive year

month - starts from 1 to 12, but it can be more than 12 as it tires to shift to next year

day - positive gregorian day, it can be more than 31 and automatically it tries to shift to next month

Returns:

JalaliDate object

Throws:

IllegalArgumentException - if values are negative.

See Also:

JalaliDate

getDayOfWeekPersian

protected DayOfWeekPersian getDayOfWeekPersian(JalaliDate jalaliDate)

gregorianToJalali

public JalaliDate gregorianToJalali(int year,
                                    java.time.Month month,
                                    int day)

converts gregorian date based on input arguments to jalali date.

Parameters:

year - gregorian positive year

month - is Java8's Month object

day - positive gregorian day, it can be more than 31 and automatically it tries to shift to next month

Returns:

JalaliDate object

Throws:

IllegalArgumentException - if values are negative.

See Also:

JalaliDate

nowAsJalali

public JalaliDate nowAsJalali()

returns current date based on jalali Date.

This method works based on LocalDate, it first gets current date of os-system as gregorian and then casts it to Jalali.

Returns:

today's JalaliDate

See Also:

JalaliDate

nowAsGregorian

public java.time.LocalDate nowAsGregorian()

returns current gregorian date based on Java8's LocalDate.

This method created just for convenient, of-course it is possible to directly use LocalDate class.

Returns:

LocalDate object

See Also:

LocalDate

leapPersiana

protected boolean leapPersiana(double year)

checks whether provided year is leap year or not.

This method should not be used by other classes or methods outside of this package.

Parameters:

year - positive jalali year

Returns:

if provided year was leap it returns true