com.github.eloyzone.jalalicalendar

Enum MonthPersian

java.lang.Object

java.lang.Enum<MonthPersian>

com.github.eloyzone.jalalicalendar.MonthPersian

All Implemented Interfaces:

Serializable, Comparable<MonthPersian>

public enum MonthPersian
extends Enum<MonthPersian>

Created By Eloy on 5/6/18. This enum contains all months-of-jalali-year in both persian and english, this class mainly used in JalaliDate. Notice: FARVARDIN has got the numberic value of 1 and Esfand has got 12, so year starts with FARVARDIN

Author:

Eloy (Elyas Hadizadeh Tasbiti)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABAN The singleton instance for the month of Aban with 30 days.
AZAR The singleton instance for the month of Azar with 30 days.
BAHMAN The singleton instance for the month of Bahman with 30 days.
DAY The singleton instance for the month of Day with 30 days.
ESFAND The singleton instance for the month of Esfand with 29 days, or 30 in a leap year.
FARVARDIN The singleton instance for the month of Farvardin with 31 days.
KHORDAD The singleton instance for the month of Khordad with 31 days.
MEHR The singleton instance for the month of Mehr with 30 days.
MORDAD The singleton instance for the month of Mordad with 31 days.
ORDIBEHESHT The singleton instance for the month of Ordibehesht with 31 days.
SHAHRIVAR The singleton instance for the month of Shahrivar with 31 days.
TIR The singleton instance for the month of Tir with 31 days.

Method Summary

Modifier and Type	Method and Description
static MonthPersian	getEnum(int value)
String	getStringInEnglish() Gets the month-of-year in english string format.
String	getStringInPersian() Gets the month-of-year in persian string format.
int	getValue() Gets the month-of-year int value.
static MonthPersian	of(int month) Obtains an instance of MonthPersian from an int value.
static MonthPersian	valueOf(String name) Returns the enum constant of this type with the specified name.
static MonthPersian[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FARVARDIN

public static final MonthPersian FARVARDIN

The singleton instance for the month of Farvardin with 31 days. This has the numeric value of 1.

ORDIBEHESHT

public static final MonthPersian ORDIBEHESHT

The singleton instance for the month of Ordibehesht with 31 days. This has the numeric value of 2.

KHORDAD

public static final MonthPersian KHORDAD

The singleton instance for the month of Khordad with 31 days. This has the numeric value of 3.

TIR

public static final MonthPersian TIR

The singleton instance for the month of Tir with 31 days. This has the numeric value of 4.

MORDAD

public static final MonthPersian MORDAD

The singleton instance for the month of Mordad with 31 days. This has the numeric value of 5.

SHAHRIVAR

public static final MonthPersian SHAHRIVAR

The singleton instance for the month of Shahrivar with 31 days. This has the numeric value of 6.

MEHR

public static final MonthPersian MEHR

The singleton instance for the month of Mehr with 30 days. This has the numeric value of 7.

ABAN

public static final MonthPersian ABAN

The singleton instance for the month of Aban with 30 days. This has the numeric value of 8.

AZAR

public static final MonthPersian AZAR

The singleton instance for the month of Azar with 30 days. This has the numeric value of 9.

DAY

public static final MonthPersian DAY

The singleton instance for the month of Day with 30 days. This has the numeric value of 10.

BAHMAN

public static final MonthPersian BAHMAN

The singleton instance for the month of Bahman with 30 days. This has the numeric value of 11.

ESFAND

public static final MonthPersian ESFAND

The singleton instance for the month of Esfand with 29 days, or 30 in a leap year. This has the numeric value of 12.

Method Detail

values

public static MonthPersian[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MonthPersian c : MonthPersian.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MonthPersian valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Gets the month-of-year int value.

The values are numbered following the ISO-8601 standard, from 1 (Farvardin) to 12 (Esfand).

Returns:

the month-of-year, from 1 (Farvardin) to 12 (Esfand)

getEnum

public static MonthPersian getEnum(int value)

getStringInPersian

public String getStringInPersian()

Gets the month-of-year in persian string format.

The string are persian values

Returns:

the month-of-year, from فروردین to اسفند

getStringInEnglish

public String getStringInEnglish()

Gets the month-of-year in english string format.

The string are english values

Returns:

the month-of-year, from farvardin to esfand

of

public static MonthPersian of(int month)

Obtains an instance of MonthPersian from an int value.

MonthPersian is an enum representing the 12 months of the year. This factory allows the enum to be obtained from the int value. The int value will be from 1 (Farvardin) to 12 (Ordibehesht).

Parameters:

month - the month-of-year to represent, from 1 (Farvardin) to 12 (Ordibehesht)

Returns:

the month-of-year, not null

Throws:

java.time.DateTimeException - if the month-of-year is invalid