net.time4j.calendar.frenchrev

Enum Sansculottides

java.lang.Object

java.lang.Enum<Sansculottides>

net.time4j.calendar.frenchrev.Sansculottides

All Implemented Interfaces:

Serializable, Comparable<Sansculottides>

public enum Sansculottides
extends Enum<Sansculottides>

Represents complementary days of the French revolutionary calendar.

Since:

3.33/4.28

Author:

Meno Hochschild

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLEMENTARY_DAY_1 The first complementary day, also called "jour de la vertu".
COMPLEMENTARY_DAY_2 The second complementary day, also called "jour du génie".
COMPLEMENTARY_DAY_3 The third complementary day, also called "jour du travail".
COMPLEMENTARY_DAY_4 The fourth complementary day, also called "jour de l'opinion".
COMPLEMENTARY_DAY_5 The fifth complementary day, also called "jour des récompenses".
LEAP_DAY The sixth complementary day (only in leap years), also called "jour de la révolution".

Method Summary

Modifier and Type	Method and Description
String	getDisplayName(Locale locale, OutputContext oc) Gets the description text dependent on the locale.
int	getValue() Gets the corresponding numerical value.
static Sansculottides	valueOf(int num) Gets the enum-constant which corresponds to the given numerical value.
static Sansculottides	valueOf(String name) Returns the enum constant of this type with the specified name.
static Sansculottides[]	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

COMPLEMENTARY_DAY_1

public static final Sansculottides COMPLEMENTARY_DAY_1

The first complementary day, also called "jour de la vertu".

COMPLEMENTARY_DAY_2

public static final Sansculottides COMPLEMENTARY_DAY_2

The second complementary day, also called "jour du génie".

COMPLEMENTARY_DAY_3

public static final Sansculottides COMPLEMENTARY_DAY_3

The third complementary day, also called "jour du travail".

COMPLEMENTARY_DAY_4

public static final Sansculottides COMPLEMENTARY_DAY_4

The fourth complementary day, also called "jour de l'opinion".

COMPLEMENTARY_DAY_5

public static final Sansculottides COMPLEMENTARY_DAY_5

The fifth complementary day, also called "jour des récompenses".

LEAP_DAY

public static final Sansculottides LEAP_DAY

The sixth complementary day (only in leap years), also called "jour de la révolution".

Method Detail

values

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

Returns:

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

valueOf

public static Sansculottides 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 Sansculottides valueOf(int num)

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

Parameters:

num - number of sansculottide day in the range [1-6]

Returns:

sansculottide day as enum

Throws:

IllegalArgumentException - if given argument is out of range

getValue

public int getValue()

Gets the corresponding numerical value.

Returns:

number of sansculottide day in the range [1-6]

getDisplayName

public String getDisplayName(Locale locale,
                             OutputContext oc)

Gets the description text dependent on the locale.

The French language is the best choice for most applications. If chosen then the output context will determine the capitalization.

Parameters:

locale - language setting

oc - output context

Returns:

descriptive text for given locale (never null)

See Also:

Locale.FRENCH