Package org.bardframework.time

Enum Class MonthJalali

java.lang.Object
java.lang.Enum<MonthJalali>
org.bardframework.time.MonthJalali
All Implemented Interfaces:
Serializable, Comparable<MonthJalali>, Constable, TemporalAccessor, TemporalAdjuster
public enum MonthJalali extends Enum<MonthJalali> implements TemporalAccessor, TemporalAdjuster
A month-of-year, such as 'Aban'.

JalaliMonth is an enum representing the 12 months of the year in Jalali Chronology - Farvardin, Ordibehesht, Khordad, Tir, Mordad, Shahrivar, Mehr, Aban, Azar, Dey, Bahman and Esfand.

In addition to the textual enum name, each month-of-year has an int value. The int value follows normal usage and the ISO-8601 standard, from 1 (Farvardin) to 12 (Esfand). It is recommended that applications use the enum rather than the int value to ensure code clarity.

Do not use ordinal() to obtain the numeric representation of JalaliMonth. Use getValue() instead.

This enum represents a common concept that is found in many calendar systems. As such, this enum may be used by any calendar system that has the month-of-year concept defined exactly equivalent to the ISO-8601 calendar system.

Author:
Vahid Zafari

  • 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 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.
    DEY
    The singleton instance for the month of Dey 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
    Description
    Temporal
    adjustInto(Temporal temporal)
    Adjusts the specified temporal object to have this month-of-year.
    int
    firstDayOfYear(boolean leapYear)
    Gets the day-of-year corresponding to the first day of this month.
    MonthJalali
    firstMonthOfQuarter()
    Gets the month corresponding to the first month of this quarter.
    static MonthJalali
    from(TemporalAccessor temporal)
    Obtains an instance of JalaliMonth from a temporal object.
    int
    get(TemporalField field)
    Gets the value of the specified field from this month-of-year as an int.
    String
    getDisplayName(TextStyle style, Locale locale)
    Gets the textual representation, such as 'Jan' or 'Esfand'.
    long
    getLong(TemporalField field)
    Gets the value of the specified field from this month-of-year as a long.
    int
    getValue()
    Gets the month-of-year int value.
    boolean
    isSupported(TemporalField field)
    Checks if the specified field is supported.
    int
    length(boolean leapYear)
    Gets the length of this month in days.
    int
    maxLength()
    Gets the maximum length of this month in days.
    int
    minLength()
    Gets the minimum length of this month in days.
    MonthJalali
    minus(long months)
    Returns the month-of-year that is the specified number of months before this one.
    static MonthJalali
    of(int month)
    Obtains an instance of JalaliMonth from an int value.
    MonthJalali
    plus(long months)
    Returns the month-of-year that is the specified number of quarters after this one.
    <R> R
    query(TemporalQuery<R> query)
    Queries this month-of-year using the specified query.
    ValueRange
    range(TemporalField field)
    Gets the range of valid values for the specified field.
    static MonthJalali
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static MonthJalali[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • FARVARDIN

      public static final MonthJalali FARVARDIN
      The singleton instance for the month of Farvardin with 31 days. This has the numeric value of 1.

    • ORDIBEHESHT

      public static final MonthJalali ORDIBEHESHT
      The singleton instance for the month of Ordibehesht with 31 days. This has the numeric value of 2.

    • KHORDAD

      public static final MonthJalali KHORDAD
      The singleton instance for the month of Khordad with 31 days. This has the numeric value of 3.

    • TIR

      public static final MonthJalali TIR
      The singleton instance for the month of Tir with 31 days. This has the numeric value of 4.

    • MORDAD

      public static final MonthJalali MORDAD
      The singleton instance for the month of Mordad with 31 days. This has the numeric value of 5.

    • SHAHRIVAR

      public static final MonthJalali SHAHRIVAR
      The singleton instance for the month of Shahrivar with 31 days. This has the numeric value of 6.

    • MEHR

      public static final MonthJalali MEHR
      The singleton instance for the month of Mehr with 30 days. This has the numeric value of 7.

    • ABAN

      public static final MonthJalali ABAN
      The singleton instance for the month of Aban with 30 days. This has the numeric value of 8.

    • AZAR

      public static final MonthJalali AZAR
      The singleton instance for the month of Azar with 30 days. This has the numeric value of 9.

    • DEY

      public static final MonthJalali DEY
      The singleton instance for the month of Dey with 30 days. This has the numeric value of 10.

    • BAHMAN

      public static final MonthJalali BAHMAN
      The singleton instance for the month of Bahman with 30 days. This has the numeric value of 11.

    • ESFAND

      public static final MonthJalali 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 Details

    • values

      public static MonthJalali[] 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 MonthJalali 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

    • of

      public static MonthJalali of(int month)
      Obtains an instance of JalaliMonth from an int value.

      JalaliMonth 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 follows the ISO-8601 standard, from 1 (Farvardin) to 12 (Esfand).

      Parameters:
      month - the month-of-year to represent, from 1 (Farvardin) to 12 (Esfand)
      Returns:
      the month-of-year, not null
      Throws:
      DateTimeException - if the month-of-year is invalid

    • from

      public static MonthJalali from(TemporalAccessor temporal)
      Obtains an instance of JalaliMonth from a temporal object.

      This obtains a month based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of JalaliMonth.

      The conversion extracts the MONTH_OF_YEAR field. The extraction is only permitted if the temporal object has an ISO chronology, or can be converted to a LocalDateJalali.

      This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, JalaliMonth::from.

      Parameters:
      temporal - the temporal object to toModel, not null
      Returns:
      the month-of-year, not null
      Throws:
      DateTimeException - if unable to toModel to a JalaliMonth

    • 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)

    • getDisplayName

      public String getDisplayName(TextStyle style, Locale locale)
      Gets the textual representation, such as 'Jan' or 'Esfand'.

      This returns the textual name used to identify the month-of-year, suitable for web to the user. The parameters control the style of the returned text and the locale.

      If no textual mapping is found then the numeric value is returned.

      Parameters:
      style - the length of the text required, not null
      locale - the locale to use, not null
      Returns:
      the text value of the month-of-year, not null

    • isSupported

      public boolean isSupported(TemporalField field)
      Checks if the specified field is supported.

      This checks if this month-of-year can be queried for the specified field. If false, then calling the range and get methods will throw an exception.

      If the field is MONTH_OF_YEAR then this method returns true. All other ChronoField instances will return false.

      If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.

      Specified by:
      isSupported in interface TemporalAccessor
      Parameters:
      field - the field to check, null returns false
      Returns:
      true if the field is supported on this month-of-year, false if not

    • range

      public ValueRange range(TemporalField field)
      Gets the range of valid values for the specified field.

      The range object expresses the minimum and maximum valid values for a field. This month is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.

      If the field is MONTH_OF_YEAR then the range of the month-of-year, from 1 to 12, will be returned. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

      If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

      Specified by:
      range in interface TemporalAccessor
      Parameters:
      field - the field to query the range for, not null
      Returns:
      the range of valid values for the field, not null
      Throws:
      DateTimeException - if the range for the field cannot be obtained
      UnsupportedTemporalTypeException - if the field is not supported

    • get

      public int get(TemporalField field)
      Gets the value of the specified field from this month-of-year as an int.

      This queries this month for the value of the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

      If the field is MONTH_OF_YEAR then the value of the month-of-year, from 1 to 12, will be returned. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

      If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

      Specified by:
      get in interface TemporalAccessor
      Parameters:
      field - the field to get, not null
      Returns:
      the value for the field, within the valid range of values
      Throws:
      DateTimeException - if a value for the field cannot be obtained or the value is outside the range of valid values for the field
      UnsupportedTemporalTypeException - if the field is not supported or the range of values exceeds an int
      ArithmeticException - if numeric overflow occurs

    • getLong

      public long getLong(TemporalField field)
      Gets the value of the specified field from this month-of-year as a long.

      This queries this month for the value of the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

      If the field is MONTH_OF_YEAR then the value of the month-of-year, from 1 to 12, will be returned. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

      If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

      Specified by:
      getLong in interface TemporalAccessor
      Parameters:
      field - the field to get, not null
      Returns:
      the value for the field
      Throws:
      DateTimeException - if a value for the field cannot be obtained
      UnsupportedTemporalTypeException - if the field is not supported
      ArithmeticException - if numeric overflow occurs

    • plus

      public MonthJalali plus(long months)
      Returns the month-of-year that is the specified number of quarters after this one.

      The calculation rolls around the end of the year from Farvardin to Esfand. The specified period may be negative.

      This instance is immutable and unaffected by this method call.

      Parameters:
      months - the months to add, positive or negative
      Returns:
      the resulting month, not null

    • minus

      public MonthJalali minus(long months)
      Returns the month-of-year that is the specified number of months before this one.

      The calculation rolls around the start of the year from Farvardin to Esfand. The specified period may be negative.

      This instance is immutable and unaffected by this method call.

      Parameters:
      months - the months to subtract, positive or negative
      Returns:
      the resulting month, not null

    • length

      public int length(boolean leapYear)
      Gets the length of this month in days.

      This takes a flag to determine whether to return the length for a leap year or not.

      Esfand has 29 days in a standard year and 30 days in a leap year. Farvardin, Ordibehesht, Khordad, Tir, Mordad and Shahrivar have 31 days. All other months have 30 days.

      Parameters:
      leapYear - true if the length is required for a leap year
      Returns:
      the length of this month in days, from 29 to 31

    • minLength

      public int minLength()
      Gets the minimum length of this month in days.

      Esfand has a minimum length of 29 days. Farvardin, Ordibehesht, Khordad, Tir, Mordad and Shahrivar have 31 days. All other months have 30 days.

      Returns:
      the minimum length of this month in days, from 29 to 31

    • maxLength

      public int maxLength()
      Gets the maximum length of this month in days.

      Esfand has a maximum length of 30 days. Farvardin, Ordibehesht, Khordad, Tir, Mordad and Shahrivar have 31 days. All other months have 30 days.

      Returns:
      the maximum length of this month in days, from 29 to 31

    • firstDayOfYear

      public int firstDayOfYear(boolean leapYear)
      Gets the day-of-year corresponding to the first day of this month.

      This returns the day-of-year that this month begins on, using the leap year flag to determine the length of Esfand.

      Parameters:
      leapYear - true if the length is required for a leap year
      Returns:
      the day of year corresponding to the first day of this month, from 1 to 336

    • firstMonthOfQuarter

      public MonthJalali firstMonthOfQuarter()
      Gets the month corresponding to the first month of this quarter.

      The year can be divided into four quarters. This method returns the first month of the quarter for the base month. Farvardin, Ordibehesht and Khordad return Farvardin. Tir, Mordad and Shahrivar return Tir. Mehr, Aban and Azar return Mehr. Dey, Bahman and Esfand return Dey.

      Returns:
      the first month of the quarter corresponding to this month, not null

    • query

      public <R> R query(TemporalQuery<R> query)
      Queries this month-of-year using the specified query.

      This queries this month-of-year using the specified query strategy object. The TemporalQuery object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.

      The result of this method is obtained by invoking the TemporalQuery.queryFrom(TemporalAccessor) method on the specified query passing this as the argument.

      Specified by:
      query in interface TemporalAccessor
      Type Parameters:
      R - the type of the result
      Parameters:
      query - the query to invoke, not null
      Returns:
      the query result, null may be returned (defined by the query)
      Throws:
      DateTimeException - if unable to query (defined by the query)
      ArithmeticException - if numeric overflow occurs (defined by the query)

    • adjustInto

      public Temporal adjustInto(Temporal temporal)
      Adjusts the specified temporal object to have this month-of-year.

      This returns a temporal object of the same observable type as the input with the month-of-year changed to be the same as this.

      The adjustment is equivalent to using Temporal.with(TemporalField, long) passing ChronoField.MONTH_OF_YEAR as the field. If the specified temporal object does not use the ISO calendar system then a DateTimeException is thrown.

      In most cases, it is clearer to reverse the calling pattern by using Temporal.with(TemporalAdjuster): 

         these two lines are equivalent, but the second approach is recommended
   temporal = thisMonth.adjustInto(temporal);
   temporal = temporal.with(thisMonth);

      For example, given a date in Mordad, the following are output: 

         dateInMordad.with(FARVARDIN);     // four months earlier
   dateInMordad.with(TIR);           // one months earlier
   dateInMordad.with(MORDAD);        // same date
   dateInMordad.with(SHAHRIVAR);     // one month later
   dateInMordad.with(ESFAND);        // seven months later

      This instance is immutable and unaffected by this method call.

      Specified by:
      adjustInto in interface TemporalAdjuster
      Parameters:
      temporal - the target object to be adjusted, not null
      Returns:
      the adjusted object, not null
      Throws:
      DateTimeException - if unable to make the adjustment
      ArithmeticException - if numeric overflow occurs