net.time4j.calendar.frenchrev

Enum FrenchRepublicanMonth

java.lang.Object

java.lang.Enum<FrenchRepublicanMonth>

net.time4j.calendar.frenchrev.FrenchRepublicanMonth

All Implemented Interfaces:

Serializable, Comparable<FrenchRepublicanMonth>

public enum FrenchRepublicanMonth
extends Enum<FrenchRepublicanMonth>

Represents the months used in the French revolutionary calendar.

Since:

3.33/4.28

Author:

Meno Hochschild

Enum Constant Summary

Enum Constants

Enum Constant and Description
BRUMAIRE The second month starting in October.
FLOREAL The eight month starting in April (flower month).
FRIMAIRE The third month starting in November (month of frost).
FRUCTIDOR The twelvth month starting in August.
GERMINAL The seventh month starting in March.
MESSIDOR The tenth month starting in June.
NIVOSE The fourth month starting in December (snowy month).
PLUVIOSE The fifth month starting in January (rainy month).
PRAIRIAL The ninth month starting in May.
THERMIDOR The eleventh month starting in July.
VENDEMIAIRE The first month starting at autumnal equinox in September.
VENTOSE The sixth month starting in February (windy month).

Method Summary

Modifier and Type	Method and Description
String	getDayNameInFrench(int dayOfMonth) Obtains the French day name in this republican month.
String	getDisplayName(Locale locale) Gets the description text dependent on the locale.
String	getDisplayName(Locale locale, TextWidth width, OutputContext oc) Gets the description text dependent on the locale.
int	getValue() Gets the corresponding numerical value.
static FrenchRepublicanMonth	valueOf(int month) Gets the enum-constant which corresponds to the given numerical value.
static FrenchRepublicanMonth	valueOf(String name) Returns the enum constant of this type with the specified name.
static FrenchRepublicanMonth[]	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

VENDEMIAIRE

public static final FrenchRepublicanMonth VENDEMIAIRE

The first month starting at autumnal equinox in September.

BRUMAIRE

public static final FrenchRepublicanMonth BRUMAIRE

The second month starting in October.

FRIMAIRE

public static final FrenchRepublicanMonth FRIMAIRE

The third month starting in November (month of frost).

NIVOSE

public static final FrenchRepublicanMonth NIVOSE

The fourth month starting in December (snowy month).

PLUVIOSE

public static final FrenchRepublicanMonth PLUVIOSE

The fifth month starting in January (rainy month).

VENTOSE

public static final FrenchRepublicanMonth VENTOSE

The sixth month starting in February (windy month).

GERMINAL

public static final FrenchRepublicanMonth GERMINAL

The seventh month starting in March.

FLOREAL

public static final FrenchRepublicanMonth FLOREAL

The eight month starting in April (flower month).

PRAIRIAL

public static final FrenchRepublicanMonth PRAIRIAL

The ninth month starting in May.

MESSIDOR

public static final FrenchRepublicanMonth MESSIDOR

The tenth month starting in June.

THERMIDOR

public static final FrenchRepublicanMonth THERMIDOR

The eleventh month starting in July.

FRUCTIDOR

public static final FrenchRepublicanMonth FRUCTIDOR

The twelvth month starting in August.

Method Detail

values

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

Returns:

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

valueOf

public static FrenchRepublicanMonth 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 FrenchRepublicanMonth valueOf(int month)

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

Parameters:

month - french republican month in the range [1-12]

Returns:

republican 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 republican month in the range [1-12]

getDisplayName

public String getDisplayName(Locale locale)

Gets the description text dependent on the locale.

The usage of the French language is strongly recommended. Equivalent to getDisplayName(locale, TextWidth.WIDE, OutputContext.FORMAT).

Parameters:

locale - language setting

Returns:

descriptive text for given locale (never null)

See Also:

Locale.FRENCH

getDisplayName

public String getDisplayName(Locale locale,
                             TextWidth width,
                             OutputContext oc)

Gets the description text dependent on the locale.

The usage of the French language is strongly recommended.

Parameters:

locale - language setting

width - text width

oc - output context

Returns:

descriptive text for given locale (never null)

See Also:

Locale.FRENCH

getDayNameInFrench

public String getDayNameInFrench(int dayOfMonth)

Obtains the French day name in this republican month.

Parameters:

dayOfMonth - the day of month in range 1-30

Returns:

original French name of day