Module io.github.tonywasher.joceanus.oceanus

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

Enum Class OceanusDateResource

java.lang.Object

java.lang.Enum<OceanusDateResource>

io.github.tonywasher.joceanus.oceanus.date.OceanusDateResource

All Implemented Interfaces:

OceanusBundleId, Serializable, Comparable<OceanusDateResource>, Constable

public enum OceanusDateResource
extends Enum<OceanusDateResource>
implements OceanusBundleId

Resource IDs for TethysDate package.

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
ERROR_BADFORMAT	Invalid Date String.
ERROR_NULLDATE	Null Date disallowed.
ERROR_NULLLOCALE	Null Locale disallowed.
PERIOD_ALLDATES	Period AllDates.
PERIOD_CALENDARMONTH	Period CalendarMonth.
PERIOD_CALENDARQUARTER	Period CalendarQuarter.
PERIOD_CALENDARYEAR	Period CalendarYear.
PERIOD_CUSTOM	Period Custom.
PERIOD_DATESUPTO	Period DatesUpTo.
PERIOD_FISCALYEAR	Period FiscalYear.
PERIOD_FORTNIGHT	Period Fortnight.
PERIOD_HALFYEAR	Period HalfYear.
PERIOD_ONEMONTH	Period OneMonth.
PERIOD_ONEWEEK	Period OneWeek.
PERIOD_ONEYEAR	Period OneYear.
PERIOD_QUARTERYEAR	Period QuarterYear.
RANGE_TO	Range To.
RANGE_UNBOUNDED	Range unbounded.
TITLE_BOX	Title Box.

Method Summary

Modifier and Type	Method	Description
protected static OceanusBundleId	getKeyForPeriod(OceanusDatePeriod pPeriod)	Obtain key for period.
String	getKeyName()	Get Key Name.
String	getNameSpace()	Get NameSpace.
String	getValue()	Get Value.
static OceanusDateResource	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OceanusDateResource[]	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

ERROR_NULLDATE

public static final OceanusDateResource ERROR_NULLDATE

Null Date disallowed.

ERROR_NULLLOCALE

public static final OceanusDateResource ERROR_NULLLOCALE

Null Locale disallowed.

ERROR_BADFORMAT

public static final OceanusDateResource ERROR_BADFORMAT

Invalid Date String.

PERIOD_ONEWEEK

public static final OceanusDateResource PERIOD_ONEWEEK

Period OneWeek.

PERIOD_FORTNIGHT

public static final OceanusDateResource PERIOD_FORTNIGHT

Period Fortnight.

PERIOD_ONEMONTH

public static final OceanusDateResource PERIOD_ONEMONTH

Period OneMonth.

PERIOD_QUARTERYEAR

public static final OceanusDateResource PERIOD_QUARTERYEAR

Period QuarterYear.

PERIOD_HALFYEAR

public static final OceanusDateResource PERIOD_HALFYEAR

Period HalfYear.

PERIOD_ONEYEAR

public static final OceanusDateResource PERIOD_ONEYEAR

Period OneYear.

PERIOD_CALENDARMONTH

public static final OceanusDateResource PERIOD_CALENDARMONTH

Period CalendarMonth.

PERIOD_CALENDARQUARTER

public static final OceanusDateResource PERIOD_CALENDARQUARTER

Period CalendarQuarter.

PERIOD_CALENDARYEAR

public static final OceanusDateResource PERIOD_CALENDARYEAR

Period CalendarYear.

PERIOD_FISCALYEAR

public static final OceanusDateResource PERIOD_FISCALYEAR

Period FiscalYear.

PERIOD_DATESUPTO

public static final OceanusDateResource PERIOD_DATESUPTO

Period DatesUpTo.

PERIOD_CUSTOM

public static final OceanusDateResource PERIOD_CUSTOM

Period Custom.

PERIOD_ALLDATES

public static final OceanusDateResource PERIOD_ALLDATES

Period AllDates.

RANGE_UNBOUNDED

public static final OceanusDateResource RANGE_UNBOUNDED

Range unbounded.

RANGE_TO

public static final OceanusDateResource RANGE_TO

Range To.

TITLE_BOX

public static final OceanusDateResource TITLE_BOX

Title Box.

Method Details

values

public static OceanusDateResource[] 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 OceanusDateResource 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

getKeyName

public String getKeyName()

Description copied from interface: OceanusBundleId

Get Key Name.

Specified by:

getKeyName in interface OceanusBundleId

Returns:

the key name.

getNameSpace

public String getNameSpace()

Description copied from interface: OceanusBundleId

Get NameSpace.

Specified by:

getNameSpace in interface OceanusBundleId

Returns:

the nameSpace.

getValue

public String getValue()

Description copied from interface: OceanusBundleId

Get Value.

Specified by:

getValue in interface OceanusBundleId

Returns:

the value.

getKeyForPeriod

protected static OceanusBundleId getKeyForPeriod(OceanusDatePeriod pPeriod)

Obtain key for period.

Parameters:

pPeriod - the period

Returns:

the resource key