Module me.ahoo.cosid.core

Package me.ahoo.cosid.internal

Enum Class PatternPeriod

java.lang.Object

java.lang.Enum<PatternPeriod>

me.ahoo.cosid.internal.PatternPeriod

All Implemented Interfaces:

Serializable, Comparable<PatternPeriod>, Constable, Period

public enum PatternPeriod
extends Enum<PatternPeriod>
implements Period

The preset periods: calendar years, months and days in a time zone, keyed by their pattern().

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
YEAR
YEAR_MONTH
YEAR_MONTH_DAY

Field Summary

Fields inherited from interface me.ahoo.cosid.segment.Period

YEAR, YEAR_MONTH, YEAR_MONTH_DAY

Method Summary

Modifier and Type	Method	Description
Instant	endOf(String key, ZoneId zone)	The end of the period, exclusive.
String	keyOf(Instant instant, ZoneId zone)	The key of the period instant falls in.
String	pattern()
static PatternPeriod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PatternPeriod[]	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

YEAR

public static final PatternPeriod YEAR

YEAR_MONTH

public static final PatternPeriod YEAR_MONTH

YEAR_MONTH_DAY

public static final PatternPeriod YEAR_MONTH_DAY

Method Details

values

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

pattern

public String pattern()

keyOf

public String keyOf(Instant instant,
 ZoneId zone)

Description copied from interface: Period

The key of the period instant falls in.

Specified by:

keyOf in interface Period

Parameters:

instant - the instant

zone - the time zone the periods follow

Returns:

the period key, such as "20261026"

endOf

public Instant endOf(String key,
 ZoneId zone)

Description copied from interface: Period

The end of the period, exclusive.

Specified by:

endOf in interface Period

Parameters:

key - the period key

zone - the time zone the periods follow

Returns:

the first instant after the period