net.time4j.calendar.frenchrev

Enum DayOfDecade

java.lang.Object

java.lang.Enum<DayOfDecade>

net.time4j.calendar.frenchrev.DayOfDecade

All Implemented Interfaces:

Serializable, Comparable<DayOfDecade>

public enum DayOfDecade
extends Enum<DayOfDecade>

Represents the days of decade used in the French revolutionary calendar.

Since:

3.33/4.28

Author:

Meno Hochschild

Enum Constant Summary

Enum Constants

Enum Constant and Description
DECADI The tenth day of decade.
DUODI The second day of decade.
NONIDI The ninth day of decade.
OCTIDI The eigth day of decade.
PRIMIDI The first day of decade.
QUARTIDI The fourth day of decade.
QUINTIDI The fifth day of decade.
SEPTIDI The seventh day of decade.
SEXTIDI The sixth day of decade.
TRIDI The third day of decade.

Method Summary

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

PRIMIDI

public static final DayOfDecade PRIMIDI

The first day of decade.

DUODI

public static final DayOfDecade DUODI

The second day of decade.

TRIDI

public static final DayOfDecade TRIDI

The third day of decade.

QUARTIDI

public static final DayOfDecade QUARTIDI

The fourth day of decade.

QUINTIDI

public static final DayOfDecade QUINTIDI

The fifth day of decade.

SEXTIDI

public static final DayOfDecade SEXTIDI

The sixth day of decade.

SEPTIDI

public static final DayOfDecade SEPTIDI

The seventh day of decade.

OCTIDI

public static final DayOfDecade OCTIDI

The eigth day of decade.

NONIDI

public static final DayOfDecade NONIDI

The ninth day of decade.

DECADI

public static final DayOfDecade DECADI

The tenth day of decade.

Method Detail

values

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

Returns:

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

valueOf

public static DayOfDecade 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 DayOfDecade valueOf(int dayOfDecade)

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

Parameters:

dayOfDecade - french revolutionary day of decade in the range [1-10]

Returns:

day of decade as enum

Throws:

IllegalArgumentException - if given argument is out of range

getValue

public int getValue()

Gets the corresponding numerical value.

Returns:

number of day of decade in the range [1-10]

getDisplayName

public String getDisplayName(Locale locale)

Equivalent to getDisplayName(locale, TextWidth.WIDE, OutputContext.FORMAT).

The usage of the French language is strongly recommended.

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