net.time4j.history

Enum HistoricEra

java.lang.Object

java.lang.Enum<HistoricEra>

net.time4j.history.HistoricEra

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HistoricEra>, CalendarEra

public enum HistoricEra
extends java.lang.Enum<HistoricEra>
implements CalendarEra

Represents a historic era dividing the local timeline at roughly the point of Jesu birth in the context of the julian/gregorian calendar.

Since:

3.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
AD AD = Anno Domini
BC BC = Before Christian

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlternativeName(java.util.Locale locale, TextWidth width) Gets an alternative description text dependent on the locale and text width.
java.lang.String	getDisplayName(java.util.Locale locale, TextWidth width) Gets the description text dependent on the locale and text width.
int	getValue() Yields an ordinal number which is scaled such that every era which contains the ISO-date of UTC-epoch [1972-01-01] will have the associated value 1.
static HistoricEra	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HistoricEra[]	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

BC

public static final HistoricEra BC

BC = Before Christian

AD

public static final HistoricEra AD

AD = Anno Domini

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Description copied from interface: CalendarEra

Yields an ordinal number which is scaled such that every era which contains the ISO-date of UTC-epoch [1972-01-01] will have the associated value 1.

Specified by:

getValue in interface CalendarEra

Returns:

int

getDisplayName

public java.lang.String getDisplayName(java.util.Locale locale,
                                       TextWidth width)

Gets the description text dependent on the locale and text width.

Parameters:

locale - language setting

width - text width

Returns:

descriptive text for given locale and width (never null)

Since:

3.0

getAlternativeName

public java.lang.String getAlternativeName(java.util.Locale locale,
                                           TextWidth width)

Gets an alternative description text dependent on the locale and text width.

Actually this method only yields the English notations of "(Before) Common Era" (BCE/CE).

Parameters:

locale - language setting

width - text width

Returns:

alternative descriptive text for given locale and width (never null)

Since:

3.0