Index

A B C D E F G H I J K L M N O P R S T U V W Y Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

acquire(String, Owner, int, Duration, Duration, int, OptionalInt) - Method in interface me.ahoo.cosid.lease.SlotLeaseStore
Acquires a slot, trying in order (§2.1): one this owner already holds, preferredSlot, the slot this owner key held last, the lowest free slot.
ACQUIRE - Static variable in class me.ahoo.cosid.internal.ObservedStores
 
AcquireReason - Enum Class in me.ahoo.cosid.lease
Which step of the slot choice (05-machine-lease.md §2.1) gave the slot; the store reports it, for observation only.
AcquireResult - Interface in me.ahoo.cosid.lease
AcquireResult.Acquired - Class in me.ahoo.cosid.lease
A slot was acquired.
AcquireResult.Acquired.Builder - Class in me.ahoo.cosid.lease
AcquireResult.Exhausted - Record Class in me.ahoo.cosid.lease
Every slot below the limit is held.
acquireTimeout() - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased
How long CosIdRuntime.start waits for a slot while every slot is held (D42): it retries as leases expire, then fails; Duration.ZERO tries once.
acquireTimeout(Duration) - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased.Builder
Sets how long CosIdRuntime.start waits for a slot while every slot is held (D42).
ahead() - Method in class me.ahoo.cosid.runtime.MachineSpec.Static
How far ahead the ceiling is written.
ahead(Duration) - Method in class me.ahoo.cosid.runtime.MachineSpec.Static.Builder
Sets how far ahead the ceiling is written.
AnnotatedIdFiller - Class in me.ahoo.cosid.internal
Fills the CosId field of an entity (07-runtime-and-spring.md §3).
AnnotatedIdFiller(Function<String, GeneratorEntry>) - Constructor for class me.ahoo.cosid.internal.AnnotatedIdFiller
A filler of a runtime's generators.
apply(IdCodec, ZoneId, TimeSource, Optional<Layout>) - Method in class me.ahoo.cosid.codec.DatePrefix
Puts this prefix before inner.
as(Class<T>) - Method in class me.ahoo.cosid.internal.GeneratorEntry
The first view that is a type.
assemble(RuntimeSpec, RuntimeOptions, Function<String, ExecutorService>) - Static method in class me.ahoo.cosid.internal.RuntimeParts
Checks the spec, then opens the stores, acquires the slot and creates the generators; on failure closes what was created and rethrows.

B

backwardsMillis() - Method in exception class me.ahoo.cosid.ClockBackwardsException
 
batch() - Method in class me.ahoo.cosid.internal.BatchSizer
The size of the next reservation.
batch() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment
The batch policy of each period.
batch() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Segment
The batch policy.
batch() - Method in class me.ahoo.cosid.segment.PeriodicSegmentGenerator
The size of the next reservation in the period being issued, for describe().
batch() - Method in class me.ahoo.cosid.segment.SegmentGenerator
The size of the next reservation, for describe().
batch(BatchPolicy) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment.Builder
Sets the batch policy of each period.
batch(BatchPolicy) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Segment.Builder
Sets the batch policy.
BatchPolicy - Class in me.ahoo.cosid.segment
How a SegmentGenerator reserves ranges (04-segment.md §2).
BatchPolicy.Builder - Class in me.ahoo.cosid.segment
Builds a BatchPolicy; BatchPolicy.Builder.build() checks the fields.
BatchSizer - Class in me.ahoo.cosid.internal
Sizes reservations by a time budget (04-segment.md §2): min(maxBatch, roundUpToStep(rate * lookahead)), at least step.
BatchSizer(long, long, Duration) - Constructor for class me.ahoo.cosid.internal.BatchSizer
A sizer that starts at step.
bits() - Method in class me.ahoo.cosid.lease.LeaseKeeper
The slot bits: the namespace holds 2^bits slots.
bits() - Method in class me.ahoo.cosid.lease.StaticSlot
 
bits() - Method in interface me.ahoo.cosid.runtime.MachineSpec
The slot bits: the slots are [0, 2^bits).
bits() - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased
The slot bits: the slots are [0, 2^bits).
bits() - Method in class me.ahoo.cosid.runtime.MachineSpec.Static
The slot bits.
bits(int) - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased.Builder
Sets the slot bits.
bits(int) - Method in class me.ahoo.cosid.runtime.MachineSpec.Static.Builder
Sets the slot bits.
borrowUpTo() - Method in record class me.ahoo.cosid.time.ClockRegressionPolicy
Returns the value of the borrowUpTo record component.
budget() - Method in class me.ahoo.cosid.internal.BatchSizer
The values the lookahead needs at the estimated rate.
build() - Method in class me.ahoo.cosid.lease.AcquireResult.Acquired.Builder
Builds the acquisition.
build() - Method in class me.ahoo.cosid.lease.SlotLease.Builder
Builds the lease.
build() - Method in class me.ahoo.cosid.observe.GeneratorInfo.Builder
Builds the description.
build() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80.Builder
Builds the generator.
build() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Custom.Builder
Builds the generator.
build() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Instance.Builder
Builds the generator.
build() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment.Builder
Builds the generator.
build() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Segment.Builder
Builds the generator.
build() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake.Builder
Builds the generator.
build() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.UuidV7.Builder
Builds the generator.
build() - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased.Builder
Builds the leased slot.
build() - Method in class me.ahoo.cosid.runtime.MachineSpec.Static.Builder
Builds the static slot.
build() - Method in class me.ahoo.cosid.runtime.RuntimeOptions.Builder
Builds the options.
build() - Method in class me.ahoo.cosid.runtime.RuntimeSpec.Builder
Builds the spec.
build() - Method in class me.ahoo.cosid.runtime.StoreSpec.Builder
Builds the store.
build() - Method in class me.ahoo.cosid.segment.BatchPolicy.Builder
Builds the policy.
build() - Method in class me.ahoo.cosid.segment.PeriodicPolicy.Builder
Builds the policy.
build() - Method in class me.ahoo.cosid.store.StoreConfig.Builder
Builds the config.
builder() - Static method in class me.ahoo.cosid.lease.SlotLease
A builder of a lease; the namespace and the owner are required, the numbers default to 0.
builder() - Static method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80
A builder of a cosid80 generator.
builder() - Static method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake
A builder of a snowflake generator.
builder() - Static method in class me.ahoo.cosid.runtime.GeneratorSpec.UuidV7
A builder of a UUIDv7 generator.
builder() - Static method in class me.ahoo.cosid.runtime.RuntimeOptions
A builder starting from the defaults (RuntimeOptions.defaults()).
builder() - Static method in class me.ahoo.cosid.segment.BatchPolicy
A builder starting from the defaults (BatchPolicy.DEFAULT).
builder() - Static method in class me.ahoo.cosid.segment.PeriodicPolicy
A builder starting from the defaults (PeriodicPolicy.DEFAULT).
builder(int) - Static method in class me.ahoo.cosid.runtime.MachineSpec.Static
A builder of a static slot.
builder(String) - Static method in class me.ahoo.cosid.runtime.GeneratorSpec.Custom
A builder of a generator by reference.
builder(String) - Static method in class me.ahoo.cosid.runtime.GeneratorSpec.Segment
A builder of a segment generator.
builder(String) - Static method in class me.ahoo.cosid.runtime.MachineSpec.Leased
A builder of a leased slot.
builder(String) - Static method in class me.ahoo.cosid.runtime.RuntimeSpec
A builder of a spec without stores, machine slot or generators.
builder(String) - Static method in class me.ahoo.cosid.runtime.StoreSpec
A builder of a store.
builder(String, String) - Static method in class me.ahoo.cosid.observe.GeneratorInfo
A builder of a generator description.
builder(String, String) - Static method in class me.ahoo.cosid.store.StoreConfig
A builder of a store config.
builder(String, Period, ZoneId) - Static method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment
A builder of a periodic segment generator.
builder(IdGenerator) - Static method in class me.ahoo.cosid.runtime.GeneratorSpec.Instance
A builder of a generator instance.
builder(SlotLease, AcquireReason) - Static method in class me.ahoo.cosid.lease.AcquireResult.Acquired
A builder of an acquisition.

C

canonical(String) - Static method in class me.ahoo.cosid.store.StoreOptions
A key as it is compared: lower case, without - and _.
cap(long) - Static method in class me.ahoo.cosid.internal.RangeCursor
end capped RangeCursor.HEADROOM below Long.MAX_VALUE.
ceiling() - Method in class me.ahoo.cosid.lease.SlotBinding
 
ceiling() - Method in class me.ahoo.cosid.lease.SlotLease
The holder issues timestamps up to it, inclusive.
ceiling() - Method in exception class me.ahoo.cosid.SlotWindowExceededException
 
ceiling(long) - Method in class me.ahoo.cosid.lease.SlotLease.Builder
Sets the ceiling: the holder issues timestamps up to it, inclusive.
ClassNameCodecs - Class in me.ahoo.cosid.internal
Resolves a custom codec reference as a class name: a public IdCodec with a public no-argument constructor.
client() - Method in class me.ahoo.cosid.store.StoreConfig
An existing connection object (DataSource, a Lettuce connection, MongoClient, CuratorFramework).
client(Object) - Method in class me.ahoo.cosid.store.StoreConfig.Builder
Sets an existing connection object; the provider does not close it.
client(String, Object) - Method in class me.ahoo.cosid.runtime.RuntimeOptions.Builder
Sets an existing client object of a store, passed as StoreConfig.client.
clients() - Method in class me.ahoo.cosid.runtime.RuntimeOptions
Existing client objects by store name, passed as StoreConfig.client.
ClockBackwardsException - Exception Class in me.ahoo.cosid
The clock went back further than the ClockRegressionPolicy allows (03-core-model.md §4).
ClockBackwardsException(String, long) - Constructor for exception class me.ahoo.cosid.ClockBackwardsException
 
ClockRegressionPolicy - Record Class in me.ahoo.cosid.time
What a time-based generator does when the clock goes back (03-core-model.md §4): up to borrowUpTo it keeps issuing in the last time unit (borrowing from the future), up to waitUpTo it waits, beyond that it throws ClockBackwardsException.
ClockRegressionPolicy(Duration, Duration) - Constructor for record class me.ahoo.cosid.time.ClockRegressionPolicy
Creates an instance of a ClockRegressionPolicy record class.
close() - Method in class me.ahoo.cosid.internal.GeneratorEntry
Closes the generator; a disabled one has nothing to close, and a user one is left to its owner.
close() - Method in class me.ahoo.cosid.internal.RuntimeParts
Closes in reverse dependency order (05-machine-lease.md §4.3): every time-based generator, then the other generators, then the slot released with the exact largest timestamp the generators issued, then the stores in reverse order, then the own executor.
close() - Method in class me.ahoo.cosid.internal.TimeSequencer
Moves the sequencer to its terminal state: no id is issued once this returns.
close() - Method in class me.ahoo.cosid.lease.LeaseKeeper
Stops renewing and releases the lease as if issued up to its ceiling, for a slot no generator used.
close() - Method in interface me.ahoo.cosid.lease.SlotLeaseStore
 
close() - Method in class me.ahoo.cosid.lease.StaticSlot
Stops extending the window; the ceiling written ahead stays in the file.
close() - Method in class me.ahoo.cosid.runtime.CosIdRuntime
Closes in reverse dependency order: generators (terminal state, time-based ones first), the slot (released with the largest timestamp they issued), stores, the own executor.
close() - Method in class me.ahoo.cosid.segment.PeriodicSegmentGenerator
Closes the generators of the current and the next period.
close() - Method in interface me.ahoo.cosid.segment.RangeStore
 
close() - Method in class me.ahoo.cosid.segment.SegmentGenerator
Stops issuing, cancels the refill in flight and drops the ready ranges (S4 allows the gap).
close() - Method in interface me.ahoo.cosid.store.Store
 
close() - Method in class me.ahoo.cosid.time.TimeBasedGenerator
Moves the sequencer to its terminal state; no id is issued once this returns.
close(long) - Method in class me.ahoo.cosid.lease.LeaseKeeper
Stops renewing and releases the lease with the exact last issued timestamp (§4.3).
close(long) - Method in class me.ahoo.cosid.lease.StaticSlot
Writes the exact last issued timestamp as the ceiling, so the next start begins right after it.
codec() - Method in record class me.ahoo.cosid.internal.RuntimePlan.Generator
Returns the value of the codec record component.
codec() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Instance
Returns the value of the codec record component.
codec() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80
The parts codec.
codec() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Custom
The codec list of its text ids, applied in order; as for a GeneratorSpec.Segment, without a layout, so neither a CodecSpec.Friendly nor a CodecSpec.DatePrefix from the id time.
codec() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Instance
The codec list of its text ids, applied in order; as for a GeneratorSpec.Segment, without a layout, so neither a CodecSpec.Friendly nor a CodecSpec.DatePrefix from the id time.
codec() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment
The grouped codec.
codec() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Segment
The codec list, applied in order.
codec() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake
The codec list, applied in order.
codec() - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.Instance
Returns the value of the codec record component.
codec() - Method in record class me.ahoo.cosid.runtime.PartsCodecSpec.Instance
Returns the value of the codec record component.
codec() - Method in record class me.ahoo.cosid.StringIdGenerator
Returns the value of the codec record component.
codec(List<CodecSpec>) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Custom.Builder
Sets the codec list of its text ids, applied in order.
codec(List<CodecSpec>) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Instance.Builder
Sets the codec list of its text ids, applied in order.
codec(List<CodecSpec>) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Segment.Builder
Sets the codec list, applied in order.
codec(List<CodecSpec>) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake.Builder
Sets the codec list, applied in order.
codec(GroupedCodecSpec) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment.Builder
Sets the grouped codec.
codec(PartsCodecSpec) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80.Builder
Sets the parts codec.
codecs() - Method in class me.ahoo.cosid.runtime.RuntimeOptions
Resolves CodecSpec.Custom references.
codecs(Function<String, Optional<IdCodec>>) - Method in class me.ahoo.cosid.runtime.RuntimeOptions.Builder
Sets how CodecSpec.Custom references resolve.
Codecs - Class in me.ahoo.cosid.internal
Builds the codecs of a runtime from their specs (07-runtime-and-spring.md §4.1): a codec list applies in order, its first item turns the id into text and the rest decorate the text.
Codecs(TimeSource, Function<String, Optional<IdCodec>>) - Constructor for class me.ahoo.cosid.internal.Codecs
Codecs built against one time source and custom codec resolver.
CodecSpec - Interface in me.ahoo.cosid.runtime
An item of a generator's codec list (07-runtime-and-spring.md §4.1).
CodecSpec.Custom - Record Class in me.ahoo.cosid.runtime
A user codec, by class name or (in Spring) bean name, resolved through RuntimeOptions.codecs().
CodecSpec.DatePrefix - Record Class in me.ahoo.cosid.runtime
me.ahoo.cosid.codec.DatePrefix.
CodecSpec.Friendly - Record Class in me.ahoo.cosid.runtime
me.ahoo.cosid.codec.Friendly; time-based generators only.
CodecSpec.Instance - Record Class in me.ahoo.cosid.runtime
A codec instance, for specs built in code.
CodecSpec.Prefix - Record Class in me.ahoo.cosid.runtime
A text prefix.
CodecSpec.Radix - Record Class in me.ahoo.cosid.runtime
me.ahoo.cosid.codec.Radix.
CodecSpec.Suffix - Record Class in me.ahoo.cosid.runtime
A text suffix.
CosId - Annotation Interface in me.ahoo.cosid.accessor
Marks the id field IdFiller fills (07-runtime-and-spring.md §3).
COSID_80 - Static variable in record class me.ahoo.cosid.time.Layout
The 80-bit CosId of 4.x: milliseconds since the Unix epoch, 44/20/16 bits; parts only (D4).
COSID_EPOCH - Static variable in record class me.ahoo.cosid.time.Layout
The 4.x epoch, 2019-12-24T16:00:00Z (D16).
cosId80(TimeBasedGenerator, PartsCodec, SlotHandle, String, String, LongAdder) - Static method in class me.ahoo.cosid.internal.GeneratorEntry
An 80-bit CosId generator: parts and text ids only.
COSID80 - Static variable in class me.ahoo.cosid.internal.GeneratorEntry
 
CosIdException - Exception Class in me.ahoo.cosid
The root of the CosId exceptions.
CosIdException(String) - Constructor for exception class me.ahoo.cosid.CosIdException
 
CosIdException(String, Throwable) - Constructor for exception class me.ahoo.cosid.CosIdException
 
CosIdRuntime - Class in me.ahoo.cosid.runtime
The one registry and lifecycle owner of stores, the machine slot and generators (07-runtime-and-spring.md §1).
countGenerated() - Method in class me.ahoo.cosid.runtime.RuntimeOptions
Whether to count the ids each generator issues through the views the runtime hands out (CosIdRuntime.generated(String)).
countGenerated(boolean) - Method in class me.ahoo.cosid.runtime.RuntimeOptions.Builder
Sets whether to count the ids each generator issues through the views the runtime hands out (CosIdRuntime.generated(String)).
current() - Method in class me.ahoo.cosid.lease.LeaseKeeper
 
current() - Method in interface me.ahoo.cosid.lease.SlotHandle
The current binding: one volatile read.
current() - Method in class me.ahoo.cosid.lease.StaticSlot
 
currentMillis() - Method in interface me.ahoo.cosid.time.TimeSource
The current time.
currentPeriod() - Method in class me.ahoo.cosid.segment.PeriodicSegmentGenerator
The period being issued, for describe().
custom(String, IdGenerator, IdCodec, LongAdder) - Static method in class me.ahoo.cosid.internal.GeneratorEntry
A user generator (GeneratorSpec.Custom or Instance, D41): the runtime hands it out but does not own it, so closing the entry leaves it open.
Custom(String) - Constructor for record class me.ahoo.cosid.runtime.CodecSpec.Custom
Creates an instance of a Custom record class.
CUSTOM - Static variable in class me.ahoo.cosid.internal.GeneratorEntry
 

D

datePrefix(String, IdCodec) - Static method in interface me.ahoo.cosid.codec.GroupedCodec
The period key, delimiter, then the value through valueCodec, such as "20261026" followed by Radix.of(10, 6, true).
datePrefix(Period, String, IdCodec) - Static method in interface me.ahoo.cosid.codec.GroupedCodec
GroupedCodec.datePrefix(String, IdCodec) for the keys of period: with a preset period the key has a known length, so the text decodes even without a delimiter (such as "20261026000042").
datePrefix(Period, String, IdCodec, UnaryOperator<IdCodec>) - Static method in interface me.ahoo.cosid.codec.GroupedCodec
The period key inside a decorated text: inner turns the value into text, the period key and delimiter are prepended to it, and outer decorates the result.
DatePrefix - Class in me.ahoo.cosid.codec
A date prefix, such as 20261026-, put before the text of another codec (03-core-model.md §1).
DatePrefix(String, String, DatePrefix.Source, ZoneId) - Constructor for record class me.ahoo.cosid.runtime.CodecSpec.DatePrefix
Creates an instance of a DatePrefix record class.
DatePrefix(String, List<CodecSpec>) - Constructor for record class me.ahoo.cosid.runtime.GroupedCodecSpec.DatePrefix
The period first: the period key, the delimiter, then the value.
DatePrefix(String, List<CodecSpec>, List<CodecSpec>) - Constructor for record class me.ahoo.cosid.runtime.GroupedCodecSpec.DatePrefix
Creates an instance of a DatePrefix record class.
DatePrefix.Source - Enum Class in me.ahoo.cosid.codec
Where the date of the prefix comes from.
DECIMAL - Static variable in class me.ahoo.cosid.internal.Codecs
The codec of an empty list: the decimal digits, as Long.toString.
decode(String) - Method in class me.ahoo.cosid.codec.Friendly
 
decode(String) - Method in interface me.ahoo.cosid.codec.GroupedCodec
Decodes text produced by GroupedCodec.encode(GroupedId).
decode(String) - Method in interface me.ahoo.cosid.codec.IdCodec
Decodes text produced by IdCodec.encode(long).
decode(String) - Method in interface me.ahoo.cosid.codec.PartsCodec
Decodes text produced by PartsCodec.encode(IdParts).
decode(String) - Method in class me.ahoo.cosid.codec.Radix
 
decorate(IdCodec, List<CodecSpec>, Optional<Layout>) - Method in class me.ahoo.cosid.internal.Codecs
Decorates the text of a codec with a list of decorations (prefixes, suffixes, date prefixes).
DEFAULT - Static variable in class me.ahoo.cosid.segment.BatchPolicy
Every default: step 100, initial offset 1, lookahead 1s, the default max batch, reserve timeout 3s, no range ttl.
DEFAULT - Static variable in class me.ahoo.cosid.segment.PeriodicPolicy
Every default: prewarm 1min, never sealed.
DEFAULT - Static variable in record class me.ahoo.cosid.time.ClockRegressionPolicy
 
DEFAULT_GENERATOR - Static variable in class me.ahoo.cosid.runtime.RuntimeSpec
 
DEFAULT_INITIAL_OFFSET - Static variable in class me.ahoo.cosid.segment.BatchPolicy
The default first value of a new key: 1, never 0.
DEFAULT_MACHINE - Static variable in class me.ahoo.cosid.runtime.RuntimeSpec
The name of the RuntimeSpec.machine() among the machines; no named machine may take it.
DEFAULT_MAX_BATCH_VALUES - Static variable in class me.ahoo.cosid.segment.BatchPolicy
The default maxBatch is at least this many values, whatever the step.
DEFAULT_STEP - Static variable in class me.ahoo.cosid.segment.BatchPolicy
 
DEFAULT_TIMEOUT - Static variable in class me.ahoo.cosid.runtime.StoreSpec
The default operation timeout: 2s.
DEFAULT_TIMEOUT - Static variable in class me.ahoo.cosid.store.StoreConfig
The default operation timeout: 2s.
defaultMaxBatch(long) - Static method in class me.ahoo.cosid.segment.BatchPolicy
The default maxBatch of a step: max(step * 1000, 2^20) rounded up to the step.
defaults() - Static method in class me.ahoo.cosid.runtime.RuntimeOptions
The system clock, an own executor, no listener, providers from ServiceLoader only, no clients, the local host, no port, custom codecs by class name, no custom generators, no counting.
defaultSeqResetThreshold(int) - Static method in record class me.ahoo.cosid.time.Layout
The 4.x default reset threshold: half the sequence range.
delimiter() - Method in class me.ahoo.cosid.codec.DatePrefix
 
delimiter() - Method in record class me.ahoo.cosid.runtime.CodecSpec.DatePrefix
Returns the value of the delimiter record component.
delimiter() - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.DatePrefix
Returns the value of the delimiter record component.
deriveOwnerKey(Optional<String>, HostResolver, OptionalInt) - Static method in class me.ahoo.cosid.internal.RuntimePlan
Derives the owner key (07-runtime-and-spring.md §1.1): the configured key, else host:port, else host:pid.
describe() - Method in class me.ahoo.cosid.runtime.CosIdRuntime
What each generator is: its layout, slot and window, its ready values and batch size, and the like.
detail(String, Object) - Method in class me.ahoo.cosid.observe.GeneratorInfo.Builder
Sets a detail.
details() - Method in class me.ahoo.cosid.observe.GeneratorInfo
Layout, slot, window, ready range headroom, batch size and the like.
details(Map<String, ?>) - Method in class me.ahoo.cosid.observe.GeneratorInfo.Builder
Sets details, keeping those set before under other keys.
disabled(String, String, String) - Static method in class me.ahoo.cosid.internal.GeneratorEntry
A disabled generator (D24): every lookup throws GeneratorDisabledException.
Disabled(GeneratorSpec) - Constructor for record class me.ahoo.cosid.runtime.GeneratorSpec.Disabled
Creates an instance of a Disabled record class.
duplicateOwnerKey() - Method in class me.ahoo.cosid.lease.AcquireResult.Acquired
Whether another incarnation of the owner key holds a live lease in the namespace, as two runtimes started with one identity would.
duplicateOwnerKey(boolean) - Method in class me.ahoo.cosid.lease.AcquireResult.Acquired.Builder
Sets whether another incarnation of the owner key holds a live lease in the namespace.

E

earliestExpiresAt() - Method in record class me.ahoo.cosid.lease.AcquireResult.Exhausted
Returns the value of the earliestExpiresAt record component.
encode(long) - Method in class me.ahoo.cosid.codec.Friendly
 
encode(long) - Method in interface me.ahoo.cosid.codec.IdCodec
Encodes an id (R1-core-16).
encode(long) - Method in class me.ahoo.cosid.codec.Radix
 
encode(GroupedId) - Method in interface me.ahoo.cosid.codec.GroupedCodec
Encodes a grouped id.
encode(IdParts) - Method in interface me.ahoo.cosid.codec.PartsCodec
Encodes the parts of an id.
end() - Method in class me.ahoo.cosid.internal.RangeCursor
 
end() - Method in record class me.ahoo.cosid.segment.Range
Returns the value of the end record component.
endOf(String, ZoneId) - Method in enum class me.ahoo.cosid.internal.PatternPeriod
 
endOf(String, ZoneId) - Method in interface me.ahoo.cosid.segment.Period
The end of the period, exclusive.
epoch() - Method in record class me.ahoo.cosid.time.Layout
Returns the value of the epoch record component.
equals(Object) - Method in record class me.ahoo.cosid.GroupedId
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.internal.RuntimePlan.Generator
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.internal.RuntimePlan.Machine
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class me.ahoo.cosid.lease.AcquireResult.Acquired
 
equals(Object) - Method in record class me.ahoo.cosid.lease.AcquireResult.Exhausted
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.lease.Owner
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class me.ahoo.cosid.lease.SlotLease
 
equals(Object) - Method in class me.ahoo.cosid.observe.GeneratorInfo
 
equals(Object) - Method in record class me.ahoo.cosid.runtime.CodecSpec.Custom
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.runtime.CodecSpec.DatePrefix
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.runtime.CodecSpec.Friendly
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.runtime.CodecSpec.Instance
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.runtime.CodecSpec.Prefix
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.runtime.CodecSpec.Radix
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.runtime.CodecSpec.Suffix
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80
 
equals(Object) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Custom
 
equals(Object) - Method in record class me.ahoo.cosid.runtime.GeneratorSpec.Disabled
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Instance
 
equals(Object) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment
 
equals(Object) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Segment
 
equals(Object) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake
 
equals(Object) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.UuidV7
 
equals(Object) - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.DatePrefix
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.Instance
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.ValueOnly
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased
 
equals(Object) - Method in class me.ahoo.cosid.runtime.MachineSpec.Static
 
equals(Object) - Method in record class me.ahoo.cosid.runtime.PartsCodecSpec.Friendly
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.runtime.PartsCodecSpec.Instance
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.runtime.PartsCodecSpec.Radix
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class me.ahoo.cosid.runtime.RuntimeOptions
 
equals(Object) - Method in class me.ahoo.cosid.runtime.RuntimeSpec
 
equals(Object) - Method in class me.ahoo.cosid.runtime.StoreSpec
 
equals(Object) - Method in class me.ahoo.cosid.segment.BatchPolicy
 
equals(Object) - Method in class me.ahoo.cosid.segment.PeriodicPolicy
 
equals(Object) - Method in record class me.ahoo.cosid.segment.Range
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class me.ahoo.cosid.store.StoreConfig
 
equals(Object) - Method in record class me.ahoo.cosid.StringIdGenerator
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.time.ClockRegressionPolicy
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.time.IdParts
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class me.ahoo.cosid.time.Layout
Indicates whether some other object is "equal to" this one.
executor() - Method in class me.ahoo.cosid.runtime.RuntimeOptions
Runs refills and renewals.
executor(Executor) - Method in class me.ahoo.cosid.runtime.RuntimeOptions.Builder
Sets the executor of refills and renewals; the runtime does not close it.
Exhausted(long) - Constructor for record class me.ahoo.cosid.lease.AcquireResult.Exhausted
Creates an instance of a Exhausted record class.
expiresAt() - Method in class me.ahoo.cosid.lease.SlotLease
When others may take the slot over.
expiresAt(long) - Method in class me.ahoo.cosid.lease.SlotLease.Builder
Sets when others may take the slot over.
expiresAtMillis() - Method in class me.ahoo.cosid.internal.ExpiringRangeCursor
 
ExpiringRangeCursor - Class in me.ahoo.cosid.internal
A cursor with a deadline, for BatchPolicy.rangeTtl (04-segment.md §2): past it the rest of the range is dropped.
ExpiringRangeCursor(long, long, long, TimeSource) - Constructor for class me.ahoo.cosid.internal.ExpiringRangeCursor
A cursor on [start, end) until expiresAtMillis.

F

FAIL - Static variable in record class me.ahoo.cosid.time.ClockRegressionPolicy
 
fence() - Method in class me.ahoo.cosid.lease.SlotLease
Raised on every ownership change (acquire, takeover, release); unchanged by renewals.
fence(long) - Method in class me.ahoo.cosid.lease.SlotLease.Builder
Sets the fence.
field() - Element in annotation interface me.ahoo.cosid.accessor.CosId
The id field, when the annotation is on the type.
fill(Object) - Method in interface me.ahoo.cosid.accessor.IdFiller
Fills the @CosId field of entity if it is not set yet; an entity whose class has no such field is left as it is (R1-core-16).
fill(Object) - Method in class me.ahoo.cosid.internal.AnnotatedIdFiller
 
filler() - Method in class me.ahoo.cosid.runtime.CosIdRuntime
Fills CosId fields from this runtime's generators.
find(String) - Method in class me.ahoo.cosid.internal.StoreProviders
The provider of type.
floor() - Method in class me.ahoo.cosid.lease.SlotBinding
 
floor() - Method in class me.ahoo.cosid.lease.SlotLease
The holder issues timestamps strictly above it.
floor(long) - Method in class me.ahoo.cosid.lease.SlotLease.Builder
Sets the floor: the holder issues timestamps strictly above it.
friendly(Layout, ZoneId) - Static method in interface me.ahoo.cosid.codec.PartsCodec
The time part as yyyyMMddHHmmssSSS in zone, then the node and the sequence.
friendly(Layout, ZoneId, boolean) - Static method in interface me.ahoo.cosid.codec.PartsCodec
The time part as yyyyMMddHHmmssSSS in zone, then the node and the sequence, padded or not.
Friendly - Class in me.ahoo.cosid.codec
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).
Friendly(ZoneId) - Constructor for record class me.ahoo.cosid.runtime.PartsCodecSpec.Friendly
The node and the sequence padded.
Friendly(ZoneId, boolean) - Constructor for record class me.ahoo.cosid.runtime.CodecSpec.Friendly
Creates an instance of a Friendly record class.
Friendly(ZoneId, boolean) - Constructor for record class me.ahoo.cosid.runtime.PartsCodecSpec.Friendly
Creates an instance of a Friendly record class.

G

generate() - Method in interface me.ahoo.cosid.GroupedIdGenerator
The next id of the current period; thread-safe, never the same id twice.
generate() - Method in interface me.ahoo.cosid.IdGenerator
The next id.
generate() - Method in interface me.ahoo.cosid.IntIdGenerator
 
generate() - Method in class me.ahoo.cosid.segment.PeriodicSegmentGenerator
Issues the next id of the current period.
generate() - Method in class me.ahoo.cosid.segment.SegmentGenerator
Issues the next value.
generate() - Method in record class me.ahoo.cosid.StringIdGenerator
 
generate() - Method in class me.ahoo.cosid.time.TimeBasedGenerator
Issues the next id.
generate() - Method in class me.ahoo.cosid.time.UuidV7Generator
The next id as text.
generated() - Method in class me.ahoo.cosid.internal.GeneratorEntry
The ids issued through the views so far.
generated(String) - Method in class me.ahoo.cosid.runtime.CosIdRuntime
The ids the generator of that name issued through the views of this runtime: its generator, stringGenerator, text(name), get by an interface type, periodic(name) excluded, and the CosIdRuntime.filler(); a uuidv7 generator counts every id it issues, by its concrete type too.
generateUuid() - Method in class me.ahoo.cosid.time.UuidV7Generator
The next id.
generation() - Method in class me.ahoo.cosid.lease.SlotBinding
 
generator() - Method in exception class me.ahoo.cosid.ClockBackwardsException
 
generator() - Method in exception class me.ahoo.cosid.GeneratorDisabledException
 
generator() - Method in record class me.ahoo.cosid.runtime.GeneratorSpec.Disabled
Returns the value of the generator record component.
generator() - Method in exception class me.ahoo.cosid.SlotLostException
 
generator() - Method in exception class me.ahoo.cosid.SlotWindowExceededException
 
generator() - Method in exception class me.ahoo.cosid.TimeOverflowException
The generator name.
generator(String) - Method in class me.ahoo.cosid.runtime.CosIdRuntime
The long generator of that name.
generator(String, GeneratorSpec) - Method in class me.ahoo.cosid.runtime.RuntimeSpec.Builder
Declares a generator, replacing one of the same name.
Generator(String, GeneratorSpec, Object, IdGenerator, String) - Constructor for record class me.ahoo.cosid.internal.RuntimePlan.Generator
Creates an instance of a Generator record class.
GeneratorDisabledException - Exception Class in me.ahoo.cosid
The generator is disabled by configuration (D24, 07-runtime-and-spring.md §4.1).
GeneratorDisabledException(String) - Constructor for exception class me.ahoo.cosid.GeneratorDisabledException
 
GeneratorEntry - Class in me.ahoo.cosid.internal
A generator of a runtime with the views its lookups hand out: its long, int, parts or grouped ids, its codec, its text ids and the generator itself.
GeneratorInfo - Class in me.ahoo.cosid.observe
What CosIdRuntime.describe() tells about a generator; replaces the 4.x Stat types.
GeneratorInfo.Builder - Class in me.ahoo.cosid.observe
Builds a GeneratorInfo.
GeneratorListener - Interface in me.ahoo.cosid.observe
Generator, lease and store events (07-runtime-and-spring.md §2).
generators() - Method in class me.ahoo.cosid.internal.RuntimeParts
The generators by name, in name order.
generators() - Method in class me.ahoo.cosid.internal.RuntimePlan
The generators in name order.
generators() - Method in class me.ahoo.cosid.runtime.RuntimeOptions
Resolves GeneratorSpec.Custom references (D41).
generators() - Method in class me.ahoo.cosid.runtime.RuntimeSpec
The generators by name; the one named "default" is the 4.x share.
generators(Function<String, Optional<IdGenerator>>) - Method in class me.ahoo.cosid.runtime.RuntimeOptions.Builder
Sets how GeneratorSpec.Custom references resolve (D41).
GeneratorSpec - Interface in me.ahoo.cosid.runtime
A generator of a RuntimeSpec, by strategy.
GeneratorSpec.CosId80 - Class in me.ahoo.cosid.runtime
A time-based generator wider than a long (Layout.COSID_80 by default), issuing parts and text only.
GeneratorSpec.CosId80.Builder - Class in me.ahoo.cosid.runtime
GeneratorSpec.Custom - Class in me.ahoo.cosid.runtime
A user long generator by reference, for configuration: CosIdRuntime.start resolves the reference through RuntimeOptions.generators() and fails when it resolves to nothing.
GeneratorSpec.Custom.Builder - Class in me.ahoo.cosid.runtime
GeneratorSpec.Disabled - Record Class in me.ahoo.cosid.runtime
A declared generator that is not created (D24, 07-runtime-and-spring.md §4.1): looking it up throws GeneratorDisabledException.
GeneratorSpec.Instance - Class in me.ahoo.cosid.runtime
A user long generator instance, for specs built in code.
GeneratorSpec.Instance.Builder - Class in me.ahoo.cosid.runtime
GeneratorSpec.PeriodicSegment - Class in me.ahoo.cosid.runtime
A periodic segment generator.
GeneratorSpec.PeriodicSegment.Builder - Class in me.ahoo.cosid.runtime
GeneratorSpec.Segment - Class in me.ahoo.cosid.runtime
A segment generator.
GeneratorSpec.Segment.Builder - Class in me.ahoo.cosid.runtime
GeneratorSpec.Snowflake - Class in me.ahoo.cosid.runtime
A time-based generator packing long ids.
GeneratorSpec.Snowflake.Builder - Class in me.ahoo.cosid.runtime
GeneratorSpec.UuidV7 - Class in me.ahoo.cosid.runtime
UUIDv7 ids (D46, RFC 9562 §5.7, a 16-bit counter): UuidV7Generator, ordered within the instance and unique without coordination.
GeneratorSpec.UuidV7.Builder - Class in me.ahoo.cosid.runtime
Builds a GeneratorSpec.UuidV7; it has no settings yet, and may gain some with defaults.
get() - Method in class me.ahoo.cosid.time.UuidV7Generator
The next id as text: UuidV7Generator.generate().
get(String, Class<T>) - Method in class me.ahoo.cosid.runtime.CosIdRuntime
The generator of that name as type: an IdGenerator, PartsIdGenerator (time-based) or GroupedIdGenerator (periodic segment), the concrete generator (TimeBasedGenerator, SegmentGenerator, PeriodicSegmentGenerator, UuidV7Generator; never counted), or for long ids a StringIdGenerator, an IntIdGenerator (range checked) or its IdCodec; for the 80-bit CosId its PartsCodec; for a periodic segment its GroupedCodec.
grouped(GroupedCodecSpec, Period) - Method in class me.ahoo.cosid.internal.Codecs
The codec of a periodic segment generator.
GroupedCodec - Interface in me.ahoo.cosid.codec
Turns a GroupedId into text and back; grouped ids have their own codec, apart from IdCodec (04-segment.md §3).
GroupedCodecSpec - Interface in me.ahoo.cosid.runtime
The codec of a GeneratorSpec.PeriodicSegment generator.
GroupedCodecSpec.DatePrefix - Record Class in me.ahoo.cosid.runtime
GroupedCodec.datePrefix(me.ahoo.cosid.segment.Period, String, me.ahoo.cosid.codec.IdCodec, java.util.function.UnaryOperator): the period key, the delimiter, then the value; outer decorates the whole, so with a prefix in it the period follows a business prefix (the 4.x group-prefix.before-prefix).
GroupedCodecSpec.Instance - Record Class in me.ahoo.cosid.runtime
A codec instance, for specs built in code.
GroupedCodecSpec.ValueOnly - Record Class in me.ahoo.cosid.runtime
GroupedCodec.valueOnly(me.ahoo.cosid.codec.IdCodec): the text holds the value alone, without its period (the 4.x group-prefix.enabled = false); such text cannot be decoded.
GroupedId - Record Class in me.ahoo.cosid
An id of a periodic segment: the period it belongs to and its value within the period (04-segment.md §3).
GroupedId(String, long) - Constructor for record class me.ahoo.cosid.GroupedId
Creates an instance of a GroupedId record class.
GroupedIdGenerator - Interface in me.ahoo.cosid
Generates ids grouped by period; implemented by PeriodicSegmentGenerator, and the view of a periodic-segment generator.

H

hashCode() - Method in record class me.ahoo.cosid.GroupedId
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.internal.RuntimePlan.Generator
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.internal.RuntimePlan.Machine
Returns a hash code value for this object.
hashCode() - Method in class me.ahoo.cosid.lease.AcquireResult.Acquired
 
hashCode() - Method in record class me.ahoo.cosid.lease.AcquireResult.Exhausted
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.lease.Owner
Returns a hash code value for this object.
hashCode() - Method in class me.ahoo.cosid.lease.SlotLease
 
hashCode() - Method in class me.ahoo.cosid.observe.GeneratorInfo
 
hashCode() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Custom
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.runtime.CodecSpec.DatePrefix
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Friendly
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Instance
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Prefix
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Radix
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Suffix
Returns a hash code value for this object.
hashCode() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80
 
hashCode() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Custom
 
hashCode() - Method in record class me.ahoo.cosid.runtime.GeneratorSpec.Disabled
Returns a hash code value for this object.
hashCode() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Instance
 
hashCode() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment
 
hashCode() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Segment
 
hashCode() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake
 
hashCode() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.UuidV7
 
hashCode() - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.DatePrefix
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.Instance
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.ValueOnly
Returns a hash code value for this object.
hashCode() - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased
 
hashCode() - Method in class me.ahoo.cosid.runtime.MachineSpec.Static
 
hashCode() - Method in record class me.ahoo.cosid.runtime.PartsCodecSpec.Friendly
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.runtime.PartsCodecSpec.Instance
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.runtime.PartsCodecSpec.Radix
Returns a hash code value for this object.
hashCode() - Method in class me.ahoo.cosid.runtime.RuntimeOptions
 
hashCode() - Method in class me.ahoo.cosid.runtime.RuntimeSpec
 
hashCode() - Method in class me.ahoo.cosid.runtime.StoreSpec
 
hashCode() - Method in class me.ahoo.cosid.segment.BatchPolicy
 
hashCode() - Method in class me.ahoo.cosid.segment.PeriodicPolicy
 
hashCode() - Method in record class me.ahoo.cosid.segment.Range
Returns a hash code value for this object.
hashCode() - Method in class me.ahoo.cosid.store.StoreConfig
 
hashCode() - Method in record class me.ahoo.cosid.StringIdGenerator
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.time.ClockRegressionPolicy
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.time.IdParts
Returns a hash code value for this object.
hashCode() - Method in record class me.ahoo.cosid.time.Layout
Returns a hash code value for this object.
HEADROOM - Static variable in class me.ahoo.cosid.internal.RangeCursor
Values within this distance of Long.MAX_VALUE are never issued (a gap, which D19 allows).
held() - Method in class me.ahoo.cosid.segment.PeriodicSegmentGenerator
The values at hand in the period being issued, for describe().
held() - Method in class me.ahoo.cosid.segment.SegmentGenerator
The values at hand, for describe().
host() - Method in interface me.ahoo.cosid.runtime.HostResolver
 
hostResolver() - Method in class me.ahoo.cosid.runtime.RuntimeOptions
The host of a derived owner key.
hostResolver(HostResolver) - Method in class me.ahoo.cosid.runtime.RuntimeOptions.Builder
Sets the host of a derived owner key.
HostResolver - Interface in me.ahoo.cosid.runtime
Resolves the host part of a derived owner key (07-runtime-and-spring.md §1.1); Spring Cloud supplies one backed by InetUtils.

I

id() - Method in exception class me.ahoo.cosid.IdOverflowException
The id that overflowed.
ID_TIME - Enum constant in enum class me.ahoo.cosid.codec.DatePrefix.Source
The time part of the id, through the generator's Layout.
IdCodec - Interface in me.ahoo.cosid.codec
Turns a long id into text and back (03-core-model.md §1).
IDEMPOTENT - Enum constant in enum class me.ahoo.cosid.lease.AcquireReason
The owner, same key and incarnation, already held the slot: a retried acquire.
IdFiller - Interface in me.ahoo.cosid.accessor
Fills the CosId field of an entity when it is not set yet (<= 0 or empty); long/Long, int/Integer (range checked) and String fields: the generator's text, as text(name) gives it (its codec, the 80-bit or periodic text, the canonical UUIDv7 form) (07-runtime-and-spring.md §3).
IdGenerator - Interface in me.ahoo.cosid
Generates long ids.
IdGenerators - Class in me.ahoo.cosid
Small combinators that replace the 4.x generator classes of the same purpose (03-core-model.md §5).
IdOverflowException - Exception Class in me.ahoo.cosid
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).
IdOverflowException(long) - Constructor for exception class me.ahoo.cosid.IdOverflowException
The id overflows int.
IdOverflowException(long, String) - Constructor for exception class me.ahoo.cosid.IdOverflowException
The id overflows, as message tells.
IdParts - Record Class in me.ahoo.cosid.time
The parts of a time-based id (03-core-model.md §2).
IdParts(long, int, long) - Constructor for record class me.ahoo.cosid.time.IdParts
Creates an instance of a IdParts record class.
ids() - Method in class me.ahoo.cosid.internal.GeneratorEntry
The long ids.
ids() - Method in record class me.ahoo.cosid.internal.RuntimePlan.Generator
Returns the value of the ids record component.
ids() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Instance
The generator.
ids() - Method in record class me.ahoo.cosid.StringIdGenerator
Returns the value of the ids record component.
ids(List<CodecSpec>, Optional<Layout>) - Method in class me.ahoo.cosid.internal.Codecs
The codec of a long generator.
incarnation() - Method in record class me.ahoo.cosid.lease.Owner
Returns the value of the incarnation record component.
info() - Method in class me.ahoo.cosid.internal.GeneratorEntry
What describe() tells about this generator.
initialOffset() - Method in class me.ahoo.cosid.segment.BatchPolicy
Where the first range of a new key starts; 4.x started at 1, and IdFiller and most databases take 0 as unset, so a generator should never issue 0.
initialOffset(long) - Method in class me.ahoo.cosid.segment.BatchPolicy.Builder
Sets where the first range of a new key starts.
Instance(GroupedCodec) - Constructor for record class me.ahoo.cosid.runtime.GroupedCodecSpec.Instance
Creates an instance of a Instance record class.
Instance(IdCodec) - Constructor for record class me.ahoo.cosid.runtime.CodecSpec.Instance
Creates an instance of a Instance record class.
Instance(PartsCodec) - Constructor for record class me.ahoo.cosid.runtime.PartsCodecSpec.Instance
Creates an instance of a Instance record class.
instant(Layout) - Method in record class me.ahoo.cosid.time.IdParts
The instant of IdParts.time().
IntIdGenerator - Interface in me.ahoo.cosid
Generates int ids, see IdGenerators.toInt(IdGenerator).
invalidate() - Method in class me.ahoo.cosid.lease.SlotBinding
Marks the binding lost: generators reading it throw SlotLostException.
isDisabled() - Method in class me.ahoo.cosid.internal.GeneratorEntry
 
isJsSafe() - Method in record class me.ahoo.cosid.time.Layout
Whether every id of this layout is exactly representable in JavaScript.
isJsSafe(long) - Static method in record class me.ahoo.cosid.time.Layout
Whether id is exactly representable in JavaScript.
isNamespace(String) - Static method in class me.ahoo.cosid.store.StoreKeys
Whether every backend stores this namespace.
isTimeout(Throwable) - Static method in exception class me.ahoo.cosid.store.StoreTimeoutException
Whether a failure is a store timeout: a StoreTimeoutException itself or among its causes.
isValid() - Method in class me.ahoo.cosid.lease.SlotBinding
 

J

JS_SAFE_BITS - Static variable in record class me.ahoo.cosid.time.Layout
The most bits a JavaScript number holds exactly.
JS_SAFE_MS - Static variable in record class me.ahoo.cosid.time.Layout
Milliseconds, 41/3/9 bits: 53 bits, safe in JavaScript.
JS_SAFE_S - Static variable in record class me.ahoo.cosid.time.Layout
Seconds, 31/3/19 bits: 53 bits, safe in JavaScript.

K

key() - Method in record class me.ahoo.cosid.lease.Owner
Returns the value of the key record component.
key() - Method in exception class me.ahoo.cosid.RangeExhaustedException
 
key() - Method in exception class me.ahoo.cosid.RangeSealedException
 
key() - Method in exception class me.ahoo.cosid.RangeUnavailableException
 
key() - Method in class me.ahoo.cosid.segment.SegmentGenerator
 
keyOf(Instant, ZoneId) - Method in enum class me.ahoo.cosid.internal.PatternPeriod
 
keyOf(Instant, ZoneId) - Method in interface me.ahoo.cosid.segment.Period
The key of the period instant falls in.
keyProblem(String, String) - Static method in class me.ahoo.cosid.store.StoreKeys
Why a range key or owner key is not portable.

L

label() - Method in enum class me.ahoo.cosid.lease.AcquireReason
The name the listener events use (idempotent, preferred, sticky, lowest).
lastIssuedMillis() - Method in class me.ahoo.cosid.internal.TimeSequencer
The time of the last issued id.
lastIssuedMillis() - Method in class me.ahoo.cosid.time.TimeBasedGenerator
The time of the last issued id.
layout() - Method in class me.ahoo.cosid.codec.Friendly
 
layout() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80
The layout: wider than 63 bits, with the Unix epoch and milliseconds, timeBits + seqBits at most 63; its node bits must cover the machine bits.
layout() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake
The layout; its node bits must cover the machine bits.
layout() - Method in class me.ahoo.cosid.time.TimeBasedGenerator
The bit layout of the ids.
layout(Layout) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80.Builder
Sets the layout: wider than 63 bits, with the Unix epoch and milliseconds (D36).
layout(Layout) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake.Builder
Sets the layout; its node bits must cover the machine bits.
Layout - Record Class in me.ahoo.cosid.time
The bit layout of time-based ids, time | node | seq from the high bits down: the one place of the bit arithmetic (03-core-model.md §2).
Layout(Instant, ChronoUnit, int, int, int, long) - Constructor for record class me.ahoo.cosid.time.Layout
Creates an instance of a Layout record class.
lazy(Supplier<? extends IdGenerator>) - Static method in class me.ahoo.cosid.IdGenerators
Looks the generator up on first use; replaces 4.x LazyIdGenerator.
lease() - Method in class me.ahoo.cosid.internal.RuntimeParts
The slot lease of the default machine, when it is leased.
lease() - Method in class me.ahoo.cosid.lease.AcquireResult.Acquired
The lease.
lease() - Method in class me.ahoo.cosid.lease.LeaseKeeper
The lease as last returned by the store.
lease(String) - Method in class me.ahoo.cosid.internal.RuntimeParts
The slot lease of a started machine, when it is leased.
LeaseKeeper - Class in me.ahoo.cosid.lease
Holds the slot lease of a runtime (05-machine-lease.md §4.2): acquires it at LeaseKeeper.start(), renews it every ttl/3 with backoff, re-acquires a lost slot and publishes each holding as a SlotBinding.
LeaseKeeper(SlotLeaseStore, String, Owner, int, Duration, Duration, int, OptionalInt, Duration, Executor, TimeSource, GeneratorListener) - Constructor for class me.ahoo.cosid.lease.LeaseKeeper
A lease keeper of a namespace with a slot offset (api-freeze.md §2.1.1); LeaseKeeper.start() acquires the slot.
LeaseKeeper(SlotLeaseStore, String, Owner, int, Duration, Duration, OptionalInt, Duration, Executor, TimeSource, GeneratorListener) - Constructor for class me.ahoo.cosid.lease.LeaseKeeper
A lease keeper; LeaseKeeper.start() acquires the slot.
listener() - Method in class me.ahoo.cosid.runtime.RuntimeOptions
The event listener.
listener(GeneratorListener) - Method in class me.ahoo.cosid.runtime.RuntimeOptions.Builder
Sets the event listener.
local() - Static method in class me.ahoo.cosid.IdGenerators
An in-process counter; replaces 4.x AtomicLongGenerator.
LOCAL - Static variable in interface me.ahoo.cosid.runtime.HostResolver
The local host name, falling back to the loopback address.
LocalHost - Class in me.ahoo.cosid.internal
The local host name of a derived owner key (07-runtime-and-spring.md §1.1).
LONG_BITS - Static variable in record class me.ahoo.cosid.time.Layout
The most bits a long id may take.
lookahead() - Method in class me.ahoo.cosid.segment.BatchPolicy
How long the ids at hand should last; Duration.ZERO disables prefetching.
lookahead(Duration) - Method in class me.ahoo.cosid.segment.BatchPolicy.Builder
Sets how long the ids at hand should last.
LOWEST - Enum constant in enum class me.ahoo.cosid.lease.AcquireReason
The lowest free slot.

M

machine() - Method in class me.ahoo.cosid.internal.GeneratorEntry
The machine a time-based generator issues on.
machine() - Method in record class me.ahoo.cosid.internal.RuntimePlan.Generator
Returns the value of the machine record component.
machine() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80
The machine whose slot the ids carry (D37).
machine() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake
The machine whose slot the ids carry (D37).
machine() - Method in class me.ahoo.cosid.runtime.RuntimeSpec
The machine slot; required when a time-based generator exists.
machine(String) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80.Builder
Sets the machine whose slot the ids carry (D37).
machine(String) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake.Builder
Sets the machine whose slot the ids carry (D37).
machine(String, MachineSpec) - Method in class me.ahoo.cosid.runtime.RuntimeSpec.Builder
Declares a named machine (D37), replacing one of the same name; it starts only when an enabled time-based generator chooses it.
machine(MachineSpec) - Method in class me.ahoo.cosid.runtime.RuntimeSpec.Builder
Sets the machine slot; required when a time-based generator exists.
Machine(String, MachineSpec, String, Optional<String>) - Constructor for record class me.ahoo.cosid.internal.RuntimePlan.Machine
Creates an instance of a Machine record class.
machines() - Method in class me.ahoo.cosid.internal.RuntimeParts
The started machines by name, in start order, with their namespaces.
machines() - Method in class me.ahoo.cosid.internal.RuntimePlan
The machines to start, in start order: the default machine, then the named ones in name order.
machines() - Method in class me.ahoo.cosid.runtime.CosIdRuntime
The machines that started: those an enabled time-based generator chose (D37).
machines() - Method in class me.ahoo.cosid.runtime.RuntimeSpec
The named machines (D37), such as a slot in a namespace shared by several services: a time-based generator chooses one by name (GeneratorSpec.Snowflake.machine()); only the chosen ones start.
MachineSpec - Interface in me.ahoo.cosid.runtime
The machine slot of a runtime (D18, 05-machine-lease.md).
MachineSpec.Leased - Class in me.ahoo.cosid.runtime
A slot leased from a store.
MachineSpec.Leased.Builder - Class in me.ahoo.cosid.runtime
MachineSpec.Static - Class in me.ahoo.cosid.runtime
A slot the user keeps unique, with a local window file.
MachineSpec.Static.Builder - Class in me.ahoo.cosid.runtime
MAX_KEY_LENGTH - Static variable in class me.ahoo.cosid.store.StoreKeys
The longest range key or owner key.
MAX_NAMESPACE_LENGTH - Static variable in class me.ahoo.cosid.store.StoreKeys
The longest namespace.
MAX_RADIX - Static variable in class me.ahoo.cosid.codec.Radix
 
maxBatch() - Method in class me.ahoo.cosid.segment.BatchPolicy
The largest reservation, a multiple of step.
maxBatch(long) - Method in class me.ahoo.cosid.segment.BatchPolicy.Builder
Sets the largest reservation.
maxValue() - Method in class me.ahoo.cosid.codec.Radix
The largest id that fits Radix.width() digits, computed with integer arithmetic.
maxWidth(int) - Static method in class me.ahoo.cosid.codec.Radix
The digits Long.MAX_VALUE takes in radix: the widest a radix codec can be.
me.ahoo.cosid - package me.ahoo.cosid
The generator interfaces (IdGenerator and its kinds) and the exceptions a generator throws.
me.ahoo.cosid.accessor - package me.ahoo.cosid.accessor
Filling the @CosId field of an entity: CosId and IdFiller (07-runtime-and-spring.md §3).
me.ahoo.cosid.codec - package 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.core - module me.ahoo.cosid.core
CosId core: generation, codecs, the store SPI, the runtime and field filling.
me.ahoo.cosid.internal - package 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 - package 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 - package me.ahoo.cosid.observe
Events of generators, leases and stores (GeneratorListener), and the values describe() reports.
me.ahoo.cosid.runtime - package 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 - package 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 - package 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 - package 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.
MIN_RADIX - Static variable in class me.ahoo.cosid.codec.Radix
 

N

name() - Method in class me.ahoo.cosid.internal.GeneratorEntry
 
name() - Static method in class me.ahoo.cosid.internal.LocalHost
The local host name, falling back to the loopback address when the name does not resolve.
name() - Method in record class me.ahoo.cosid.internal.RuntimePlan.Generator
Returns the value of the name record component.
name() - Method in record class me.ahoo.cosid.internal.RuntimePlan.Machine
Returns the value of the name record component.
name() - Method in class me.ahoo.cosid.observe.GeneratorInfo
The generator name.
name() - Method in class me.ahoo.cosid.segment.PeriodicSegmentGenerator
The generator name.
name() - Method in class me.ahoo.cosid.segment.SegmentGenerator
 
name() - Method in class me.ahoo.cosid.store.StoreConfig
The store name in the runtime spec.
name() - Method in class me.ahoo.cosid.time.TimeBasedGenerator
The generator name.
name() - Method in class me.ahoo.cosid.time.UuidV7Generator
The generator name.
nameProblem(String) - Static method in class me.ahoo.cosid.store.StoreKeys
Why a generator or machine name is not portable.
namespace() - Method in class me.ahoo.cosid.internal.RuntimeParts
 
namespace() - Method in record class me.ahoo.cosid.internal.RuntimePlan.Machine
Returns the value of the namespace record component.
namespace() - Method in class me.ahoo.cosid.lease.LeaseKeeper
The namespace the slot is leased in.
namespace() - Method in class me.ahoo.cosid.lease.SlotLease
The namespace.
namespace() - Method in exception class me.ahoo.cosid.NamespaceMismatchException
The namespace whose metadata differs.
namespace() - Method in class me.ahoo.cosid.runtime.CosIdRuntime
The namespace of the runtime: of the default machine and of the segment keys.
namespace() - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased
 
namespace() - Method in interface me.ahoo.cosid.runtime.MachineSpec
The namespace of the slot leases (D37): a machine shared by several services, such as the slot of a cosid80 generator unique across them, names its own; every machine of a runtime has another namespace.
namespace() - Method in class me.ahoo.cosid.runtime.MachineSpec.Static
 
namespace() - Method in class me.ahoo.cosid.runtime.RuntimeSpec
The namespace of the range keys and slot leases.
namespace(String) - Method in class me.ahoo.cosid.lease.SlotLease.Builder
Sets the namespace; required.
namespace(String) - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased.Builder
Sets the namespace of the slot leases (D37).
namespace(String) - Method in class me.ahoo.cosid.runtime.MachineSpec.Static.Builder
Sets the namespace the machine belongs to (D37); a static machine leases nothing, but its namespace tells the machines of a runtime apart in events, metrics and health.
NamespaceMismatchException - Exception Class in me.ahoo.cosid
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.
NamespaceMismatchException(String, String) - Constructor for exception class me.ahoo.cosid.NamespaceMismatchException
Creates the exception.
namespaceProblem(String) - Static method in class me.ahoo.cosid.store.StoreKeys
Why a namespace is not portable.
nanoTime() - Method in interface me.ahoo.cosid.internal.Ticker
The current tick.
nextId() - Method in class me.ahoo.cosid.internal.TimeSequencer
Issues the next id; the layout must fit a long.
nextParts() - Method in class me.ahoo.cosid.internal.TimeSequencer
Issues the next id as parts.
nextParts() - Method in interface me.ahoo.cosid.PartsIdGenerator
The parts of the next id; thread-safe, never the same parts twice.
nextParts() - Method in class me.ahoo.cosid.time.TimeBasedGenerator
 
node() - Method in record class me.ahoo.cosid.time.IdParts
Returns the value of the node record component.
node() - Method in class me.ahoo.cosid.time.TimeBasedGenerator
The node the ids of the current binding carry: the slot plus the node offset.
nodeBits() - Method in record class me.ahoo.cosid.time.Layout
Returns the value of the nodeBits record component.
NOOP - Static variable in interface me.ahoo.cosid.observe.GeneratorListener
 
notBefore() - Method in class me.ahoo.cosid.runtime.MachineSpec.Static
The floor when the file does not exist yet (given by the migration tool).
notBefore(Instant) - Method in class me.ahoo.cosid.runtime.MachineSpec.Static.Builder
Sets the floor when the file does not exist yet (given by the migration tool).
NOW - Enum constant in enum class me.ahoo.cosid.codec.DatePrefix.Source
The injected TimeSource at encoding time.

O

ObservedStores - Class in me.ahoo.cosid.internal
The stores as the runtime hands them to its generators and lease keeper: every call that fails with a StoreTimeoutException (itself or as a cause) is reported to GeneratorListener.onStoreTimeout(java.lang.String, java.lang.String) with the store's name and the operation, then rethrown unchanged.
of(int, int, boolean) - Static method in class me.ahoo.cosid.codec.Radix
A radix codec.
of(long, long) - Static method in class me.ahoo.cosid.internal.RangeCursor
A cursor on [start, end), its end capped RangeCursor.HEADROOM below Long.MAX_VALUE.
of(String, String, DatePrefix.Source) - Static method in class me.ahoo.cosid.codec.DatePrefix
A date prefix.
of(GeneratorListener) - Static method in class me.ahoo.cosid.internal.SafeListener
Wraps listener; GeneratorListener.NOOP and an already wrapped listener are returned as they are.
of(RuntimeSpec, RuntimeOptions, StoreProviders) - Static method in class me.ahoo.cosid.internal.RuntimePlan
Checks spec and builds its codecs.
of(Layout, ZoneId, boolean) - Static method in class me.ahoo.cosid.codec.Friendly
A friendly codec.
onBatchResized(String, long, long) - Method in class me.ahoo.cosid.internal.SafeListener
 
onBatchResized(String, long, long) - Method in interface me.ahoo.cosid.observe.GeneratorListener
The rate estimate changed the size of the next reservations (a segment with a lookahead).
onClockRegression(String, long, String) - Method in class me.ahoo.cosid.internal.SafeListener
 
onClockRegression(String, long, String) - Method in interface me.ahoo.cosid.observe.GeneratorListener
The clock went back.
onClockSkew(String, long) - Method in class me.ahoo.cosid.internal.SafeListener
 
onClockSkew(String, long) - Method in interface me.ahoo.cosid.observe.GeneratorListener
The store clock differs from this host's by more than half the tolerance, measured at a lease call.
onDuplicateOwnerKey(String, String) - Method in class me.ahoo.cosid.internal.SafeListener
 
onDuplicateOwnerKey(String, String) - Method in interface me.ahoo.cosid.observe.GeneratorListener
The acquired slot's owner key is also held by a live lease of another incarnation: two processes use one owner key (a copied owner-key), which is legal but defeats the preferred slot.
onRangeReserved(String, String, Range, Duration) - Method in class me.ahoo.cosid.internal.SafeListener
 
onRangeReserved(String, String, Range, Duration) - Method in interface me.ahoo.cosid.observe.GeneratorListener
A segment generator reserved a range from its store.
onRefillFailed(String, String, Throwable) - Method in class me.ahoo.cosid.internal.SafeListener
 
onRefillFailed(String, String, Throwable) - Method in interface me.ahoo.cosid.observe.GeneratorListener
A reservation failed; the generator retries after a backoff, and callers with no value left fail meanwhile.
onSequenceExhausted(String) - Method in class me.ahoo.cosid.internal.SafeListener
 
onSequenceExhausted(String) - Method in interface me.ahoo.cosid.observe.GeneratorListener
A time-based generator used up the sequence of its time unit and waits for the next one: once per such wait.
onSlotAcquired(SlotLease, String) - Method in class me.ahoo.cosid.internal.SafeListener
 
onSlotAcquired(SlotLease, String) - Method in interface me.ahoo.cosid.observe.GeneratorListener
A slot was acquired.
onSlotLost(SlotLease) - Method in class me.ahoo.cosid.internal.SafeListener
 
onSlotLost(SlotLease) - Method in interface me.ahoo.cosid.observe.GeneratorListener
The store no longer has the slot for this owner (it expired, or another owner took it): its generators stop at the window ceiling while a slot is acquired again.
onSlotReleased(SlotLease) - Method in class me.ahoo.cosid.internal.SafeListener
 
onSlotReleased(SlotLease) - Method in interface me.ahoo.cosid.observe.GeneratorListener
A slot was released, at the close, with the largest timestamp its generators issued.
onSlotRenewed(SlotLease) - Method in class me.ahoo.cosid.internal.SafeListener
 
onSlotRenewed(SlotLease) - Method in interface me.ahoo.cosid.observe.GeneratorListener
A slot lease was renewed: its window moved on.
onSlotRenewFailed(SlotLease, Throwable) - Method in class me.ahoo.cosid.internal.SafeListener
 
onSlotRenewFailed(SlotLease, Throwable) - Method in interface me.ahoo.cosid.observe.GeneratorListener
A renewal failed; the lease stays valid until its expiry, and the next renewal tries again.
onStoreTimeout(String, String) - Method in class me.ahoo.cosid.internal.SafeListener
 
onStoreTimeout(String, String) - Method in interface me.ahoo.cosid.observe.GeneratorListener
A store took too long: a call failed with the store's own timeout (StoreTimeoutException, itself or as a cause), operation reserve, seal, acquire, renew or release; or callers waited for a segment refill longer than the reserve timeout, operation reserve-wait, once per refill however many callers gave up.
onWindowExceeded(String) - Method in class me.ahoo.cosid.internal.SafeListener
 
onWindowExceeded(String) - Method in interface me.ahoo.cosid.observe.GeneratorListener
A time-based generator reached the ceiling of its slot window (renewals are failing or late) and waits for a renewal: once per such wait.
open(StoreConfig) - Method in interface me.ahoo.cosid.store.StoreProvider
Opens a store.
option(String, Object) - Method in class me.ahoo.cosid.runtime.StoreSpec.Builder
Sets a backend option.
option(String, Object) - Method in class me.ahoo.cosid.store.StoreConfig.Builder
Sets a backend option.
options() - Method in class me.ahoo.cosid.runtime.StoreSpec
The backend options.
options() - Method in class me.ahoo.cosid.store.StoreConfig
The backend options, such as initSchema.
options() - Method in interface me.ahoo.cosid.store.StoreProvider
The option keys this provider reads from StoreConfig.options(), spelled as it reads them (R1-spi-01).
options(Map<String, ?>) - Static method in class me.ahoo.cosid.internal.Redacted
The options without their secrets, in their order.
options(Map<String, ?>) - Method in class me.ahoo.cosid.runtime.StoreSpec.Builder
Sets backend options, keeping those set before under other keys.
options(Map<String, ?>) - Method in class me.ahoo.cosid.store.StoreConfig.Builder
Sets backend options, keeping those set before under other keys.
outer() - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.DatePrefix
Returns the value of the outer record component.
owner() - Method in class me.ahoo.cosid.lease.LeaseKeeper
The owner the slot is leased for.
owner() - Method in class me.ahoo.cosid.lease.SlotLease
The holder.
owner(Owner) - Method in class me.ahoo.cosid.lease.SlotLease.Builder
Sets the holder; required.
Owner - Record Class in me.ahoo.cosid.lease
Who holds a slot lease (05-machine-lease.md §2).
Owner(String, UUID) - Constructor for record class me.ahoo.cosid.lease.Owner
Creates an instance of a Owner record class.
ownerKey() - Method in record class me.ahoo.cosid.internal.RuntimePlan.Machine
Returns the value of the ownerKey record component.
ownerKey() - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased
The owner key.
ownerKey(String) - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased.Builder
Sets the owner key.
ownExecutor(String) - Static method in class me.ahoo.cosid.internal.RuntimeParts
The runtime's own executor: a virtual thread per task, named after the namespace.

P

pack(long, int, long) - Method in record class me.ahoo.cosid.time.Layout
Packs the parts into an id.
padStart() - Method in class me.ahoo.cosid.codec.Friendly
 
padStart() - Method in class me.ahoo.cosid.codec.Radix
 
padStart() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Friendly
Returns the value of the padStart record component.
padStart() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Radix
Returns the value of the padStart record component.
padStart() - Method in record class me.ahoo.cosid.runtime.PartsCodecSpec.Friendly
Returns the value of the padStart record component.
parts(PartsCodecSpec, Layout) - Static method in class me.ahoo.cosid.internal.Codecs
The codec of a cosid80 generator.
PartsCodec - Interface in me.ahoo.cosid.codec
Encodes the parts of a time-based id as text; the only output of ids wider than 63 bits, such as Layout.COSID_80 (D4).
PartsCodecSpec - Interface in me.ahoo.cosid.runtime
The codec of a GeneratorSpec.CosId80 generator.
PartsCodecSpec.Friendly - Record Class in me.ahoo.cosid.runtime
PartsCodecSpec.Instance - Record Class in me.ahoo.cosid.runtime
A codec instance, for specs built in code.
PartsCodecSpec.Radix - Record Class in me.ahoo.cosid.runtime
PartsIdGenerator - Interface in me.ahoo.cosid
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.
path() - Method in class me.ahoo.cosid.internal.WindowFile
 
pattern() - Method in class me.ahoo.cosid.codec.DatePrefix
 
pattern() - Method in enum class me.ahoo.cosid.internal.PatternPeriod
 
pattern() - Method in record class me.ahoo.cosid.runtime.CodecSpec.DatePrefix
Returns the value of the pattern record component.
PatternPeriod - Enum Class in me.ahoo.cosid.internal
The preset periods: calendar years, months and days in a time zone, keyed by their PatternPeriod.pattern().
period() - Method in record class me.ahoo.cosid.GroupedId
Returns the value of the period record component.
period() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment
The period.
Period - Interface in me.ahoo.cosid.segment
The period of a periodic segment (04-segment.md §3): presets Period.YEAR, Period.YEAR_MONTH and Period.YEAR_MONTH_DAY, or your own.
periodic() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment
The periodic policy.
periodic(String) - Method in class me.ahoo.cosid.runtime.CosIdRuntime
The periodic segment generator of that name.
periodic(PeriodicPolicy) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment.Builder
Sets the periodic policy.
periodic(PeriodicSegmentGenerator, GroupedCodec, String, Map<String, Object>, LongAdder) - Static method in class me.ahoo.cosid.internal.GeneratorEntry
A periodic segment generator: grouped ids only.
PERIODIC_SEGMENT - Static variable in class me.ahoo.cosid.internal.GeneratorEntry
 
PeriodicPolicy - Class in me.ahoo.cosid.segment
How a PeriodicSegmentGenerator moves between periods (04-segment.md §3).
PeriodicPolicy.Builder - Class in me.ahoo.cosid.segment
Builds a PeriodicPolicy; PeriodicPolicy.Builder.build() checks the fields.
PeriodicSegmentGenerator - Class in me.ahoo.cosid.segment
Segments grouped by period (D5, 04-segment.md §3): at most two SegmentGenerators, the current period's and the next one's, at the store keys {key}/{period}.
PeriodicSegmentGenerator(String, String, String, Period, ZoneId, RangeStore, BatchPolicy, PeriodicPolicy, Executor, TimeSource, GeneratorListener) - Constructor for class me.ahoo.cosid.segment.PeriodicSegmentGenerator
A periodic segment generator on a named store.
PeriodicSegmentGenerator(String, String, Period, ZoneId, RangeStore, BatchPolicy, PeriodicPolicy, Executor, TimeSource, GeneratorListener) - Constructor for class me.ahoo.cosid.segment.PeriodicSegmentGenerator
A periodic segment generator.
policy() - Method in class me.ahoo.cosid.segment.SegmentGenerator
 
port() - Method in class me.ahoo.cosid.runtime.RuntimeOptions
The port of a derived owner key, host:port.
port(int) - Method in class me.ahoo.cosid.runtime.RuntimeOptions.Builder
Sets the port of a derived owner key, host:port.
PREFERRED - Enum constant in enum class me.ahoo.cosid.lease.AcquireReason
The free preferred slot.
preferredSlot() - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased
The slot to try first, such as a StatefulSet ordinal.
preferredSlot(int) - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased.Builder
Sets the slot to try first, such as a StatefulSet ordinal.
prefix() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Prefix
Returns the value of the prefix record component.
Prefix(String) - Constructor for record class me.ahoo.cosid.runtime.CodecSpec.Prefix
Creates an instance of a Prefix record class.
prewarm() - Method in class me.ahoo.cosid.segment.PeriodicPolicy
The next period is created and warmed up this long before the current one ends.
prewarm(Duration) - Method in class me.ahoo.cosid.segment.PeriodicPolicy.Builder
Sets how long before the current period ends the next one is created and warmed up.

R

radix() - Method in class me.ahoo.cosid.codec.Radix
 
radix() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Radix
Returns the value of the radix record component.
radix() - Method in record class me.ahoo.cosid.runtime.PartsCodecSpec.Radix
Returns the value of the radix record component.
radix(Layout, int) - Static method in interface me.ahoo.cosid.codec.PartsCodec
Each part in radix at the fixed width its bits need, so the text sorts like the id.
Radix - Class in me.ahoo.cosid.codec
Encodes non-negative ids in base 2 to 62 with the digits 0-9A-Za-z; replaces the 4.x ToStringIdConverter, Radix36IdConverter and Radix62IdConverter (03-core-model.md §1).
Radix(int) - Constructor for record class me.ahoo.cosid.runtime.PartsCodecSpec.Radix
Creates an instance of a Radix record class.
Radix(int, int, boolean) - Constructor for record class me.ahoo.cosid.runtime.CodecSpec.Radix
Creates an instance of a Radix record class.
raiseCeiling(long) - Method in class me.ahoo.cosid.lease.SlotBinding
Raises the ceiling after a renewal; a lower value is ignored, the ceiling never goes down.
Range - Record Class in me.ahoo.cosid.segment
A range reserved from a RangeStore: [start, end) (04-segment.md §1).
Range(long, long) - Constructor for record class me.ahoo.cosid.segment.Range
Creates an instance of a Range record class.
RangeCursor - Class in me.ahoo.cosid.internal
The range a segment generator issues from (04-segment.md §2.1): one atomic increment and one comparison per value.
RangeCursor(long, long) - Constructor for class me.ahoo.cosid.internal.RangeCursor
A cursor on [next, end), unchecked: also the empty and closed sentinels.
RangeExhaustedException - Exception Class in me.ahoo.cosid
A reservation would pass Long.MAX_VALUE: ranges never wrap around (04-segment.md §1, S5).
RangeExhaustedException(String) - Constructor for exception class me.ahoo.cosid.RangeExhaustedException
 
ranges() - Method in interface me.ahoo.cosid.store.Store
The range primitive.
ranges(String, RangeStore, GeneratorListener) - Static method in class me.ahoo.cosid.internal.ObservedStores
The range store name, reporting its timeouts.
RangeSealedException - Exception Class in me.ahoo.cosid
The range key is sealed: it never issues a range again (04-segment.md §1, S6).
RangeSealedException(String) - Constructor for exception class me.ahoo.cosid.RangeSealedException
 
RangeStore - Interface in me.ahoo.cosid.segment
Reserves ranges atomically, the segment primitive of a store (04-segment.md §1).
rangeTtl() - Method in class me.ahoo.cosid.segment.BatchPolicy
A range unused for this long is dropped (4.x segment ttl).
rangeTtl(Duration) - Method in class me.ahoo.cosid.segment.BatchPolicy.Builder
Sets how long a range may stay unused before it is dropped (4.x segment ttl).
RangeUnavailableException - Exception Class in me.ahoo.cosid
No range could be reserved within the reserve timeout, or a refill is backing off after a failure (04-segment.md §2.1).
RangeUnavailableException(String, Throwable) - Constructor for exception class me.ahoo.cosid.RangeUnavailableException
 
rate() - Method in class me.ahoo.cosid.internal.BatchSizer
 
read() - Method in class me.ahoo.cosid.internal.WindowFile
Reads the persisted ceiling.
reason() - Method in class me.ahoo.cosid.lease.AcquireResult.Acquired
Which step of the slot choice gave the slot (§2.1).
record(long, long) - Method in class me.ahoo.cosid.internal.BatchSizer
Records that values were used up in elapsedMillis.
Redacted - Class in me.ahoo.cosid.internal
Store options as a toString shows them, without their secrets (R2-core-02): the value of a key whose canonical form names a password, token, secret or credential is ***, and a URL loses the password of its user info and its password= / pwd= parameters.
reference() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Custom
Returns the value of the reference record component.
reference() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Custom
The name the runtime resolves through RuntimeOptions.generators(); in Spring a bean name.
regression() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80
The clock regression policy.
regression() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake
The clock regression policy.
regression(ClockRegressionPolicy) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80.Builder
Sets the clock regression policy.
regression(ClockRegressionPolicy) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake.Builder
Sets the clock regression policy.
release(SlotLease, long) - Method in interface me.ahoo.cosid.lease.SlotLeaseStore
Releases a lease; the next holder's floor becomes max(floor, min(lastIssued, ceiling)).
RELEASE - Static variable in class me.ahoo.cosid.internal.ObservedStores
 
remaining(long) - Method in class me.ahoo.cosid.internal.ExpiringRangeCursor
 
remaining(long) - Method in class me.ahoo.cosid.internal.RangeCursor
The values not taken yet.
removeGenerator(String) - Method in class me.ahoo.cosid.runtime.RuntimeSpec.Builder
Removes a generator, if declared.
renew(SlotLease, Duration, Duration) - Method in interface me.ahoo.cosid.lease.SlotLeaseStore
Renews a lease; idempotent, the fence stays.
RENEW - Static variable in class me.ahoo.cosid.internal.ObservedStores
 
reserve(String, long, long) - Method in interface me.ahoo.cosid.segment.RangeStore
Atomically reserves [start, start + size); a missing key is created at initialOffset.
RESERVE - Static variable in class me.ahoo.cosid.internal.ObservedStores
 
RESERVE_WAIT - Static variable in class me.ahoo.cosid.segment.SegmentGenerator
The operation GeneratorListener.onStoreTimeout(java.lang.String, java.lang.String) reports when callers waited for a refill longer than the reserve timeout; a reserve call that hits the store's own timeout is reported as reserve.
reserveTimeout() - Method in class me.ahoo.cosid.segment.BatchPolicy
How long a caller waits for a refill.
reserveTimeout(Duration) - Method in class me.ahoo.cosid.segment.BatchPolicy.Builder
Sets how long a caller waits for a refill.
resolve(String) - Static method in class me.ahoo.cosid.internal.ClassNameCodecs
Creates the codec class named reference.
resolve(String, String, Set<String>, Map<String, Object>, List<String>) - Static method in class me.ahoo.cosid.store.StoreOptions
The options under the provider's spelling, the problems collected for one message with others: what the runtime checks every store with.
resolve(String, StoreProvider, Map<String, Object>) - Static method in class me.ahoo.cosid.store.StoreOptions
The options under the provider's spelling, or an error naming every unknown or repeated key.
RuntimeOptions - Class in me.ahoo.cosid.runtime
What a CosIdRuntime starts with besides its RuntimeSpec: everything that is not configuration.
RuntimeOptions.Builder - Class in me.ahoo.cosid.runtime
RuntimeParts - Class in me.ahoo.cosid.internal
What a runtime is made of, assembled in order (stores, the machine slot, generators) and closed in reverse (07-runtime-and-spring.md §1, 05-machine-lease.md §4.3).
RuntimePlan - Class in me.ahoo.cosid.internal
A RuntimeSpec checked as a whole before anything starts (07-runtime-and-spring.md §1): every problem is reported at once, and the codecs are built.
RuntimePlan.Generator - Record Class in me.ahoo.cosid.internal
A generator to create.
RuntimePlan.Machine - Record Class in me.ahoo.cosid.internal
A machine to start.
RuntimeSpec - Class in me.ahoo.cosid.runtime
Everything a CosIdRuntime starts from (07-runtime-and-spring.md §1).
RuntimeSpec.Builder - Class in me.ahoo.cosid.runtime
Builds a RuntimeSpec.

S

SafeListener - Class in me.ahoo.cosid.internal
Dispatches the runtime's events to the user's listener (07-runtime-and-spring.md §2): a listener that throws is logged, never fails the generator, refill or renewal that raised the event.
seal(String) - Method in interface me.ahoo.cosid.segment.RangeStore
Seals the key: every later RangeStore.reserve(java.lang.String, long, long) fails and the key's value is kept.
SEAL - Static variable in class me.ahoo.cosid.internal.ObservedStores
 
sealAfter() - Method in class me.ahoo.cosid.segment.PeriodicPolicy
The key of a period is sealed this long after the period ends (at least a day is advised).
sealAfter(Duration) - Method in class me.ahoo.cosid.segment.PeriodicPolicy.Builder
Sets how long after a period ends its key is sealed (at least a day is advised).
secret(String) - Static method in class me.ahoo.cosid.internal.Redacted
Whether an option holds a secret.
segment(SegmentGenerator, IdCodec, String, LongAdder) - Static method in class me.ahoo.cosid.internal.GeneratorEntry
A segment generator.
SEGMENT - Static variable in class me.ahoo.cosid.internal.GeneratorEntry
 
SegmentGenerator - Class in me.ahoo.cosid.segment
Issues the values of ranges reserved from a RangeStore (04-segment.md §2): one atomic increment on the hot path, refills off the lock and single-flight, reservation size adapted to a time budget.
SegmentGenerator(String, String, String, RangeStore, BatchPolicy, Executor, TimeSource, GeneratorListener) - Constructor for class me.ahoo.cosid.segment.SegmentGenerator
A segment generator on a named store.
SegmentGenerator(String, String, RangeStore, BatchPolicy, Executor, TimeSource, GeneratorListener) - Constructor for class me.ahoo.cosid.segment.SegmentGenerator
A segment generator.
seq() - Method in record class me.ahoo.cosid.time.IdParts
Returns the value of the seq record component.
seqBits() - Method in record class me.ahoo.cosid.time.Layout
Returns the value of the seqBits record component.
seqResetThreshold() - Method in record class me.ahoo.cosid.time.Layout
Returns the value of the seqResetThreshold record component.
sleep(long) - Method in interface me.ahoo.cosid.internal.Ticker
Waits nanos.
slot() - Method in class me.ahoo.cosid.internal.TimeSequencer
The slot of the current binding.
slot() - Method in class me.ahoo.cosid.lease.SlotBinding
 
slot() - Method in class me.ahoo.cosid.lease.SlotLease
The slot, in [0, limit).
slot() - Method in class me.ahoo.cosid.lease.StaticSlot
 
slot() - Method in class me.ahoo.cosid.runtime.CosIdRuntime
The slot lease of the default machine.
slot() - Method in class me.ahoo.cosid.runtime.MachineSpec.Static
The slot.
slot() - Method in exception class me.ahoo.cosid.SlotLostException
 
slot() - Method in class me.ahoo.cosid.time.TimeBasedGenerator
The slot of the current binding.
slot(int) - Method in class me.ahoo.cosid.lease.SlotLease.Builder
Sets the slot.
slot(String) - Method in class me.ahoo.cosid.runtime.CosIdRuntime
The slot lease of a machine (D37).
SlotBinding - Class in me.ahoo.cosid.lease
One holding of a slot and its time window (05-machine-lease.md §4.1).
SlotBinding(int, long, long, long) - Constructor for class me.ahoo.cosid.lease.SlotBinding
A binding.
SlotHandle - Interface in me.ahoo.cosid.lease
The machine slot of a runtime, shared by its time-based generators (D18, 05-machine-lease.md §4.1).
SlotLease - Class in me.ahoo.cosid.lease
A lease of a time window (floor, ceiling] on a slot (05-machine-lease.md §2).
SlotLease.Builder - Class in me.ahoo.cosid.lease
Builds a SlotLease; SlotLease.Builder.build() checks the fields.
SlotLeaseStore - Interface in me.ahoo.cosid.lease
Leases time windows on machine slots, the lease primitive of a store (05-machine-lease.md §2).
SlotLostException - Exception Class in me.ahoo.cosid
The machine slot binding a generator read was invalidated: its lease was lost (05-machine-lease.md §4.2).
SlotLostException(String, int) - Constructor for exception class me.ahoo.cosid.SlotLostException
 
slotOffset() - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased
Added to the slot to give the node of the ids (api-freeze.md §2.1.1): the nodes of this machine are [slotOffset, slotOffset + 2^bits), apart from the 4.x machine ids below it during a rolling migration.
slotOffset(int) - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased.Builder
Sets the offset added to the slot to give the node of the ids (api-freeze.md §2.1.1); it never changes once used, and every client of the namespace uses the same one.
slots() - Method in interface me.ahoo.cosid.store.Store
The slot lease primitive.
slots(String, SlotLeaseStore, GeneratorListener) - Static method in class me.ahoo.cosid.internal.ObservedStores
The slot lease store name, reporting its timeouts.
SlotWindowExceededException - Exception Class in me.ahoo.cosid
The timestamp to issue lies beyond the ceiling of the slot window (05-machine-lease.md §3).
SlotWindowExceededException(String, long, long) - Constructor for exception class me.ahoo.cosid.SlotWindowExceededException
 
snowflake(TimeBasedGenerator, IdCodec, SlotHandle, String, String, LongAdder) - Static method in class me.ahoo.cosid.internal.GeneratorEntry
A Snowflake generator.
SNOWFLAKE - Static variable in class me.ahoo.cosid.internal.GeneratorEntry
 
SNOWFLAKE_MS - Static variable in record class me.ahoo.cosid.time.Layout
Milliseconds, 41/10/12 bits from Layout.COSID_EPOCH: the 4.x default (D16).
SNOWFLAKE_S - Static variable in record class me.ahoo.cosid.time.Layout
Seconds, 31/10/22 bits from Layout.COSID_EPOCH.
source() - Method in class me.ahoo.cosid.codec.DatePrefix
 
source() - Method in record class me.ahoo.cosid.runtime.CodecSpec.DatePrefix
Returns the value of the source record component.
spec() - Method in record class me.ahoo.cosid.internal.RuntimePlan.Generator
Returns the value of the spec record component.
spec() - Method in record class me.ahoo.cosid.internal.RuntimePlan.Machine
Returns the value of the spec record component.
start() - Method in class me.ahoo.cosid.lease.LeaseKeeper
Acquires the slot and starts renewing it.
start() - Method in class me.ahoo.cosid.lease.StaticSlot
Reads the floor from the file and writes the first ceiling ahead.
start() - Method in record class me.ahoo.cosid.segment.Range
Returns the value of the start record component.
start(RuntimeSpec, RuntimeOptions) - Static method in class me.ahoo.cosid.runtime.CosIdRuntime
Checks the whole spec, then opens the stores, acquires the slot and creates the generators, rolling back what was created on failure.
stateFile() - Method in class me.ahoo.cosid.runtime.MachineSpec.Static
The window file; none means no clock regression protection.
stateFile(Path) - Method in class me.ahoo.cosid.runtime.MachineSpec.Static.Builder
Sets the window file.
StaticSlot - Class in me.ahoo.cosid.lease
A slot the user keeps unique (manual or StatefulSet ordinal), with a time window from a local file (05-machine-lease.md §4.4): the file holds the ceiling, written ahead and fsynced before use, so a crash followed by a clock regression cannot repeat ids.
StaticSlot(int, int, Optional<Path>, Duration, Optional<Instant>, Executor, TimeSource) - Constructor for class me.ahoo.cosid.lease.StaticSlot
A static slot; StaticSlot.start() reads the window.
step() - Method in class me.ahoo.cosid.segment.BatchPolicy
The smallest reservation.
step(long) - Method in class me.ahoo.cosid.segment.BatchPolicy.Builder
Sets the smallest reservation.
STICKY - Enum constant in enum class me.ahoo.cosid.lease.AcquireReason
The free slot the owner key held last.
store() - Method in class me.ahoo.cosid.observe.GeneratorInfo
The store name.
store() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment
The store name.
store() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Segment
The store name.
store() - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased
The store name.
store(String) - Method in class me.ahoo.cosid.observe.GeneratorInfo.Builder
Sets the store name.
store(String, StoreSpec) - Method in class me.ahoo.cosid.runtime.RuntimeSpec.Builder
Declares a store, replacing one of the same name.
Store - Interface in me.ahoo.cosid.store
An open store: its range and slot lease primitives (06-stores.md §1).
StoreConfig - Class in me.ahoo.cosid.store
What a StoreProvider opens a store with (06-stores.md §1).
StoreConfig.Builder - Class in me.ahoo.cosid.store
Builds a StoreConfig; StoreConfig.Builder.build() checks the fields.
StoreKeys - Class in me.ahoo.cosid.store
The keys every backend stores alike (R1-spi-02, 06-stores.md §1): namespaces, the names of generators and machines, and the range and owner keys made from them.
storeNow() - Method in class me.ahoo.cosid.lease.SlotLease
The store clock of the write that produced this lease.
storeNow(long) - Method in class me.ahoo.cosid.lease.SlotLease.Builder
Sets the store clock of the write that produced the lease.
storeOptions(String) - Method in class me.ahoo.cosid.internal.RuntimePlan
The options of a store to open, keyed as its provider declares them (StoreOptions).
StoreOptions - Class in me.ahoo.cosid.store
The options of a store matched to the keys its provider declares (R1-spi-01, R1-spring-01): case, - and _ do not count, so an environment variable (..._OPTIONS_INITSCHEMA) and kebab-case (init-schema) reach initSchema; any other key is a problem.
storeProvider(StoreProvider) - Method in class me.ahoo.cosid.runtime.RuntimeOptions.Builder
Adds a provider besides those ServiceLoader finds; it wins for the same type, and of two added for one type the first wins.
StoreProvider - Interface in me.ahoo.cosid.store
Opens stores of one type (06-stores.md §1); found through ServiceLoader or given to the runtime (as a Spring bean, say), both along the same path.
storeProviders() - Method in class me.ahoo.cosid.runtime.RuntimeOptions
Providers besides those ServiceLoader finds; they win for the same type.
StoreProviders - Class in me.ahoo.cosid.internal
Finds the StoreProvider of a store type (06-stores.md §1): the explicit providers (Spring beans or RuntimeOptions.storeProviders) first, then those ServiceLoader finds.
StoreProviders(List<StoreProvider>) - Constructor for class me.ahoo.cosid.internal.StoreProviders
The providers.
stores() - Method in class me.ahoo.cosid.internal.RuntimePlan
The stores to open, in name order.
stores() - Method in class me.ahoo.cosid.runtime.RuntimeSpec
The stores by name.
StoreSpec - Class in me.ahoo.cosid.runtime
A store of a RuntimeSpec, declared once and referred to by name.
StoreSpec.Builder - Class in me.ahoo.cosid.runtime
Builds a StoreSpec.
StoreTimeoutException - Exception Class in me.ahoo.cosid.store
A store operation did not complete within StoreConfig.timeout(): the backend's native timeout fired (06-stores.md §1).
StoreTimeoutException(String) - Constructor for exception class me.ahoo.cosid.store.StoreTimeoutException
 
StoreTimeoutException(String, Throwable) - Constructor for exception class me.ahoo.cosid.store.StoreTimeoutException
 
strategy() - Method in class me.ahoo.cosid.internal.GeneratorEntry
 
strategy() - Method in class me.ahoo.cosid.observe.GeneratorInfo
The strategy: snowflake, cosid80, segment, periodic-segment, custom or uuidv7.
stringGenerator(String) - Method in class me.ahoo.cosid.runtime.CosIdRuntime
The long generator of that name with its codec.
StringIdGenerator - Record Class in me.ahoo.cosid
An IdGenerator paired with the IdCodec that turns its ids into text.
StringIdGenerator(IdGenerator, IdCodec) - Constructor for record class me.ahoo.cosid.StringIdGenerator
Creates an instance of a StringIdGenerator record class.
strings() - Method in class me.ahoo.cosid.internal.GeneratorEntry
The long ids with the codec.
suffix() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Suffix
Returns the value of the suffix record component.
Suffix(String) - Constructor for record class me.ahoo.cosid.runtime.CodecSpec.Suffix
Creates an instance of a Suffix record class.
SYSTEM - Static variable in interface me.ahoo.cosid.internal.Ticker
 
SYSTEM - Static variable in interface me.ahoo.cosid.time.TimeSource
 

T

take() - Method in class me.ahoo.cosid.internal.ExpiringRangeCursor
 
take() - Method in class me.ahoo.cosid.internal.RangeCursor
Takes the next value.
text() - Method in class me.ahoo.cosid.internal.GeneratorEntry
The text ids of any strategy: the codec of the long id, the parts codec or the grouped codec.
text(String) - Method in class me.ahoo.cosid.runtime.CosIdRuntime
The text ids of the generator of that name, whatever its strategy (R1-int-01): the codec of its long ids, its parts codec (cosid80), its grouped codec (periodic segment) or the canonical UUID form (uuidv7, D46).
Ticker - Interface in me.ahoo.cosid.internal
Elapsed time for the schedules of the lease and window keepers: monotonic, unlike the wall clock the ids use, so a clock step neither stalls nor rushes a renewal.
time() - Method in class me.ahoo.cosid.runtime.RuntimeOptions
The time source.
time() - Method in record class me.ahoo.cosid.time.IdParts
Returns the value of the time record component.
time(TimeSource) - Method in class me.ahoo.cosid.runtime.RuntimeOptions.Builder
Sets the time source.
timeBased() - Method in class me.ahoo.cosid.internal.GeneratorEntry
The time-based generator, to close it first and read its last issued time.
TimeBasedGenerator - Class in me.ahoo.cosid.time
The time-based generator: Snowflake layouts and the 80-bit CosId alike (03-core-model.md §4).
TimeBasedGenerator(String, Layout, SlotHandle, int, TimeSource, ClockRegressionPolicy, GeneratorListener) - Constructor for class me.ahoo.cosid.time.TimeBasedGenerator
A time-based generator whose node is the slot plus an offset: the slotOffset of a leased machine (api-freeze.md §2.1.1), so its nodes lie in [nodeOffset, nodeOffset + 2^bits).
TimeBasedGenerator(String, Layout, SlotHandle, TimeSource, ClockRegressionPolicy, GeneratorListener) - Constructor for class me.ahoo.cosid.time.TimeBasedGenerator
A time-based generator.
timeBits() - Method in record class me.ahoo.cosid.time.Layout
Returns the value of the timeBits record component.
timeBits() - Method in exception class me.ahoo.cosid.TimeOverflowException
The time bits of the layout.
timeout() - Method in class me.ahoo.cosid.runtime.StoreSpec
The operation timeout.
timeout() - Method in class me.ahoo.cosid.store.StoreConfig
The operation timeout, enforced by the backend's own mechanism.
timeout(Duration) - Method in class me.ahoo.cosid.runtime.StoreSpec.Builder
Sets the operation timeout.
timeout(Duration) - Method in class me.ahoo.cosid.store.StoreConfig.Builder
Sets the operation timeout, enforced by the backend's own mechanism.
TimeOverflowException - Exception Class in me.ahoo.cosid
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.
TimeOverflowException(String, long, int) - Constructor for exception class me.ahoo.cosid.TimeOverflowException
The time overflowed.
TimeSequencer - Class in me.ahoo.cosid.internal
The sequencer of a time-based generator (03-core-model.md §4.1, 05-machine-lease.md §4.1).
TimeSequencer(String, Layout, SlotHandle, int, TimeSource, ClockRegressionPolicy, GeneratorListener) - Constructor for class me.ahoo.cosid.internal.TimeSequencer
A sequencer whose node is the slot plus an offset (api-freeze.md §2.1.1).
TimeSequencer(String, Layout, SlotHandle, TimeSource, ClockRegressionPolicy, GeneratorListener) - Constructor for class me.ahoo.cosid.internal.TimeSequencer
A sequencer.
TimeSource - Interface in me.ahoo.cosid.time
The time every generator reads (03-core-model.md §3); tests inject a controllable one.
timestampMillis() - Method in exception class me.ahoo.cosid.SlotWindowExceededException
 
toBuilder() - Method in class me.ahoo.cosid.lease.SlotLease
A builder holding this lease, to derive another.
toBuilder() - Method in class me.ahoo.cosid.runtime.RuntimeOptions
A builder holding these options, to change them.
toBuilder() - Method in class me.ahoo.cosid.runtime.RuntimeSpec
A builder holding this spec, to change it.
toInt(IdGenerator) - Static method in class me.ahoo.cosid.IdGenerators
Narrows the ids of ids to int; replaces 4.x IntegerIdGenerator.
tolerance() - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased
How far beyond the expiry the ceiling lies (D20).
tolerance(Duration) - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased.Builder
Sets how far beyond the expiry the ceiling lies (D20).
toString() - Method in record class me.ahoo.cosid.GroupedId
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.internal.RuntimePlan.Generator
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.internal.RuntimePlan.Machine
Returns a string representation of this record class.
toString() - Method in class me.ahoo.cosid.lease.AcquireResult.Acquired
 
toString() - Method in record class me.ahoo.cosid.lease.AcquireResult.Exhausted
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.lease.Owner
Returns a string representation of this record class.
toString() - Method in class me.ahoo.cosid.lease.SlotLease
 
toString() - Method in class me.ahoo.cosid.observe.GeneratorInfo
 
toString() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Custom
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.runtime.CodecSpec.DatePrefix
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Friendly
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Instance
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Prefix
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Radix
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Suffix
Returns a string representation of this record class.
toString() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80
 
toString() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Custom
 
toString() - Method in record class me.ahoo.cosid.runtime.GeneratorSpec.Disabled
Returns a string representation of this record class.
toString() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Instance
 
toString() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment
 
toString() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Segment
 
toString() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake
 
toString() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.UuidV7
 
toString() - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.DatePrefix
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.Instance
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.ValueOnly
Returns a string representation of this record class.
toString() - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased
 
toString() - Method in class me.ahoo.cosid.runtime.MachineSpec.Static
 
toString() - Method in record class me.ahoo.cosid.runtime.PartsCodecSpec.Friendly
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.runtime.PartsCodecSpec.Instance
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.runtime.PartsCodecSpec.Radix
Returns a string representation of this record class.
toString() - Method in class me.ahoo.cosid.runtime.RuntimeOptions
 
toString() - Method in class me.ahoo.cosid.runtime.RuntimeSpec
 
toString() - Method in class me.ahoo.cosid.runtime.StoreSpec
 
toString() - Method in class me.ahoo.cosid.segment.BatchPolicy
 
toString() - Method in class me.ahoo.cosid.segment.PeriodicPolicy
 
toString() - Method in record class me.ahoo.cosid.segment.Range
Returns a string representation of this record class.
toString() - Method in class me.ahoo.cosid.store.StoreConfig
 
toString() - Method in record class me.ahoo.cosid.StringIdGenerator
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.time.ClockRegressionPolicy
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.time.IdParts
Returns a string representation of this record class.
toString() - Method in record class me.ahoo.cosid.time.Layout
Returns a string representation of this record class.
toString() - Method in class me.ahoo.cosid.time.UuidV7Generator
 
totalBits() - Method in record class me.ahoo.cosid.time.Layout
 
ttl() - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased
The lease time to live.
ttl(Duration) - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased.Builder
Sets the lease time to live.
type() - Method in class me.ahoo.cosid.runtime.StoreSpec
The store type, matched to a StoreProvider.
type() - Method in class me.ahoo.cosid.store.StoreConfig
The store type.
type() - Method in interface me.ahoo.cosid.store.StoreProvider
The type this provider opens.

U

uncertain(IdGenerator, int, RandomGenerator) - Static method in class me.ahoo.cosid.IdGenerators
Appends bits random low bits to each id; replaces 4.x UncertaintyIdGenerator.
unit() - Method in record class me.ahoo.cosid.time.Layout
Returns the value of the unit record component.
unpack(long) - Method in record class me.ahoo.cosid.time.Layout
Unpacks an id into its parts.
untaken() - Method in class me.ahoo.cosid.internal.RangeCursor
The values not taken yet, ignoring expiry.
url(String) - Static method in class me.ahoo.cosid.internal.Redacted
A text without the password of a URL in it.
usable(long) - Method in class me.ahoo.cosid.internal.RangeCursor
Whether a value is left at nowMillis.
uuid() - Static method in class me.ahoo.cosid.IdGenerators
Random UUID text; replaces 4.x UuidGenerator.
uuidV7(String, TimeSource, LongAdder) - Static method in class me.ahoo.cosid.internal.GeneratorEntry
A UUIDv7 generator (D46): no long ids; its text is the canonical form.
UUIDV7 - Static variable in class me.ahoo.cosid.internal.GeneratorEntry
 
UuidV7Generator - Class in me.ahoo.cosid.time
UUIDv7 ids (D46, RFC 9562 §5.7): a 48-bit Unix millisecond timestamp, version 7, a 16-bit counter (the 12 bits of rand_a and the top 4 bits of rand_b), variant 0b10 and 58 random bits.
UuidV7Generator(String, TimeSource) - Constructor for class me.ahoo.cosid.time.UuidV7Generator
A generator on a time source.

V

value() - Element in annotation interface me.ahoo.cosid.accessor.CosId
The generator name.
value() - Method in record class me.ahoo.cosid.GroupedId
Returns the value of the value record component.
value() - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.DatePrefix
Returns the value of the value record component.
value() - Method in record class me.ahoo.cosid.runtime.GroupedCodecSpec.ValueOnly
Returns the value of the value record component.
valueOf(String) - Static method in enum class me.ahoo.cosid.codec.DatePrefix.Source
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.ahoo.cosid.internal.PatternPeriod
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.ahoo.cosid.lease.AcquireReason
Returns the enum constant of this class with the specified name.
valueOnly(IdCodec) - Static method in interface me.ahoo.cosid.codec.GroupedCodec
The value alone, without its period: the 4.x group-prefix with enabled = false.
ValueOnly(List<CodecSpec>) - Constructor for record class me.ahoo.cosid.runtime.GroupedCodecSpec.ValueOnly
Creates an instance of a ValueOnly record class.
values() - Static method in enum class me.ahoo.cosid.codec.DatePrefix.Source
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.ahoo.cosid.internal.PatternPeriod
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.ahoo.cosid.lease.AcquireReason
Returns an array containing the constants of this enum class, in the order they are declared.

W

waitUpTo() - Method in record class me.ahoo.cosid.time.ClockRegressionPolicy
Returns the value of the waitUpTo record component.
width() - Method in class me.ahoo.cosid.codec.Radix
 
width() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Radix
Returns the value of the width record component.
WindowFile - Class in me.ahoo.cosid.internal
The window file of a StaticSlot (05-machine-lease.md §4.4): one ceiling, written to a temporary file, fsynced, then moved over the old file atomically, so a crash leaves either the old or the new ceiling, never a torn one.
WindowFile(Path) - Constructor for class me.ahoo.cosid.internal.WindowFile
A window file.
withLookahead(Duration) - Method in class me.ahoo.cosid.segment.BatchPolicy
This policy with another lookahead.
withMachine(String) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.CosId80
This generator on another machine, such as a slot in a namespace shared across services.
withMachine(String) - Method in class me.ahoo.cosid.runtime.GeneratorSpec.Snowflake
This generator on another machine.
withNamespace(String) - Method in class me.ahoo.cosid.runtime.MachineSpec.Leased
This machine in another namespace.
withNamespace(String) - Method in class me.ahoo.cosid.runtime.MachineSpec.Static
This machine in another namespace.
withNodeBits(int) - Method in record class me.ahoo.cosid.time.Layout
This layout with another node part; the time and sequence parts stay as they are.
withPrefix(String) - Method in interface me.ahoo.cosid.codec.IdCodec
Prepends prefix to the encoded text.
withStep(long) - Method in class me.ahoo.cosid.segment.BatchPolicy
This policy with another step.
withSuffix(String) - Method in interface me.ahoo.cosid.codec.IdCodec
Appends suffix to the encoded text.
write(long) - Method in class me.ahoo.cosid.internal.WindowFile
Persists ceiling durably: when this returns, a crash cannot lose it.

Y

YEAR - Enum constant in enum class me.ahoo.cosid.internal.PatternPeriod
 
YEAR - Static variable in interface me.ahoo.cosid.segment.Period
"2026".
YEAR_MONTH - Enum constant in enum class me.ahoo.cosid.internal.PatternPeriod
 
YEAR_MONTH - Static variable in interface me.ahoo.cosid.segment.Period
"202610".
YEAR_MONTH_DAY - Enum constant in enum class me.ahoo.cosid.internal.PatternPeriod
 
YEAR_MONTH_DAY - Static variable in interface me.ahoo.cosid.segment.Period
"20261026".

Z

zone() - Method in class me.ahoo.cosid.codec.Friendly
 
zone() - Method in record class me.ahoo.cosid.runtime.CodecSpec.DatePrefix
Returns the value of the zone record component.
zone() - Method in record class me.ahoo.cosid.runtime.CodecSpec.Friendly
Returns the value of the zone record component.
zone() - Method in class me.ahoo.cosid.runtime.GeneratorSpec.PeriodicSegment
The time zone the periods follow.
zone() - Method in record class me.ahoo.cosid.runtime.PartsCodecSpec.Friendly
Returns the value of the zone record component.
A B C D E F G H I J K L M N O P R S T U V W Y Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form