Module io.github.tonywasher.joceanus.oceanus

Package io.github.tonywasher.joceanus.oceanus.date

Enum Class OceanusFiscalYear

java.lang.Object

java.lang.Enum<OceanusFiscalYear>

io.github.tonywasher.joceanus.oceanus.date.OceanusFiscalYear

All Implemented Interfaces:

Serializable, Comparable<OceanusFiscalYear>, Constable

public enum OceanusFiscalYear
extends Enum<OceanusFiscalYear>

Fiscal Year representation.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
APRIL	April based start of year.
CALENDAR	Fiscal year based on the CalendarYear.
JULY	July based start of year.
MARCH	March based start of year.
OCTOBER	October based start of year.
UK	Fiscal Year based on UK Model.

Method Summary

Modifier and Type	Method	Description
static OceanusFiscalYear	determineFiscalYear(Locale pLocale)	Determine Fiscal Year for locale.
OceanusDate	endOfMonth(OceanusDate pDate)	Normalise date to end of FiscalMonth.
OceanusDate	endOfYear(OceanusDate pDate)	Normalise date to end of FiscalYear.
int	getFirstDay()	Obtain the day.
Month	getFirstMonth()	Obtain the month.
OceanusDate	startOfMonth(OceanusDate pDate)	Normalise date to start of FiscalMonth.
static OceanusFiscalYear	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OceanusFiscalYear[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UK

public static final OceanusFiscalYear UK

Fiscal Year based on UK Model.

MARCH

public static final OceanusFiscalYear MARCH

March based start of year.

APRIL

public static final OceanusFiscalYear APRIL

April based start of year.

JULY

public static final OceanusFiscalYear JULY

July based start of year.

OCTOBER

public static final OceanusFiscalYear OCTOBER

October based start of year.

CALENDAR

public static final OceanusFiscalYear CALENDAR

Fiscal year based on the CalendarYear.

Method Details

values

public static OceanusFiscalYear[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OceanusFiscalYear valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getFirstDay

public int getFirstDay()

Obtain the day.

Returns:

the day

getFirstMonth

public Month getFirstMonth()

Obtain the month.

Returns:

the month

determineFiscalYear

public static OceanusFiscalYear determineFiscalYear(Locale pLocale)

Determine Fiscal Year for locale.

Parameters:

pLocale - the locale

Returns:

the fiscal year type

endOfYear

public OceanusDate endOfYear(OceanusDate pDate)

Normalise date to end of FiscalYear.

Parameters:

pDate - the date to normalise.

Returns:

the normalised date

endOfMonth

public OceanusDate endOfMonth(OceanusDate pDate)

Normalise date to end of FiscalMonth.

Parameters:

pDate - the date to normalise.

Returns:

the normalised date

startOfMonth

public OceanusDate startOfMonth(OceanusDate pDate)

Normalise date to start of FiscalMonth.

Parameters:

pDate - the date to normalise.

Returns:

the normalised date