net.time4j.calendar

Enum HijriMonth

java.lang.Object

java.lang.Enum<HijriMonth>

net.time4j.calendar.HijriMonth

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HijriMonth>, ChronoCondition<HijriCalendar>

public enum HijriMonth
extends java.lang.Enum<HijriMonth>
implements ChronoCondition<HijriCalendar>

The Hijri calendar defines 12 islamic months.

Since:

3.5/4.3

Enum Constant Summary

Enum Constants

Enum Constant and Description
DHU_AL_HIJJAH
DHU_AL_QIDAH
JUMADA_I
JUMADA_II
MUHARRAM
RABI_I
RABI_II
RAJAB
RAMADAN
SAFAR
SHABAN
SHAWWAL

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName(java.util.Locale locale) Equivalent to the expression getDisplayName(locale, TextWidth.WIDE, OutputContext.FORMAT).
java.lang.String	getDisplayName(java.util.Locale locale, TextWidth width, OutputContext context) Gets the description text dependent on the locale and style parameters.
int	getValue() Liefert den korrespondierenden kalendarischen Integer-Wert.
boolean	test(HijriCalendar context) Decides if given context matches this condition.
static HijriMonth	valueOf(int month) Gets the enum-constant which corresponds to the given numerical value.
static HijriMonth	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HijriMonth[]	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

Enum Constant Detail

MUHARRAM

public static final HijriMonth MUHARRAM

SAFAR

public static final HijriMonth SAFAR

RABI_I

public static final HijriMonth RABI_I

RABI_II

public static final HijriMonth RABI_II

JUMADA_I

public static final HijriMonth JUMADA_I

JUMADA_II

public static final HijriMonth JUMADA_II

RAJAB

public static final HijriMonth RAJAB

SHABAN

public static final HijriMonth SHABAN

RAMADAN

public static final HijriMonth RAMADAN

SHAWWAL

public static final HijriMonth SHAWWAL

DHU_AL_QIDAH

public static final HijriMonth DHU_AL_QIDAH

DHU_AL_HIJJAH

public static final HijriMonth DHU_AL_HIJJAH

Method Detail

values

public static HijriMonth[] 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 (HijriMonth c : HijriMonth.values())
    System.out.println(c);

Returns:

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

valueOf

public static HijriMonth valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

valueOf

public static HijriMonth valueOf(int month)

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

Parameters:

month - islamic month in the range [1-12]

Returns:

islamic month of year as enum

Throws:

java.lang.IllegalArgumentException - if given argument is out of range

Since:

3.5/4.3

getValue

public int getValue()

Liefert den korrespondierenden kalendarischen Integer-Wert.

Returns:

number of month in the range [1-12]

Since:

3.5/4.3

getDisplayName

public java.lang.String getDisplayName(java.util.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.5/4.3

See Also:

getDisplayName(Locale, TextWidth, OutputContext)

getDisplayName

public java.lang.String getDisplayName(java.util.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.5/4.3

test

public boolean test(HijriCalendar 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<HijriCalendar>

Parameters:

context - context as base of testing this condition

Returns:

true if given time context matches this condition else false