Module org.threeten.extra

Package org.threeten.extra.chrono

Enum AccountingEra

java.lang.Object

java.lang.Enum<AccountingEra>

org.threeten.extra.chrono.AccountingEra

All Implemented Interfaces:

java.time.chrono.Era, java.time.temporal.TemporalAccessor, java.time.temporal.TemporalAdjuster

public enum AccountingEra
extends java.lang.Enum<AccountingEra>
implements java.time.chrono.Era

An era in the Accounting calendar system.

The Accounting calendar system has two eras. The current era, for years from 1 onwards, is known as the '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 accounting epochs 0001-01-01 (Accounting) will vary against the ISO calendar. Depending on options chosen, it can start as early as 0000-01-26 (ISO) or as late as 0001-01-04 (ISO).

Do not use ordinal() to obtain the numeric representation of AccountingEra. 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 AccountingEra	of(int era)	Obtains an instance of AccountingEra from an int value.
static AccountingEra	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static AccountingEra[]	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 AccountingEra BCE

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

CE

public static final AccountingEra CE

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

Method Detail

values

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

Returns:

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

valueOf

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

of

public static AccountingEra of(int era)

Obtains an instance of AccountingEra from an int value.

AccountingEra is an enum representing the Accounting 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:

java.time.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 java.time.chrono.Era

Returns:

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