net.time4j.calendar.frenchrev

Enum FrenchRepublicanEra

java.lang.Object

java.lang.Enum<FrenchRepublicanEra>

net.time4j.calendar.frenchrev.FrenchRepublicanEra

All Implemented Interfaces:

Serializable, Comparable<FrenchRepublicanEra>, CalendarEra

public enum FrenchRepublicanEra
extends Enum<FrenchRepublicanEra>
implements CalendarEra

The French revolutionary calendar only supports one single era which is related to the proclamation of the French republic in year 1792.

Since:

3.33/4.28

Author:

Meno Hochschild

Enum Constant Summary

Enum Constants

Enum Constant and Description
REPUBLICAN Singleton instance (starting 22nd September 1792 as year one).

Method Summary

Modifier and Type	Method and Description
String	getDisplayName(Locale locale, TextWidth width) Gets the description text dependent on the locale.
static FrenchRepublicanEra	valueOf(String name) Returns the enum constant of this type with the specified name.
static FrenchRepublicanEra[]	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.engine.CalendarEra

name

Enum Constant Detail

REPUBLICAN

public static final FrenchRepublicanEra REPUBLICAN

Singleton instance (starting 22nd September 1792 as year one).

Method Detail

values

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

Returns:

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

valueOf

public static FrenchRepublicanEra 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

getDisplayName

public String getDisplayName(Locale locale,
                             TextWidth width)

Gets the description text dependent on the locale.

Parameters:

locale - language setting

width - text width

Returns:

descriptive text for given locale and width (never null)