Module me.ahoo.cosid.core

Package me.ahoo.cosid

package me.ahoo.cosid

The generator interfaces (IdGenerator and its kinds) and the exceptions a generator throws. Everything a caller of ids needs; CosIdRuntime builds the generators.

Related Packages

Package	Description
me.ahoo.cosid.accessor	Filling the @CosId field of an entity: CosId and IdFiller (07-runtime-and-spring.md §3).
me.ahoo.cosid.codec	Turning ids into text and back: IdCodec for long ids, PartsCodec for time-based parts, GroupedCodec for periodic segments, and the built-in radix, friendly and prefix codecs.
me.ahoo.cosid.internal	Not API. The implementation of the runtime, the generators and the codecs: not exported by the module, and anything here may change or go in any release, also within 5.x.
me.ahoo.cosid.lease	Machine slots and their leases (05-machine-lease.md): the store primitive SlotLeaseStore, the lease values, and the slot handles a time-based generator issues on.
me.ahoo.cosid.observe	Events of generators, leases and stores (GeneratorListener), and the values describe() reports.
me.ahoo.cosid.runtime	The runtime: a declarative RuntimeSpec, the options of one start, and CosIdRuntime, which owns the stores, the machine slots and the generators (07-runtime-and-spring.md §1).
me.ahoo.cosid.segment	Segment generators (04-segment.md): the store primitive RangeStore, the batch and period policies, and the plain and periodic segment generators.
me.ahoo.cosid.store	The store SPI (06-stores.md §1): StoreProvider opens a Store, which gives the range and slot lease primitives; the option and key rules every backend shares; StoreTimeoutException.
me.ahoo.cosid.time	Time-based generators (03-core-model.md): layouts, the time source, the clock regression policy, TimeBasedGenerator, and UuidV7Generator (D46), whose ids carry a timestamp but need no slot.

Class	Description
ClockBackwardsException	The clock went back further than the ClockRegressionPolicy allows (03-core-model.md §4).
CosIdException	The root of the CosId exceptions.
GeneratorDisabledException	The generator is disabled by configuration (D24, 07-runtime-and-spring.md §4.1).
GroupedId	An id of a periodic segment: the period it belongs to and its value within the period (04-segment.md §3).
GroupedIdGenerator	Generates ids grouped by period; implemented by PeriodicSegmentGenerator, and the view of a periodic-segment generator.
IdGenerator	Generates long ids.
IdGenerators	Small combinators that replace the 4.x generator classes of the same purpose (03-core-model.md §5).
IdOverflowException	An id does not fit where it goes (03-core-model.md §5): the narrower type it is converted to, or the bits left beside the random bits of IdGenerators.uncertain(me.ahoo.cosid.IdGenerator, int, java.util.random.RandomGenerator).
IntIdGenerator	Generates int ids, see IdGenerators.toInt(IdGenerator).
NamespaceMismatchException	A namespace was first used with another slot limit, tolerance or slot offset (06-stores.md §1): every client of a namespace must use the same bits, tolerance and slotOffset.
PartsIdGenerator	Generates ids as their parts, for layouts wider than a long such as the 80-bit CosId; implemented by TimeBasedGenerator, and the view of a cosid80 generator.
RangeExhaustedException	A reservation would pass Long.MAX_VALUE: ranges never wrap around (04-segment.md §1, S5).
RangeSealedException	The range key is sealed: it never issues a range again (04-segment.md §1, S6).
RangeUnavailableException	No range could be reserved within the reserve timeout, or a refill is backing off after a failure (04-segment.md §2.1).
SlotLostException	The machine slot binding a generator read was invalidated: its lease was lost (05-machine-lease.md §4.2).
SlotWindowExceededException	The timestamp to issue lies beyond the ceiling of the slot window (05-machine-lease.md §3).
StringIdGenerator	An IdGenerator paired with the IdCodec that turns its ids into text.
TimeOverflowException	The time of a time-based generator no longer fits the time bits of its layout (03-core-model.md §4); replaces 4.x TimestampOverflowException.