com.github.eloyzone.jalalicalendar

Class JalaliDate

java.lang.Object

com.github.eloyzone.jalalicalendar.JalaliDate

public class JalaliDate
extends Object

Created By Eloy on 5/6/18.

This class holds some data about specific date in Jalali's Date format like year, month, day, day of week and leap year

Author:

Eloy (Elyas Hadizadeh Tasbiti)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JalaliDate() Only DateConverter is allowed to create an object of JalaliDate with empty constructor's argument
	JalaliDate(int year, int month, int day) creates an object of jalali date.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Checks if this date is equal to another date.
String	format(JalaliDateFormatter jalaliDateFormatter) reformats jalali date with provided format.
int	getDay()
DayOfWeekPersian	getDayOfWeek() gets current day of week
MonthPersian	getMonthPersian()
int	getYear()
boolean	isLeapYear()
protected void	setDay(int day)
protected void	setDayOfWeekPersian(DayOfWeekPersian dayOfWeekPersian)
protected void	setLeapYear(boolean leapYear)
protected void	setMonthPersian(MonthPersian monthPersian)
protected void	setYear(int year) set year of jalali date and then checks is it a leap year or not.
String	toString() Transforms date to ISO-8601 standard contains year, month and day

Methods inherited from class java.lang.Object

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

Constructor Detail

JalaliDate

protected JalaliDate()

Only DateConverter is allowed to create an object of JalaliDate with empty constructor's argument

Other classes and methods must use another version.

JalaliDate

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

creates an object of jalali date.

Parameters:

year - jalali year

month - from 1 to 12

day - from 1 to 31

Throws:

IllegalArgumentException - if values are negative.

IllegalArgumentException - if requested date is not possible.

Method Detail

format

public String format(JalaliDateFormatter jalaliDateFormatter)

reformats jalali date with provided format. the result will be a string in either persian or english.

Parameters:

jalaliDateFormatter - an object that shows preferred format for jalali date.

Returns:

string formatted date either in persian or english

toString

public String toString()

Transforms date to ISO-8601 standard contains year, month and day

Overrides:

toString in class Object

Returns:

String format of date

getYear

public int getYear()

setYear

protected void setYear(int year)

set year of jalali date and then checks is it a leap year or not.

Note: only classes of this package needs this method, you'll never need it. use constructor instead.

Parameters:

year - input year

getDayOfWeek

public DayOfWeekPersian getDayOfWeek()

gets current day of week

Returns:

DayOfWeekPersian object will be returned that user can get its persian or english string version by calling getStringInXXX() method.

getMonthPersian

public MonthPersian getMonthPersian()

setMonthPersian

protected void setMonthPersian(MonthPersian monthPersian)

getDay

public int getDay()

setDay

protected void setDay(int day)

isLeapYear

public boolean isLeapYear()

setLeapYear

protected void setLeapYear(boolean leapYear)

setDayOfWeekPersian

protected void setDayOfWeekPersian(DayOfWeekPersian dayOfWeekPersian)

equals

public boolean equals(Object obj)

Checks if this date is equal to another date.

Compares this JalaliDate with another for ensuring that the date is the same.

Only object type of JalaliDate are compared, other types return false.

Overrides:

equals in class Object

Parameters:

obj - the object to check, null returns false

Returns:

true if this is equal to the other date