Index
All Classes and Interfaces|All Packages|Serialized Form
A
- attemptedLocales() - Method in exception class com.cotani.locale.api.MissingMessageException
B
- booleanChoice(String, boolean) - Method in class com.cotani.locale.api.MessageArguments.Builder
- build() - Method in class com.cotani.locale.api.LocaleCatalog.Builder
- build() - Method in class com.cotani.locale.api.MessageArguments.Builder
- builder() - Static method in class com.cotani.locale.api.MessageArguments
- builder(LocaleId) - Static method in record class com.cotani.locale.api.LocaleCatalog
- Builder() - Constructor for class com.cotani.locale.api.MessageArguments.Builder
- bundle(MessageBundle) - Method in class com.cotani.locale.api.LocaleCatalog.Builder
- bundles() - Method in record class com.cotani.locale.api.LocaleCatalog
-
Returns the value of the
bundlesrecord component.
C
- catalog() - Method in interface com.cotani.locale.api.LocaleService
-
Returns the current immutable catalog.
- com.cotani.locale - package com.cotani.locale
- com.cotani.locale.api - package com.cotani.locale.api
- component(String, ComponentLike) - Method in class com.cotani.locale.api.MessageArguments.Builder
- CotaniLocales - Class in com.cotani.locale
-
Factories for the
cotani-localemodule.
D
- date(String, TemporalAccessor) - Method in class com.cotani.locale.api.MessageArguments.Builder
- defaultLocale() - Method in record class com.cotani.locale.api.LocaleCatalog
-
Returns the value of the
defaultLocalerecord component. - defaults() - Static method in record class com.cotani.locale.api.LocaleServiceOptions
-
Returns the default ten-second repository timeout.
- deleteAsync(UUID) - Method in interface com.cotani.locale.api.LocaleRepository
-
Removes one preference without blocking the caller.
E
- empty() - Static method in class com.cotani.locale.api.MessageArguments
- equals(Object) - Method in record class com.cotani.locale.api.LocaleCatalog
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cotani.locale.api.LocaleCatalog.ResolvedMessage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cotani.locale.api.LocaleId
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cotani.locale.api.LocaleServiceOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cotani.locale.api.MessageBundle
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cotani.locale.api.MessageKey
-
Indicates whether some other object is "equal to" this one.
F
- fallbackChain(LocaleId) - Method in record class com.cotani.locale.api.LocaleCatalog
- fallbacks() - Method in record class com.cotani.locale.api.LocaleId
-
Returns locale fallbacks from the most specific representation to the language-only form.
- find(LocaleId, MessageKey) - Method in record class com.cotani.locale.api.LocaleCatalog
- find(MessageKey) - Method in record class com.cotani.locale.api.MessageBundle
- findPlayerLocale(UUID) - Method in interface com.cotani.locale.api.LocaleService
-
Finds the explicitly stored locale for a player.
- fromRepositoryAsync(LocaleCatalog, LocaleRepository) - Static method in class com.cotani.locale.CotaniLocales
-
Creates a repository-backed service using the default ten-second timeout.
- fromRepositoryAsync(LocaleCatalog, LocaleRepository, LocaleServiceOptions) - Static method in class com.cotani.locale.CotaniLocales
-
Loads preferences and creates a repository-backed service with explicit options.
H
- hashCode() - Method in record class com.cotani.locale.api.LocaleCatalog
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cotani.locale.api.LocaleCatalog.ResolvedMessage
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cotani.locale.api.LocaleId
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cotani.locale.api.LocaleServiceOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cotani.locale.api.MessageBundle
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cotani.locale.api.MessageKey
-
Returns a hash code value for this object.
I
- inMemory(LocaleCatalog) - Static method in class com.cotani.locale.CotaniLocales
-
Creates a locale service that keeps player preferences only in memory.
K
- key() - Method in exception class com.cotani.locale.api.MissingMessageException
L
- languageOnly() - Method in record class com.cotani.locale.api.LocaleId
-
Returns the language-only fallback, or empty when this identifier is already language-only.
- languageTag() - Method in record class com.cotani.locale.api.LocaleId
-
Returns the value of the
languageTagrecord component. - loadAsync() - Method in interface com.cotani.locale.api.LocaleRepository
-
Loads an immutable snapshot of player preferences without blocking the caller.
- locale() - Method in record class com.cotani.locale.api.LocaleCatalog.ResolvedMessage
-
Returns the value of the
localerecord component. - locale() - Method in record class com.cotani.locale.api.MessageBundle
-
Returns the value of the
localerecord component. - LocaleCatalog - Record Class in com.cotani.locale.api
-
Immutable localized message catalog with deterministic fallback resolution.
- LocaleCatalog(LocaleId, Map) - Constructor for record class com.cotani.locale.api.LocaleCatalog
-
Creates an instance of a
LocaleCatalogrecord class. - LocaleCatalog.Builder - Class in com.cotani.locale.api
- LocaleCatalog.ResolvedMessage - Record Class in com.cotani.locale.api
- LocaleId - Record Class in com.cotani.locale.api
-
Canonical BCP 47 locale identifier used by a Cotani message catalog.
- LocaleId(String) - Constructor for record class com.cotani.locale.api.LocaleId
-
Creates an instance of a
LocaleIdrecord class. - LocaleRepository - Interface in com.cotani.locale.api
-
Persistence boundary for player locale preferences.
- locales() - Method in record class com.cotani.locale.api.LocaleCatalog
- locales() - Method in interface com.cotani.locale.api.LocaleService
-
Returns the supported locale identifiers.
- LocaleService - Interface in com.cotani.locale.api
-
Resolves player locales and renders localized trusted MiniMessage templates.
- LocaleServiceOptions - Record Class in com.cotani.locale.api
-
Options controlling repository-backed locale operations.
- LocaleServiceOptions(Duration) - Constructor for record class com.cotani.locale.api.LocaleServiceOptions
-
Creates an instance of a
LocaleServiceOptionsrecord class.
M
- MessageArguments - Class in com.cotani.locale.api
-
Immutable MiniMessage arguments used while rendering a localized template.
- MessageArguments.Builder - Class in com.cotani.locale.api
- MessageBundle - Record Class in com.cotani.locale.api
-
Immutable set of trusted MiniMessage templates for one locale.
- MessageBundle(LocaleId, Map) - Constructor for record class com.cotani.locale.api.MessageBundle
-
Creates an instance of a
MessageBundlerecord class. - MessageKey - Record Class in com.cotani.locale.api
-
Stable, case-insensitive key for a localized message.
- MessageKey(String) - Constructor for record class com.cotani.locale.api.MessageKey
-
Creates an instance of a
MessageKeyrecord class. - messages() - Method in record class com.cotani.locale.api.MessageBundle
-
Returns the value of the
messagesrecord component. - MissingMessageException - Exception Class in com.cotani.locale.api
-
Indicates that a message key could not be found in any locale fallback.
- MissingMessageException(LocaleId, MessageKey, List) - Constructor for exception class com.cotani.locale.api.MissingMessageException
N
- number(String, Number) - Method in class com.cotani.locale.api.MessageArguments.Builder
O
- of(LocaleId, Map) - Static method in record class com.cotani.locale.api.MessageBundle
- of(String) - Static method in record class com.cotani.locale.api.LocaleId
- of(String) - Static method in record class com.cotani.locale.api.MessageKey
P
- persistenceTimeout() - Method in record class com.cotani.locale.api.LocaleServiceOptions
-
Returns the value of the
persistenceTimeoutrecord component. - plural(String, Number) - Method in class com.cotani.locale.api.MessageArguments.Builder
-
Adds a MiniMessage choice formatter, commonly used for plural forms.
R
- registerBundle(MessageBundle) - Method in interface com.cotani.locale.api.LocaleService
-
Replaces or adds a bundle atomically for future renders.
- removePlayerLocaleAsync(UUID) - Method in interface com.cotani.locale.api.LocaleService
-
Persists and then removes a player's explicit locale preference.
- render(LocaleId, MessageKey, MessageArguments) - Method in interface com.cotani.locale.api.LocaleService
-
Renders a message using the supplied locale on the calling thread.
- render(UUID, MessageKey, MessageArguments) - Method in interface com.cotani.locale.api.LocaleService
-
Renders a message using the player's resolved locale on the calling thread.
- requestedLocale() - Method in exception class com.cotani.locale.api.MissingMessageException
- ResolvedMessage(LocaleId, String) - Constructor for record class com.cotani.locale.api.LocaleCatalog.ResolvedMessage
-
Creates an instance of a
ResolvedMessagerecord class. - resolveLocale(UUID) - Method in interface com.cotani.locale.api.LocaleService
-
Returns the player's explicit locale or the catalog default.
- resolver(TagResolver) - Method in class com.cotani.locale.api.MessageArguments.Builder
-
Adds an advanced resolver supplied by the caller.
- resolvers() - Method in class com.cotani.locale.api.MessageArguments
-
Returns a defensive array suitable for
MiniMessages.parse.
S
- saveAsync(UUID, LocaleId) - Method in interface com.cotani.locale.api.LocaleRepository
-
Saves one preference without blocking the caller.
- setPlayerLocaleAsync(UUID, LocaleId) - Method in interface com.cotani.locale.api.LocaleService
-
Persists and then publishes a player's locale preference.
T
- template() - Method in record class com.cotani.locale.api.LocaleCatalog.ResolvedMessage
-
Returns the value of the
templaterecord component. - text(String, String) - Method in class com.cotani.locale.api.MessageArguments.Builder
- toString() - Method in record class com.cotani.locale.api.LocaleCatalog.ResolvedMessage
-
Returns a string representation of this record class.
- toString() - Method in record class com.cotani.locale.api.LocaleCatalog
-
Returns a string representation of this record class.
- toString() - Method in record class com.cotani.locale.api.LocaleId
-
Returns a string representation of this record class.
- toString() - Method in record class com.cotani.locale.api.LocaleServiceOptions
-
Returns a string representation of this record class.
- toString() - Method in record class com.cotani.locale.api.MessageBundle
-
Returns a string representation of this record class.
- toString() - Method in record class com.cotani.locale.api.MessageKey
-
Returns a string representation of this record class.
U
- unregisterBundle(LocaleId) - Method in interface com.cotani.locale.api.LocaleService
-
Removes a bundle and reports whether it existed.
V
- value() - Method in record class com.cotani.locale.api.MessageKey
-
Returns the value of the
valuerecord component.
W
- withBundle(MessageBundle) - Method in record class com.cotani.locale.api.LocaleCatalog
- withoutBundle(LocaleId) - Method in record class com.cotani.locale.api.LocaleCatalog
- withTimeout(CompletionStage) - Method in record class com.cotani.locale.api.LocaleServiceOptions
-
Applies the configured timeout to a repository stage.
All Classes and Interfaces|All Packages|Serialized Form