Module me.ahoo.cosid.core

Package me.ahoo.cosid.codec

Class Friendly

java.lang.Object

me.ahoo.cosid.codec.Friendly

All Implemented Interfaces:

IdCodec

public final class Friendly
extends Object
implements IdCodec

Encodes a time-based id as readable text, yyyyMMddHHmmssSSS-<node>-<seq>, from Layout.unpack(long); the time zone is always explicit (03-core-model.md §1). Formats through precomputed field widths into a char[], without DateTimeFormatter.

The text holds a local time without its offset. In a zone with daylight saving time, the hour repeated when the clocks go back reads twice: decode(String) resolves it to the earlier instant (as ZonedDateTime.of does, and as 4.x did), so ids of the later pass through that hour do not round-trip. Use UTC or a fixed-offset zone when ids must decode exactly.

Method Summary

Modifier and Type	Method	Description
long	decode(String text)	Decodes text produced by IdCodec.encode(long).
String	encode(long id)	Encodes an id (R1-core-16).
Layout	layout()
static Friendly	of(Layout layout, ZoneId zone, boolean padStart)	A friendly codec.
boolean	padStart()
ZoneId	zone()

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.ahoo.cosid.codec.IdCodec

withPrefix, withSuffix

Method Details

of

public static Friendly of(Layout layout,
 ZoneId zone,
 boolean padStart)

A friendly codec.

Parameters:

layout - the layout of the ids

zone - the time zone of the time part

padStart - whether the node and sequence parts are padded with leading zeros

Returns:

the codec

Throws:

IllegalArgumentException - if the layout is wider than 63 bits: use PartsCodec.friendly(me.ahoo.cosid.time.Layout, java.time.ZoneId)

layout

public Layout layout()

zone

public ZoneId zone()

padStart

public boolean padStart()

encode

public String encode(long id)

Description copied from interface: IdCodec

Encodes an id (R1-core-16).

Specified by:

encode in interface IdCodec

Parameters:

id - the id

Returns:

the text, never null

decode

public long decode(String text)

Description copied from interface: IdCodec

Decodes text produced by IdCodec.encode(long).

Specified by:

decode in interface IdCodec

Parameters:

text - the text

Returns:

the id