BadiMonth (Time4J-Base 5.8 API)

java.lang.Object
- java.lang.Enum<BadiMonth>
- - net.time4j.calendar.bahai.BadiMonth

All Implemented Interfaces:

Serializable, Comparable<BadiMonth>, BadiDivision
```
public enum BadiMonth
extends Enum<BadiMonth>
implements BadiDivision
```
Represents the months used in the Badi calendar.

Since:

5.3

Author:

Meno Hochschild

See Also:

BadiDivision.comparator()

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALA` The nineteenth month.
`ASMA` The ninth month.
`AZAMAT` The fourth month.
`BAHA` The first month starting at vernal equinox in March.
`ILM` The twelvth month.
`IZZAT` The tenth month.
`JALAL` The second month.
`JAMAL` The third month.
`KALIMAT` The seventh month.
`KAMAL` The eight month.
`MASAIL` The fifteenth month.
`MASHIYYAT` The eleventh month.
`MULK` The eighteenth month.
`NUR` The fifth month.
`QAWL` The fourteenth month.
`QUDRAT` The thirteenth month.
`RAHMAT` The sixth month.
`SHARAF` The sixteenth month.
`SULTAN` The seventeenth month.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDisplayName(Locale locale)` Gets the description text dependent on the locale.
`String`	`getMeaning(Locale locale)` Gets the meaning dependent on the locale.
`int`	`getValue()` Gets the corresponding numerical value.
`static BadiMonth`	`valueOf(int month)` Gets the enum-constant which corresponds to the given numerical value.
`static BadiMonth`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static BadiMonth[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.time4j.calendar.bahai.BadiDivision
comparator

- Enum Constant Detail
  - BAHA
```
public static final BadiMonth BAHA
```
    The first month starting at vernal equinox in March.
  - JALAL
```
public static final BadiMonth JALAL
```
    The second month.
  - JAMAL
```
public static final BadiMonth JAMAL
```
    The third month.
  - AZAMAT
```
public static final BadiMonth AZAMAT
```
    The fourth month.
  - NUR
```
public static final BadiMonth NUR
```
    The fifth month.
  - RAHMAT
```
public static final BadiMonth RAHMAT
```
    The sixth month.
  - KALIMAT
```
public static final BadiMonth KALIMAT
```
    The seventh month.
  - KAMAL
```
public static final BadiMonth KAMAL
```
    The eight month.
  - ASMA
```
public static final BadiMonth ASMA
```
    The ninth month.
  - IZZAT
```
public static final BadiMonth IZZAT
```
    The tenth month.
  - MASHIYYAT
```
public static final BadiMonth MASHIYYAT
```
    The eleventh month.
  - ILM
```
public static final BadiMonth ILM
```
    The twelvth month.
  - QUDRAT
```
public static final BadiMonth QUDRAT
```
    The thirteenth month.
  - QAWL
```
public static final BadiMonth QAWL
```
    The fourteenth month.
  - MASAIL
```
public static final BadiMonth MASAIL
```
    The fifteenth month.
  - SHARAF
```
public static final BadiMonth SHARAF
```
    The sixteenth month.
  - SULTAN
```
public static final BadiMonth SULTAN
```
    The seventeenth month.
  - MULK
```
public static final BadiMonth MULK
```
    The eighteenth month.
  - ALA
```
public static final BadiMonth ALA
```
    The nineteenth month.
- Method Detail
  - values
```
public static BadiMonth[] 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 (BadiMonth c : BadiMonth.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BadiMonth 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
  - valueOf
```
public static BadiMonth valueOf(int month)
```
    Gets the enum-constant which corresponds to the given numerical value.
    
    Parameters:
    
    month - badi month in the range [1-19]
    
    Returns:
    
    badi month of year as enum
    
    Throws:
    
    IllegalArgumentException - if given argument is out of range
  - getValue
```
public int getValue()
```
    Gets the corresponding numerical value.
    
    Returns:
    
    number of badi month in the range [1-19]
  - getDisplayName
```
public String getDisplayName(Locale locale)
```
    Gets the description text dependent on the locale.
    
    Parameters:
    
    locale - language setting
    
    Returns:
    
    descriptive text for given locale (never null)
  - getMeaning
```
public String getMeaning(Locale locale)
```
    Gets the meaning dependent on the locale.
    
    If a meaning is unavailable then this method will fall back to the transcription given by getDisplayName(Locale).
    
    Parameters:
    
    locale - language setting
    
    Returns:
    
    meaning for given locale (never null)

Enum BadiMonth

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface net.time4j.calendar.bahai.BadiDivision

Enum Constant Detail

BAHA

JALAL

JAMAL

AZAMAT

NUR

RAHMAT

KALIMAT

KAMAL

ASMA

IZZAT

MASHIYYAT

ILM

QUDRAT

QAWL

MASAIL

SHARAF

SULTAN

MULK

ALA

Method Detail

values

valueOf

valueOf

getValue

getDisplayName

getMeaning