Package net.time4j.calendar

Enum Class PersianMonth

java.lang.Object
java.lang.Enum<PersianMonth>
net.time4j.calendar.PersianMonth
All Implemented Interfaces:
Serializable, Comparable<PersianMonth>, java.lang.constant.Constable, Predicate<PersianCalendar>, ChronoCondition<PersianCalendar>
public enum PersianMonth extends Enum<PersianMonth> implements ChronoCondition<PersianCalendar>

The Persian calendar defines 12 persian months.

Since:
3.9/4.6
Author:
Meno Hochschild

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ABAN
    The 8th month of Persian Calendar with 30 days.
    AZAR
    The 9th month of Persian Calendar with 30 days.
    BAHMAN
    The 11th month of Persian Calendar with 30 days.
    DEY
    The 10th month of Persian Calendar with 30 days.
    ESFAND
    The 12th month of Persian Calendar with 29 or 30 days (if in leap year).
    FARVARDIN
    The 1st month of Persian Calendar with 31 days.
    KHORDAD
    The 3rd month of Persian Calendar with 31 days.
    MEHR
    The 7th month of Persian Calendar with 30 days.
    MORDAD
    The 5th month of Persian Calendar with 31 days.
    ORDIBEHESHT
    The 2nd month of Persian Calendar with 31 days.
    SHAHRIVAR
    The 6th month of Persian Calendar with 31 days.
    TIR
    The 4th month of Persian Calendar with 31 days.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDisplayName​(Locale locale)
    Equivalent to the expression getDisplayName(locale, TextWidth.WIDE, OutputContext.FORMAT).
    String
    getDisplayName​(Locale locale, TextWidth width, OutputContext context)
    Gets the description text dependent on the locale and style parameters.
    int
    getValue()
    Gets the corresponding numerical value.
    boolean
    test​(PersianCalendar context)
    Decides if given context matches this condition.
    static PersianMonth
    valueOf​(int month)
    Gets the enum-constant which corresponds to the given numerical value.
    static PersianMonth
    valueOf​(String name)
    Returns the enum constant of this class with the specified name.
    static PersianMonth[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.util.function.Predicate

    and, negate, or

  • Enum Constant Details

    • FARVARDIN

      public static final PersianMonth FARVARDIN
      The 1st month of Persian Calendar with 31 days.

    • ORDIBEHESHT

      public static final PersianMonth ORDIBEHESHT
      The 2nd month of Persian Calendar with 31 days.

    • KHORDAD

      public static final PersianMonth KHORDAD
      The 3rd month of Persian Calendar with 31 days.

    • TIR

      public static final PersianMonth TIR
      The 4th month of Persian Calendar with 31 days.

    • MORDAD

      public static final PersianMonth MORDAD
      The 5th month of Persian Calendar with 31 days.

    • SHAHRIVAR

      public static final PersianMonth SHAHRIVAR
      The 6th month of Persian Calendar with 31 days.

    • MEHR

      public static final PersianMonth MEHR
      The 7th month of Persian Calendar with 30 days.

    • ABAN

      public static final PersianMonth ABAN
      The 8th month of Persian Calendar with 30 days.

    • AZAR

      public static final PersianMonth AZAR
      The 9th month of Persian Calendar with 30 days.

    • DEY

      public static final PersianMonth DEY
      The 10th month of Persian Calendar with 30 days.

    • BAHMAN

      public static final PersianMonth BAHMAN
      The 11th month of Persian Calendar with 30 days.

    • ESFAND

      public static final PersianMonth ESFAND
      The 12th month of Persian Calendar with 29 or 30 days (if in leap year).

  • Method Details

    • values

      public static PersianMonth[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PersianMonth valueOf​(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • valueOf

      public static PersianMonth valueOf​(int month)

      Gets the enum-constant which corresponds to the given numerical value.

      Parameters:
      month - persian month in the range [1-12]
      Returns:
      persian month of year as enum
      Throws:
      IllegalArgumentException - if given argument is out of range
      Since:
      3.9/4.6

    • getValue

      public int getValue()

      Gets the corresponding numerical value.

      Returns:
      number of month in the range [1-12]
      Since:
      3.9/4.6

    • getDisplayName

      public String getDisplayName​(Locale locale)

      Equivalent to the expression getDisplayName(locale, TextWidth.WIDE, OutputContext.FORMAT).

      Parameters:
      locale - language setting
      Returns:
      descriptive text (long form, never null)
      Since:
      3.9/4.6
      See Also:
      getDisplayName(Locale, TextWidth, OutputContext)

    • getDisplayName

      public String getDisplayName​(Locale locale, TextWidth width, OutputContext context)

      Gets the description text dependent on the locale and style parameters.

      The second argument controls the width of description while the third argument is only relevant for languages which make a difference between stand-alone forms and embedded text forms (does not matter in English).

      Parameters:
      locale - language setting
      width - text width
      context - output context
      Returns:
      descriptive text for given locale and style (never null)
      Since:
      3.9/4.6

    • test

      public boolean test​(PersianCalendar context)
      Description copied from interface: ChronoCondition

      Decides if given context matches this condition.

      Due to better readability it is recommended to use following equivalent approach instead of this method:: 

        import static net.time4j.Weekday.SATURDAY;
  import static net.time4j.Month.JANUARY;

  PlainDate date = PlainDate.of(2014, JANUARY, 25);
  System.out.println(SATURDAY.test(date)); // direct use
  System.out.println(date.matches(SATURDAY)); // recommended callback
      Specified by:
      test in interface ChronoCondition<PersianCalendar>
      Specified by:
      test in interface Predicate<PersianCalendar>
      Parameters:
      context - context as base of testing this condition
      Returns:
      true if given time context matches this condition else false