Module org.threeten.extra

Package org.threeten.extra.chrono

Enum PaxEra

java.lang.Object

java.lang.Enum<PaxEra>

org.threeten.extra.chrono.PaxEra

All Implemented Interfaces:

Serializable, Comparable<PaxEra>, Era, TemporalAccessor, TemporalAdjuster

public enum PaxEra
extends Enum<PaxEra>
implements Era

An era in the Pax calendar system.

The Pax calendar system has two eras. The current era, for years from 1 onwards, is known as 'Current Era'. All previous years, zero or earlier in the proleptic count or one and greater in the year-of-era count, are part of the 'Before Current Era' era.

The start of the Pax epoch 0001-01-01 (Pax) is 0000-12-31 (ISO).

Do not use ordinal() to obtain the numeric representation of PaxEra. Use getValue() instead.

Implementation Requirements:

This is an immutable and thread-safe enum.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BCE	The singleton instance for the era before the current one, 'Before Current Era', which has the numeric value 0.
CE	The singleton instance for the current era, 'Current Era', which has the numeric value 1.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Gets the numeric era int value.
static PaxEra	of(int era)	Obtains an instance of PaxEra from an int value.
static PaxEra	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PaxEra[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from interface java.time.chrono.Era

adjustInto, get, getDisplayName, getLong, isSupported, query, range

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BCE

public static final PaxEra BCE

The singleton instance for the era before the current one, 'Before Current Era', which has the numeric value 0.

CE

public static final PaxEra CE

The singleton instance for the current era, 'Current Era', which has the numeric value 1.

Method Detail

values

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

Returns:

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

valueOf

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

of

public static PaxEra of(int era)

Obtains an instance of PaxEra from an int value.

PaxEra is an enum representing the Pax eras of BCE/CE. This factory allows the enum to be obtained from the int value.

Parameters:

era - the BCE/CE value to represent, from 0 (BCE) to 1 (CE)

Returns:

the era singleton, not null

Throws:

DateTimeException - if the value is invalid

getValue

public int getValue()

Gets the numeric era int value.

The era BCE has the value 0, while the era CE has the value 1.

Specified by:

getValue in interface Era

Returns:

the era value, from 0 (BCE) to 1 (CE)