Package me.ahoo.cosid.jackson

Annotation Interface AsString

@Target({FIELD,METHOD})
@Retention(RUNTIME)
@Inherited
public @interface AsString

Writes a long / Long id as JSON text and reads it back (07-runtime-and-spring.md §5).

The text is either the codec of a runtime generator (generator(), which needs a CosIdJacksonModule bound to the runtime) or an inline codec():

 @AsString long id;                                                    // radix 62, 11 digits, padded (as in 4.x)
 @AsString(generator = "order") long orderId;                          // the codec of generator "order"
 @AsString(codec = Codec.TO_STRING) long a;                            // decimal text
 @AsString(radix = 36, width = 13, padStart = false) long b;
 @AsString(codec = Codec.FRIENDLY, layout = Preset.SNOWFLAKE_S, zone = "Asia/Shanghai") long c;
 @AsString(codec = Codec.FRIENDLY, timeBits = 41, nodeBits = 5, seqBits = 17) long d;
 

Reading also accepts a JSON number that the codec could have written, and reads an empty string as null.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AsString.Codec	The inline codecs (the 4.x AsString.Type).
static enum	AsString.Preset	The Layout presets of a friendly id.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
AsString.Codec	codec	The inline codec.
long	epoch	AsString.Codec.FRIENDLY: the epoch in milliseconds.
String	generator	A generator of the bound runtime whose codec writes the text; set, the inline attributes must stay unset.
AsString.Preset	layout	AsString.Codec.FRIENDLY: the layout preset, or the base of timeBits(), nodeBits(), seqBits() and epoch() when they are set.
int	nodeBits	AsString.Codec.FRIENDLY: the node bits.
boolean	padStart	AsString.Codec.RADIX and AsString.Codec.FRIENDLY: pads to the full width with leading zeros.
int	radix	AsString.Codec.RADIX: the radix, 2 to 62.
int	seqBits	AsString.Codec.FRIENDLY: the sequence bits.
int	timeBits	AsString.Codec.FRIENDLY: the time bits; with nodeBits() and seqBits(), all three or none.
int	width	AsString.Codec.RADIX: the digits; 0 for as many as a long takes in the radix.
String	zone	AsString.Codec.FRIENDLY: the time zone of the date and time.

Element Details

generator

String generator

A generator of the bound runtime whose codec writes the text; set, the inline attributes must stay unset.

Returns:

the generator name, empty for the inline codec()

Default:

""

codec

AsString.Codec codec

The inline codec.

Returns:

the codec

Default:

RADIX

radix

int radix

AsString.Codec.RADIX: the radix, 2 to 62.

Returns:

the radix

Default:

62

width

int width

AsString.Codec.RADIX: the digits; 0 for as many as a long takes in the radix.

Returns:

the width

Default:

0

padStart

boolean padStart

AsString.Codec.RADIX and AsString.Codec.FRIENDLY: pads to the full width with leading zeros.

Returns:

whether to pad

Default:

true

layout

AsString.Preset layout

AsString.Codec.FRIENDLY: the layout preset, or the base of timeBits(), nodeBits(), seqBits() and epoch() when they are set.

Returns:

the preset

Default:

SNOWFLAKE_MS

timeBits

int timeBits

AsString.Codec.FRIENDLY: the time bits; with nodeBits() and seqBits(), all three or none.

Returns:

the bits, 0 for the preset's

Default:

0

nodeBits

int nodeBits

AsString.Codec.FRIENDLY: the node bits.

Returns:

the bits, -1 for the preset's

Default:

-1

seqBits

int seqBits

AsString.Codec.FRIENDLY: the sequence bits.

Returns:

the bits, 0 for the preset's

Default:

0

epoch

long epoch

AsString.Codec.FRIENDLY: the epoch in milliseconds.

Returns:

the epoch, -1 for the preset's

Default:

-1L

zone

String zone

AsString.Codec.FRIENDLY: the time zone of the date and time.

Returns:

the zone id, empty for the system default

Default:

""