Module me.ahoo.cosid.core

Package me.ahoo.cosid.codec

Class DatePrefix

java.lang.Object

me.ahoo.cosid.codec.DatePrefix

public final class DatePrefix
extends Object

A date prefix, such as 20261026-, put before the text of another codec (03-core-model.md §1).

The date comes from the id itself (DatePrefix.Source.ID_TIME, time-based ids only) or from the injected TimeSource (DatePrefix.Source.NOW, as 4.x segments did). of(String, String, Source) describes the prefix; apply(IdCodec, ZoneId, TimeSource, Optional) puts it before a codec.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DatePrefix.Source	Where the date of the prefix comes from.

Method Summary

Modifier and Type	Method	Description
IdCodec	apply(IdCodec inner, ZoneId zone, TimeSource time, Optional<Layout> layout)	Puts this prefix before inner.
String	delimiter()
static DatePrefix	of(String pattern, String delimiter, DatePrefix.Source source)	A date prefix.
String	pattern()
DatePrefix.Source	source()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

of

public static DatePrefix of(String pattern,
 String delimiter,
 DatePrefix.Source source)

A date prefix.

Parameters:

pattern - the date pattern, such as yyyyMMdd

delimiter - the text between the date and the id

source - where the date comes from

Returns:

the prefix

pattern

public String pattern()

delimiter

public String delimiter()

source

public DatePrefix.Source source()

apply

public IdCodec apply(IdCodec inner,
 ZoneId zone,
 TimeSource time,
 Optional<Layout> layout)

Puts this prefix before inner.

Parameters:

inner - the codec of the id

zone - the time zone of the date

time - the time source, read for DatePrefix.Source.NOW

layout - the generator's layout, required for DatePrefix.Source.ID_TIME

Returns:

the prefixed codec