Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- Accessor - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors
-
Defines a uniform contract for accessing structured data from objects that do not directly implement a library-specific interface.
- Accessor.BuiltIn - Enum Class in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors
-
Enumeration of all built-in adapter types supported by the message builder pipeline.
- AccessorCtx - Record Class in com.winterhavenmc.library.messagebuilder.core.context
-
A simple context container that provides shared services to adapter implementations during macro extraction.
- AccessorCtx(WorldNameResolver, ItemNameResolver, ItemDisplayNameResolver, ItemPluralNameResolver, FormatterCtx) - Constructor for record class com.winterhavenmc.library.messagebuilder.core.context.AccessorCtx
-
Creates an instance of a
AccessorCtxrecord class. - Accessor Registration and Precedence - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors
- Section
- AccessorRegistry - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors
- adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.displayname.DisplayNameAdapter
-
Attempts to adapt the given object to a
DisplayNameableinstance. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.duration.DurationAdapter
-
Attempts to adapt the given object into a
Durationableif it explicitly implements the interface. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.expiration.ExpirationAdapter
-
Attempts to adapt the given object into an
Expirable, if applicable. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.identity.UniqueIdAdapter
-
Attempts to adapt the given object to an
Identifiableinstance. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.instant.InstantAdapter
-
Attempts to adapt an object into an
Instantable, if it already implements the interface. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.killer.KillerAdapter
-
Attempts to adapt an object to the
Killableinterface. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.location.LocationAdapter
- adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.looter.LooterAdapter
-
Attempts to adapt an object into a
Lootable. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.name.NameAdapter
-
Attempts to adapt the given object to a
Nameable, if it exposes a name field. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.owner.OwnerAdapter
-
Attempts to adapt the given object to the
Ownableinterface, either directly or by wrapping supported Bukkit types. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.pluralname.PluralNameAdapter
-
Attempts to adapt the given object to a
PluralNameableinstance. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.protection.ProtectionAdapter
-
Attempts to adapt the given object to the
Protectableinterface. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.quantity.BukkitQuantityAccessor
-
Attempts to adapt the given object into a
Quantifiableinstance. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.url.UrlAdapter
- adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.version.VersionAdapter
- adapt(Object) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor
-
Attempts to adapt the given object to a type-specific representation for macro extraction.
- ADAPTER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- addTo(R, long) - Method in class com.winterhavenmc.library.messagebuilder.models.time.Tick
- aliasOrName(UUID) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitWorldRepository
- aliasOrName(UUID) - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.WorldRepository
- append(E) - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidMacroKey
-
Create a new string by suffixing a dot-separated subkey to this existing string
- append(String) - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidMacroKey
-
Create a new string by suffixing a dot-separated subkey to this existing string
- asPlaceholder() - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidMacroKey
- AtomicResolver - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.value
-
A
ValueResolverimplementation that handles simple or atomic values, converting them into formatted strings mapped directly to the baseValidMacroKey. - AtomicResolver(FormatterCtx) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.value.AtomicResolver
-
Constructs an
AtomicResolverusing the provided formatter container.
B
- BASE_KEY_PATTERN - Static variable in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.replacers.RegexMacroReplacer
-
Pattern used to match base macro keys (e.g.,
[ITEM}) for macro resolution via theValueResolver. - between(Temporal, Temporal) - Method in class com.winterhavenmc.library.messagebuilder.models.time.Tick
- BLANK - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.DefaultSymbol
- BootstrapUtility - Class in com.winterhavenmc.library.messagebuilder
-
A companion utility class to facilitate arranging components necessary to initialize the MessageBuilder library.
- BoundedDuration - Record Class in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.duration
-
A simple data container that encapsulates a
Durationand its corresponding lower bound of precision, represented by aChronoUnit. - BoundedDuration(Duration, ChronoUnit) - Constructor for record class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.duration.BoundedDuration
-
Creates an instance of a
BoundedDurationrecord class. - Built-in Accessor Support - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors
- Section
- BukkitConfigRepository - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.configuration
- BukkitItemDisplayNameResolver - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.itemname
- BukkitItemDisplayNameResolver() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.itemname.BukkitItemDisplayNameResolver
- BukkitItemNameResolver - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.itemname
- BukkitItemNameResolver() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.itemname.BukkitItemNameResolver
- BukkitItemPluralNameResolver - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.itemname
- BukkitItemPluralNameResolver(ItemRepository) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.itemname.BukkitItemPluralNameResolver
- BukkitQuantityAccessor - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.quantity
-
Accessor implementation for extracting quantity values from supported objects.
- BukkitQuantityAccessor() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.quantity.BukkitQuantityAccessor
- BukkitSpawnLocationResolver - Interface in com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.spawnlocation
- BukkitWorldRepository - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.configuration
- BUNDLE_NAME - Static variable in interface com.winterhavenmc.library.messagebuilder.models.validation.Validator
C
- Classification - Search tag in package com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration
- Section
- classify(Duration, ChronoUnit) - Static method in enum class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration.DurationType
-
Classifies a
Durationinto one of threeDurationTypecategories used for formatting:DurationType.UNLIMITED– if the duration is negative, it represents an unlimited timeDurationType.LESS_THAN– if the duration is non-negative and less than one unit of the specified precisionDurationType.NORMAL– if the duration is equal to or greater than one unit of the specified precision - CLOSE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.Delimiter
- com.winterhavenmc.library.messagebuilder - package com.winterhavenmc.library.messagebuilder
-
The core package of MessageBuilderLib, a library designed to simplify the dynamic construction and macro-based substitution of messages in Bukkit plugins.
- com.winterhavenmc.library.messagebuilder.adapters.pipeline - package com.winterhavenmc.library.messagebuilder.adapters.pipeline
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors
-
Provides classes that expose a uniform interface for accessing structured data from diverse object types used within MessageBuilderLib.
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.displayname - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.displayname
-
Provides an adapter and interface for extracting and formatting display names from objects.
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.duration - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.duration
-
Provides an adapter for objects that expose a
Duration. - com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.expiration - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.expiration
-
Provides adapter and interface support for expiration-based macro replacements.
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.identity - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.identity
-
Provides support for macro replacement of UUID values from objects.
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.instant - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.instant
-
Provides adapter support for objects that expose a timestamp via the
InstantAPI. - com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.killer - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.killer
-
Provides support for extracting killer information from entities or plugin-defined objects.
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.location - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.location
-
Provides support for extracting and formatting location-based macro values from objects.
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.looter - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.looter
-
Contains support for adapting objects that represent looting permissions or claims.
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.name - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.name
-
Provides the
Nameableinterface and its corresponding adapter used to extract and format name-related fields from objects passed into the message pipeline. - com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.owner - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.owner
-
Provides support for extracting ownership information from objects and applying it to macro placeholders.
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.pluralname - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.pluralname
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.protection - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.protection
-
Provides support for adapting objects with time-based protection attributes into macro string values.
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.quantity - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.quantity
-
Provides support for macro replacement of quantity-related values.
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.url - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.url
-
Provides an adapter for objects that expose a
com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.url. - com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.version - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.version
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.cooldown - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.cooldown
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration
-
Provides formatting for
Durationvalues into localized, human-readable strings. - com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.number - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.number
-
Provides locale-aware number formatting for use in the message-building pipeline.
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.matchers - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.matchers
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.processors - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.processors
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.replacers - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.replacers
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.itemname - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.itemname
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.spawnlocation - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.spawnlocation
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.value - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.value
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.worldname - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.worldname
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.spawnlocation - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.spawnlocation
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.worldname - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.worldname
- com.winterhavenmc.library.messagebuilder.adapters.pipeline.senders - package com.winterhavenmc.library.messagebuilder.adapters.pipeline.senders
- com.winterhavenmc.library.messagebuilder.adapters.resources - package com.winterhavenmc.library.messagebuilder.adapters.resources
- com.winterhavenmc.library.messagebuilder.adapters.resources.configuration - package com.winterhavenmc.library.messagebuilder.adapters.resources.configuration
- com.winterhavenmc.library.messagebuilder.adapters.resources.language - package com.winterhavenmc.library.messagebuilder.adapters.resources.language
- com.winterhavenmc.library.messagebuilder.adapters.resources.sound - package com.winterhavenmc.library.messagebuilder.adapters.resources.sound
- com.winterhavenmc.library.messagebuilder.core.context - package com.winterhavenmc.library.messagebuilder.core.context
- com.winterhavenmc.library.messagebuilder.core.maps - package com.winterhavenmc.library.messagebuilder.core.maps
-
Provides internal map types used in macro extraction and message formatting.
- com.winterhavenmc.library.messagebuilder.core.message - package com.winterhavenmc.library.messagebuilder.core.message
-
Contains the sealed
Messageinterface and its implementations, which represent composed messages ready for macro substitution and delivery. - com.winterhavenmc.library.messagebuilder.core.ports.pipeline - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline
-
Provides the core processing components of the message pipeline.
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors
-
Provides mechanisms for extracting macro-compatible string values from objects that have been adapted by the
Accessorsystem. - com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.duration - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.duration
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.expiration - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.expiration
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.identity - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.identity
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.instant - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.instant
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.killer - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.killer
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.looter - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.looter
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.name - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.name
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.owner - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.owner
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.pluralname - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.pluralname
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.protection - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.protection
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.quantity - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.quantity
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.url - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.url
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.version - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.version
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.cooldown - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.cooldown
-
Provides support for message rate limiting through a cooldown mechanism.
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters
-
Contains formatters responsible for converting data types into localized, human-readable strings.
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.duration - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.duration
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.number - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.number
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.matchers - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.matchers
-
Provides utilities for identifying macro placeholders within message strings.
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.processors - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.processors
-
Defines the final stage in the message processing pipeline, responsible for converting a structured
ValidMessageRecordinto a fully resolvedFinalMessageRecord. - com.winterhavenmc.library.messagebuilder.core.ports.pipeline.replacers - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.replacers
-
Contains interfaces and classes responsible for replacing macros in message strings using resolved values from a
MacroObjectMap. - com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.itemname - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.itemname
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.macro - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.macro
-
Provides a hierarchy of
ValueResolverimplementations responsible for converting macro-related input values into string representations for use in templated messages. - com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.spawnlocation - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.spawnlocation
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.worldname - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.worldname
-
Provides integration with external world-aliasing systems, such as Multiverse-Core, for resolving user-friendly world names to be used in macro-based message templates.
- com.winterhavenmc.library.messagebuilder.core.ports.pipeline.retrievers - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.retrievers
-
Defines the entry point to the message pipeline, responsible for retrieving
MessageRecordinstances from a configuration-backed query system. - com.winterhavenmc.library.messagebuilder.core.ports.pipeline.senders - package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.senders
-
Defines the final dispatch stage in the message pipeline, responsible for delivering resolved and formatted messages to recipients.
- com.winterhavenmc.library.messagebuilder.core.ports.resources - package com.winterhavenmc.library.messagebuilder.core.ports.resources
-
This package contains packages that pertain to resources and their handlers.
- com.winterhavenmc.library.messagebuilder.core.ports.resources.language - package com.winterhavenmc.library.messagebuilder.core.ports.resources.language
-
This package encapsulates the handling and querying of a language resource.
- com.winterhavenmc.library.messagebuilder.core.ports.resources.sound - package com.winterhavenmc.library.messagebuilder.core.ports.resources.sound
- com.winterhavenmc.library.messagebuilder.models - package com.winterhavenmc.library.messagebuilder.models
-
This package contains data structure models used in the library.
- com.winterhavenmc.library.messagebuilder.models.configuration - package com.winterhavenmc.library.messagebuilder.models.configuration
-
Provides configuration accessors for server-defined language, locale, and timezone settings.
- com.winterhavenmc.library.messagebuilder.models.keys - package com.winterhavenmc.library.messagebuilder.models.keys
-
This package contains the StandardKey interface and implementations
- com.winterhavenmc.library.messagebuilder.models.language - package com.winterhavenmc.library.messagebuilder.models.language
-
Provides interfaces and data models that represent entries from the plugin's language YAML file.
- com.winterhavenmc.library.messagebuilder.models.recipient - package com.winterhavenmc.library.messagebuilder.models.recipient
-
Contains a sealed model hierarchy representing classified message recipients in a Bukkit-based command or messaging context.
- com.winterhavenmc.library.messagebuilder.models.sound - package com.winterhavenmc.library.messagebuilder.models.sound
- com.winterhavenmc.library.messagebuilder.models.time - package com.winterhavenmc.library.messagebuilder.models.time
- com.winterhavenmc.library.messagebuilder.models.validation - package com.winterhavenmc.library.messagebuilder.models.validation
-
Provides a flexible, localized validation framework for use within the MessageBuilder library.
- COMMAND_SENDER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- compose(CommandSender, E) - Method in class com.winterhavenmc.library.messagebuilder.MessageBuilder
-
Initiate the message building sequence.
- CompositeResolver - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.value
-
A
ValueResolverimplementation that handles complex or structured objects by applying one or more matchingAccessorinstances. - CompositeResolver(AccessorRegistry, MacroFieldAccessor) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.value.CompositeResolver
-
Constructs a
CompositeResolverwith the given adapter registry and field extractor. - Compound-field Adapters - Search tag in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- Section
- config() - Method in class com.winterhavenmc.library.messagebuilder.MessageBuilder
-
Provides external access to the config repository
- CONFIG_LANGUAGE_KEY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.language.LanguageConfigConstant
- CONFIG_LOCALE_KEY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.language.LanguageConfigConstant
- ConfigProvider<T> - Interface in com.winterhavenmc.library.messagebuilder.models.configuration
-
Represents a functional interface for retrieving dynamic configuration values.
- configRepository() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.FormatterCtx
-
Returns the value of the
configRepositoryrecord component. - ConfigRepository - Interface in com.winterhavenmc.library.messagebuilder.models.configuration
- CONFIGURATION_SUPPLIER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- ConfigurationProvider - Interface in com.winterhavenmc.library.messagebuilder.core.ports.resources
- CONSTANT_ENTRY_MISSING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
- CONSTANT_KEY_INVALID - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
- CONSTANT_SECTION_MISSING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
- ConstantKey - Interface in com.winterhavenmc.library.messagebuilder.models.keys
-
A type that represents a validated string for a record.
- ConstantRecord - Interface in com.winterhavenmc.library.messagebuilder.models.language
-
A sealed interface representing a string–value pair loaded from the
CONSTANTSsection of a language YAML file. - ConstantRepository - Interface in com.winterhavenmc.library.messagebuilder.core.ports.resources.language
- constants() - Method in class com.winterhavenmc.library.messagebuilder.MessageBuilder
-
Provides external access to the constant repository
- CONSTANTS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.Section
- contains(UUID) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitWorldRepository
-
check if uuid is present in the registry
- contains(UUID) - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.WorldRepository
-
check if uuid is present in the registry
- containsKey(ValidMacroKey) - Method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroStringMap
-
Returns
trueif this map contains the specified string. - CONTEXT_MAP - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- convert(long, TimeUnit) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- CooldownKey - Class in com.winterhavenmc.library.messagebuilder.models.keys
-
An implementation of a string for use in the cooldown map.
- cooldownMap() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessagePipelineCtx
-
Returns the value of the
cooldownMaprecord component. - CooldownMap - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.cooldown
-
A functional interface representing a cooldown check for a given string.
- Core Concepts - Search tag in package com.winterhavenmc.library.messagebuilder.models.validation
- Section
- create(ValidConstantKey, Object) - Static method in class com.winterhavenmc.library.messagebuilder.models.language.ValidConstantRecord
-
Creates a
ValidConstantRecordfrom the provided string and value. - create(ValidItemKey, ConfigurationSection) - Static method in class com.winterhavenmc.library.messagebuilder.models.language.ValidItemRecord
-
Creates a
ValidItemRecordfrom a configuration section. - create(ValidMessageKey, ConfigurationSection) - Static method in class com.winterhavenmc.library.messagebuilder.models.language.ValidMessageRecord
-
Creates a
ValidMessageRecordfrom a YAML configuration section. - create(Plugin) - Static method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitConfigRepository
-
Factory method to construct a
LocaleProviderusing a plugin's configuration. - create(Plugin) - Static method in class com.winterhavenmc.library.messagebuilder.MessageBuilder
-
A static factory method for instantiating this class.
- create(Plugin, WorldNameResolver, SpawnLocationResolver) - Static method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitWorldRepository
-
Static factory method creates instance of WorldRepository
- createItem(ValidItemKey) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlItemRepository
- createItem(ValidItemKey) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ItemRepository
- createItem(ValidItemKey, int) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlItemRepository
- createItem(ValidItemKey, int) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ItemRepository
- createItem(ValidItemKey, int, Map<String, String>) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlItemRepository
- createItem(ValidItemKey, int, Map<String, String>) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ItemRepository
- createSenders(Plugin, MessageCooldownMap, SoundRepository) - Static method in class com.winterhavenmc.library.messagebuilder.BootstrapUtility
D
- DAYS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- DEBUG - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.LogLevel
-
A fine-grained debug message.
- DEFAULT_LANGUAGE_TAG - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.language.LanguageConfigConstant
- DefaultResolver - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.spawnlocation
- DefaultResolver - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.worldname
-
Default implementation of
WorldNameResolverthat returns the raw name of aWorldusingWorld#getName(). - DefaultResolver() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.spawnlocation.DefaultResolver
- DefaultResolver() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.worldname.DefaultResolver
- DefaultRetriever - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.spawnlocation
- DefaultRetriever - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.worldname
-
A
WorldNameRetrieverimplementation that retrieves the alias name of aWorldusing the Multiverse-Core API. - DefaultRetriever() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.spawnlocation.DefaultRetriever
- DefaultRetriever() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.worldname.DefaultRetriever
- DefaultSymbol - Enum Class in com.winterhavenmc.library.messagebuilder.models
- DELEGATE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- Delimiter - Enum Class in com.winterhavenmc.library.messagebuilder.models
-
An Enum containing the placeholder delimiters
- DEPENDENCY_CONTEXT - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- Design and Behavior - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.cooldown
- Section
- Design Highlights - Search tag in package com.winterhavenmc.library.messagebuilder
- Section
- Design Notes - Search tag in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor
- Section
- Design Notes - Search tag in package com.winterhavenmc.library.messagebuilder.models.language
- Section
- Design Overview - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.macro
- Section
- DisabledWorldsSetting - Record Class in com.winterhavenmc.library.messagebuilder.models.configuration
- DisabledWorldsSetting(List<String>) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.configuration.DisabledWorldsSetting
-
Creates an instance of a
DisabledWorldsSettingrecord class. - DISPLAY_NAME - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- DISPLAY_NAME - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.ItemRecord.Field
- displayName() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidItemRecord
- displayName(ValidItemKey) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlItemRepository
- displayName(ValidItemKey) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ItemRepository
- DisplayNameable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname
-
An interface representing objects that expose a display name for macro replacement.
- DisplayNameAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.displayname
-
Accessor implementation for extracting display names from supported object types.
- DisplayNameAdapter(AccessorCtx) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.displayname.DisplayNameAdapter
-
Constructs a new
DisplayNameAdapterwith the given context container. - duration() - Method in record class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.duration.BoundedDuration
-
Returns the value of the
durationrecord component. - DURATION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- DURATION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- Durationable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.duration
-
Represents an object that exposes a
Duration, enabling it to participate in macro substitution using duration-based placeholders. - DurationAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.duration
-
Accessor for objects that expose a
Durationvia theDurationableinterface. - DurationAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.duration.DurationAdapter
- durationFormatter() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.FormatterCtx
-
Returns the value of the
durationFormatterrecord component. - DurationFormatter - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.duration
-
Formats
Durationvalues into localized human-readable strings. - DurationType - Enum Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration
-
Enumeration representing the classification of a
Durationfor use in formatting logic and conditional display of duration-related values. - durationUntil(Instant) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.duration.Durationable
-
Computes the duration from the current moment until the given
Instant.
E
- empty() - Static method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroStringMap
-
Returns a new, empty
MacroStringMap. - empty() - Static method in record class com.winterhavenmc.library.messagebuilder.core.message.InvalidMessage
-
Returns a reusable
InvalidMessageinstance representing an empty message caused by anullrecipient passed to thecompose()method. - empty() - Static method in interface com.winterhavenmc.library.messagebuilder.core.message.Message
-
Returns an empty
Messageinstance that performs no action when sent. - empty(RecordKey, InvalidRecordReason) - Static method in interface com.winterhavenmc.library.messagebuilder.models.language.ConstantRecord
-
Returns an
InvalidConstantRecordrepresenting a missing or null constant entry. - empty(RecordKey, InvalidRecordReason) - Static method in interface com.winterhavenmc.library.messagebuilder.models.language.ItemRecord
-
Returns an
InvalidItemRecordrepresenting a missing or unresolved item section. - empty(RecordKey, InvalidRecordReason) - Static method in interface com.winterhavenmc.library.messagebuilder.models.language.MessageRecord
-
Returns an
InvalidMessageRecordrepresenting a missing or invalid message definition. - enabled() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns the value of the
enabledrecord component. - enabled() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidMessageRecord
- enabled() - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.ValidSoundRecord
-
Returns the value of the
enabledrecord component. - ENABLED - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.MessageRecord.Field
- ENABLED_WORLDS_PROVIDER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- enabledNames() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitWorldRepository
- enabledNames() - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.WorldRepository
-
get collection of enabled world names from registry
- enabledUids() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitWorldRepository
- enabledUids() - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.WorldRepository
-
Returns a list of world uuids that are enabled by the plugin config.
- EnabledWorldsSetting - Record Class in com.winterhavenmc.library.messagebuilder.models.configuration
- EnabledWorldsSetting(List<UUID>) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.configuration.EnabledWorldsSetting
-
Creates an instance of a
EnabledWorldsSettingrecord class. - ENTITY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- entrySet() - Method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroStringMap
-
Returns the set of string-value entries in this map.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.core.context.AccessorCtx
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.core.context.FormatterCtx
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessageCtx
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessagePipelineCtx
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.core.message.InvalidMessage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.duration.BoundedDuration
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.DisabledWorldsSetting
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.EnabledWorldsSetting
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.LanguageSetting
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.LocaleSetting
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.winterhavenmc.library.messagebuilder.models.keys.CooldownKey
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidConstantKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidItemKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidMessageKey
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidConstantKey
- equals(Object) - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidItemKey
- equals(Object) - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidMacroKey
- equals(Object) - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidMessageKey
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidConstantRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidItemRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidMessageRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidConstantRecord
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Invalid
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Proxied
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Valid
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.InvalidSoundRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.ValidSoundRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.validation.Logging
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.models.validation.Throwing
-
Indicates whether some other object is "equal to" this one.
- ERROR - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.LogLevel
-
A serious error that should be brought to immediate attention.
- ErrorMessageKey - Enum Class in com.winterhavenmc.library.messagebuilder.models.validation
-
Enumeration of structured keys used to identify localized error messages for validation and configuration-related exceptions.
- Example - Search tag in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor
- Section
- exceptionSupplier() - Method in record class com.winterhavenmc.library.messagebuilder.models.validation.Throwing
-
Returns the value of the
exceptionSupplierrecord component. - Expirable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.expiration
-
Provides an adapter for objects that expose an expiration
Instant. - EXPIRATION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- ExpirationAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.expiration
-
Accessor for objects that implement the
Expirableinterface. - ExpirationAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.expiration.ExpirationAdapter
- extract(ValidMacroKey, Accessor, T) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.MacroFieldAccessor
-
Extracts macro string values from the adapted object using the accessor's corresponding interface, such as
NameableorLocatable. - extract(ValidMacroKey, Accessor, T) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.FieldAccessor
-
Extracts a set of macro string values from an adapted object and returns a map of placeholder keys to replacement strings.
- extractDisplayName(ValidMacroKey, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname.DisplayNameable
-
Extracts a
MacroStringMapcontaining the formatted display name under theDISPLAY_NAMEsubkey of the given base string. - extractDuration(ValidMacroKey, ChronoUnit, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.duration.Durationable
-
Extracts a
MacroStringMapcontaining a single entry mapping the providedValidMacroKey(with.DURATIONappended) to a localized string representation of this object's duration. - extractExpiration(ValidMacroKey, ChronoUnit, FormatStyle, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.expiration.Expirable
-
Extracts macro string-value pairs for this object's expiration, including a formatted duration and a formatted instant string.
- extractInstant(ValidMacroKey, FormatStyle, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.instant.Instantable
-
Extracts a formatted timestamp field from this
Instantable, based on the givenFormatStyleand locale context. - extractKiller(ValidMacroKey, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.killer.Killable
-
Extracts a macro string map with the killer's name, using the given base string and context.
- extractLocation(ValidMacroKey, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable
-
Extracts macro string-value pairs representing location data from this object.
- extractLooter(ValidMacroKey, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.looter.Lootable
-
Extracts the looter's name as a macro replacement field.
- extractName(ValidMacroKey, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.name.Nameable
-
Extracts the name field into a
MacroStringMap, using the provided base string to construct a dot-notated macro string (e.g.,OBJECT.NAME). - extractOwner(ValidMacroKey, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.owner.Ownable
-
Extracts the macro value for the owner's name and adds it to a
MacroStringMap, using the{OBJECT.OWNER}string. - extractPluralName(ValidMacroKey, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.pluralname.PluralNameable
-
Extracts a
MacroStringMapcontaining the formatted plural name under thePLURAL_NAMEsubkey of the given base string. - extractProtection(ValidMacroKey, ChronoUnit, FormatStyle, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.protection.Protectable
-
Extracts protection-related fields from this object into a
MacroStringMap. - extractQuantity(ValidMacroKey, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.quantity.Quantifiable
-
Extracts a
MacroStringMapcontaining the formatted quantity string. - extractUid(ValidMacroKey, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.identity.Identifiable
-
Extracts a macro string map containing the UUID field.
- extractUrl(ValidMacroKey, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.url.UrlAddressable
- extractVersion(ValidMacroKey, AccessorCtx) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.version.Versionable
F
- Factory Methods - Search tag in interface com.winterhavenmc.library.messagebuilder.models.language.MessageRecord
- Section
- FAIL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceInstaller.InstallerStatus
- Fallback Behavior - Search tag in package com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration
- Section
- FieldAccessor - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors
-
Functional interface representing a strategy for extracting macro-replaceable fields from an object that has been successfully adapted by a given
Accessor. - FieldAccessorRegistry - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors
-
Maintains an ordered registry of all
Accessorinstances available to the macro resolution pipeline. - FieldAccessorRegistry(AccessorCtx) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.FieldAccessorRegistry
-
Constructs an
AccessorRegistryand registers all built-in accessors in preferred priority order. - FILE_EXISTS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceInstaller.InstallerStatus
- FinalMessageRecord - Record Class in com.winterhavenmc.library.messagebuilder.models.language
-
A
MessageRecordrepresenting a fully constructed, macro-resolved message ready for delivery to a recipient. - FinalMessageRecord(ValidMessageKey, boolean, String, Duration, String, Duration, Duration, Duration, String, Optional<String>, Optional<String>, Optional<String>) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Creates an instance of a
FinalMessageRecordrecord class. - finalMessageString() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns the value of the
finalMessageStringrecord component. - finalSubtitleString() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns the value of the
finalSubtitleStringrecord component. - finalTitleString() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns the value of the
finalTitleStringrecord component. - Fluent Macro Assignment - Search tag in interface com.winterhavenmc.library.messagebuilder.core.message.Message
- Section
- format(Number) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.number.LocaleNumberFormatter
-
Formats the specified number using the
NumberFormatinstance associated with the locale provided by theConfigRepository. - format(Number) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.number.NumberFormatter
-
Formats the provided
Numberusing a locale-specific format. - format(Duration, ChronoUnit) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration.LocalizedDurationFormatter
-
Formats a
Durationinto a localized string, applying special handling for unlimited or too-small durations. - format(Duration, ChronoUnit) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration.Time4jDurationFormatter
-
Formats a
Durationusing Time4J'sPrettyTimeengine. - format(Duration, ChronoUnit) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.duration.DurationFormatter
- formatDisplayName(String) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname.DisplayNameable
-
Attempts to format and return a display name if valid.
- formatDuration(Duration, ChronoUnit, DurationFormatter) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.duration.Durationable
-
Uses the configured
DurationFormatterto format the givenDurationaccording to the specified precision. - formatInstant(Instant, FormatStyle, ConfigRepository) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.instant.Instantable
-
Formats the provided
Instantusing the specifiedFormatStyleand locale. - formatKiller(AnimalTamer) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.killer.Killable
-
Formats the killer name for use in placeholder replacement.
- formatLocation(Location, AccessorCtx) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable
-
Produces a formatted string representation of the given location, consisting of the world name followed by localized coordinates.
- formatLooter(AnimalTamer) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.looter.Lootable
-
Formats the looter name for placeholder substitution.
- formatMessage(ErrorMessageKey, Parameter) - Static method in interface com.winterhavenmc.library.messagebuilder.models.validation.Validator
-
Formats a localized error message using the specified string and parameter.
- formatName(String) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.name.Nameable
-
Formats the given name string, returning it as an
Optionalif valid. - formatOwner(AnimalTamer) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.owner.Ownable
-
Returns a formatted string representing the owner's name, if available and valid.
- formatPluralName(String) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.pluralname.PluralNameable
-
Attempts to format and return a plural name if valid.
- formatQuantity(int, NumberFormatter) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.quantity.Quantifiable
-
Converts a raw integer quantity into a localized string using the provided number formatter.
- FORMATTER_CONTAINER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- formatterCtx() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.AccessorCtx
-
Returns the value of the
formatterCtxrecord component. - FormatterCtx - Record Class in com.winterhavenmc.library.messagebuilder.core.context
- FormatterCtx(ConfigRepository, DurationFormatter, NumberFormatter) - Constructor for record class com.winterhavenmc.library.messagebuilder.core.context.FormatterCtx
-
Creates an instance of a
FormatterCtxrecord class. - formatUid(UUID) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.identity.Identifiable
-
Returns an optional string representation of a UUID.
- formatVersion(String) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.url.UrlAddressable
- formatVersion(String) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.version.Versionable
- FULL_KEY_PATTERN - Static variable in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.replacers.RegexMacroReplacer
-
Pattern used to match fully qualified macro placeholders (e.g.,
%ITEM.NAME_SINGULAR%) for the purpose of final string replacement.
G
- get() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitConfigRepository
-
Returns the resolved
LocaleSettingbased on the plugin configuration. - get() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitWorldRepository
- get() - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.ConfigProvider
- get() - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.ConfigRepository
-
Returns the resolved
LocaleSettingbased on the plugin configuration. - get() - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.LanguageProvider
-
Returns the current
LanguageSetting. - get() - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.WorldRepository
-
Returns the current
EnabledWorldsSetting. - get(MacroKey) - Method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroObjectMap
-
Retrieves the value associated with the specified
MacroKey, if present. - get(ValidMacroKey) - Method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroStringMap
-
Returns the value associated with the given string, or
nullif not found. - get(PluginManager) - Static method in interface com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.spawnlocation.BukkitSpawnLocationResolver
- getAutoInstallResourceName() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceInstaller
-
Get path name of the auto install resource
- getAutoInstallSet(String) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceInstaller
-
Retrieve a
Setof resources to be copied into the plugin data directory by reading resource names from the auto-install.txt resource. - getBase() - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidMacroKey
- getBoolean(ValidConstantKey) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlConstantRepository
- getBoolean(ValidConstantKey) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ConstantRepository
- getBukkitSoundName(String) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundRepository
-
Get bukkit sound name for sound config file key
- getBukkitSoundName(String) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.sound.SoundRepository
-
Get bukkit sound name for sound config file key
- getConfiguration() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageConfigurationProvider
- getConfiguration() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundConfigurationProvider
- getConfiguration() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.ConfigurationProvider
- getConfigurationProvider() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceManager
- getConfigurationProvider() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundResourceManager
- getConfigurationProvider() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceManager
- getConfiguredLanguageTag() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceLoader
-
Gets language tag specified in config.yml.
- getConfiguredLocale() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceLoader
- getDefaultMessage() - Method in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- getDefaultMessage() - Method in enum class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKeyReason
- getDefaultMessage() - Method in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
- getDisplayName() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname.DisplayNameable
-
Returns the display name associated with this object.
- getDisplayName() - Method in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
-
Returns the canonical display name for this parameter, as used in localized error messages.
- getDuration() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.duration.Durationable
-
Returns the duration value associated with this object.
- getDuration() - Method in class com.winterhavenmc.library.messagebuilder.models.time.Tick
- getExpiration() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.expiration.Expirable
-
Returns the expiration timestamp for this object.
- getFileName(LanguageTag) - Static method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceManager
-
Retrieve the name of the potential language resource file as installed in the plugin data directory, as a Section.
- getInstant() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.instant.Instantable
-
Returns the
Instantthat this object represents. - getInteger(ValidConstantKey) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlConstantRepository
- getInteger(ValidConstantKey) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ConstantRepository
- getItemKeyString(ItemStack) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlItemRepository
- getKeys() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundRepository
- getKeys() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.sound.SoundRepository
-
get all keys from the sound configuration
- getKiller() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.killer.Killable
-
Returns the killer of this object, typically a
Player. - getLocale() - Method in class com.winterhavenmc.library.messagebuilder.models.configuration.LanguageTag
-
Retrieve the
Localeassociated with this language tag - getLocale() - Static method in class com.winterhavenmc.library.messagebuilder.models.validation.ValidationContext
-
Returns the current locale used for formatting validation messages.
- getLocalizedMessage(Locale) - Method in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- getLocalizedMessage(Locale) - Method in enum class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKeyReason
- getLocalizedMessage(Locale) - Method in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
- getLocalizedMessage(Locale, Object...) - Method in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- getLocalizeMessage(Locale, Object...) - Method in enum class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKeyReason
- getLocalizeMessage(Locale, Object...) - Method in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
- getLocation() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable
-
Returns the Bukkit
Locationassociated with this object. - getLocationWorldName(Location, AccessorCtx) - Static method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable
-
Resolves the name of the world for the given
Location. - getLooter() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.looter.Lootable
-
Returns the looter or claimant entity who has permission to access the lootable object.
- getMatchingAdapters(Object) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.FieldAccessorRegistry
-
Returns a stream of all registered
Accessorinstances that support the given object. - getMatchingAdapters(Object) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.AccessorRegistry
-
Returns a stream of all registered
Accessorinstances that support the given object. - getMessage() - Method in exception class com.winterhavenmc.library.messagebuilder.models.validation.ValidationException
-
Returns the localized message for this validation exception.
- getMessageKey() - Method in record class com.winterhavenmc.library.messagebuilder.core.message.InvalidMessage
- getMessageKey() - Method in interface com.winterhavenmc.library.messagebuilder.core.message.Message
-
Returns the
ValidMessageKeyidentifying the message template used in composition. - getMessageKey() - Method in class com.winterhavenmc.library.messagebuilder.core.message.ValidMessage
- getMessageKey() - Method in class com.winterhavenmc.library.messagebuilder.models.keys.CooldownKey
-
Retrieve the message string used for this cooldown string
- getMillis() - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
-
Get the number of milliseconds for each time unit.
- getName() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.name.Nameable
-
Returns the name associated with the implementing object.
- getName() - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.LanguageProvider
-
Returns the configured language file name string (e.g.,
en-US). - getObjectMap() - Method in record class com.winterhavenmc.library.messagebuilder.core.message.InvalidMessage
- getObjectMap() - Method in interface com.winterhavenmc.library.messagebuilder.core.message.Message
-
Returns the
MacroObjectMapof macro values bound to this message. - getObjectMap() - Method in class com.winterhavenmc.library.messagebuilder.core.message.ValidMessage
- getOwner() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.owner.Ownable
-
Returns the
AnimalTamerrepresenting the owner of this object. - getPluralName() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.pluralname.PluralNameable
-
Returns the display name associated with this object.
- getProtection() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.protection.Protectable
-
Returns the protection
Instant, representing the moment at which protection ends or expires. - getQuantity() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.quantity.Quantifiable
-
Returns the numeric quantity associated with this object.
- getRecipient() - Method in record class com.winterhavenmc.library.messagebuilder.core.message.InvalidMessage
- getRecipient() - Method in interface com.winterhavenmc.library.messagebuilder.core.message.Message
-
Returns the
Recipient.Sendableto whom the message will be sent. - getRecipient() - Method in class com.winterhavenmc.library.messagebuilder.core.message.ValidMessage
- getRecord(ValidItemKey) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlItemRepository
- getRecord(ValidItemKey) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ItemRecordRepository
- getRecord(ValidItemKey) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ItemRepository
-
Deprecated.
- getRecord(ValidMessageKey) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.LocalizedMessageRetriever
-
Retrieves a
MessageRecord - getRecord(ValidMessageKey) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlMessageRepository
- getRecord(ValidMessageKey) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.retrievers.MessageRetriever
- getRecord(ValidMessageKey) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.MessageRepository
- getRecord(Enum<?>) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundRepository
- getRecord(Enum<?>) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.sound.SoundRepository
- getRecord(String) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundRepository
- getResourceName(LanguageTag) - Static method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceManager
-
Constructs the resource path (in the JAR) for a given language tag, e.g.
- getSection() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageSectionProvider
- getSection() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundSectionProvider
- getSection() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.SectionProvider
- getSectionProvider(String) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceManager
-
Retrieve the configuration provider, a container that carries the current configuration
- getSectionProvider(String) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundResourceManager
- getSectionProvider(String) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceManager
- getSpawnLocation(World) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.spawnlocation.DefaultRetriever
- getSpawnLocation(World) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.spawnlocation.MultiverseRetriever
- getSpawnLocation(World) - Method in interface com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.spawnlocation.SpawnLocationRetriever
- getString(ValidConstantKey) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlConstantRepository
- getString(ValidConstantKey) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ConstantRepository
- getStringList(ValidConstantKey) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlConstantRepository
- getStringList(ValidConstantKey) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ConstantRepository
- getSystemDefault() - Static method in class com.winterhavenmc.library.messagebuilder.models.configuration.LanguageTag
-
Get the system default locale expressed as a LanguageTag
- getUniqueId() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.identity.Identifiable
-
Returns the unique ID for this object.
- getUrl() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.url.UrlAddressable
- getVersion() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.version.Versionable
- getWorldName(World) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.worldname.DefaultRetriever
-
Attempts to retrieve the alias name of the given
Worldusing the Multiverse world manager. - getWorldName(World) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.worldname.MultiverseRetriever
-
Attempts to retrieve the alias or name of the given
Worldusing the Multiverse world manager. - getWorldName(World) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.worldname.WorldNameRetriever
H
- handleInvalid(T) - Method in record class com.winterhavenmc.library.messagebuilder.models.validation.Logging
-
Logs a validation failure using the specified log level and message, but continues execution by returning the original value.
- handleInvalid(T) - Method in record class com.winterhavenmc.library.messagebuilder.models.validation.Throwing
-
Throws the supplied exception when the value is invalid.
- handleInvalid(T) - Method in interface com.winterhavenmc.library.messagebuilder.models.validation.Validator
-
Handles an invalid value detected during validation.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.AccessorCtx
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.FormatterCtx
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessageCtx
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessagePipelineCtx
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.core.message.InvalidMessage
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.duration.BoundedDuration
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.DisabledWorldsSetting
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.EnabledWorldsSetting
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.LanguageSetting
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.LocaleSetting
-
Returns a hash code value for this object.
- hashCode() - Method in class com.winterhavenmc.library.messagebuilder.models.keys.CooldownKey
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidConstantKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidItemKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKey
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidMessageKey
-
Returns a hash code value for this object.
- hashCode() - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidConstantKey
- hashCode() - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidItemKey
- hashCode() - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidMacroKey
- hashCode() - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidMessageKey
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidConstantRecord
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidItemRecord
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidMessageRecord
-
Returns a hash code value for this object.
- hashCode() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidConstantRecord
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Invalid
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Proxied
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Valid
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.InvalidSoundRecord
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.ValidSoundRecord
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.validation.Logging
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.models.validation.Throwing
-
Returns a hash code value for this object.
- HOURS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
I
- Identifiable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.identity
-
Represents an object that exposes a unique
UUID. - Immutability and Thread Safety - Search tag in package com.winterhavenmc.library.messagebuilder.core.maps
- Section
- Implementations - Search tag in interface com.winterhavenmc.library.messagebuilder.models.language.ConstantRecord
- Section
- Implementations - Search tag in interface com.winterhavenmc.library.messagebuilder.models.language.ItemRecord
- Section
- Implementations - Search tag in interface com.winterhavenmc.library.messagebuilder.models.language.MessageRecord
- Section
- Implementations - Search tag in package com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration
- Section
- INFO - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.LogLevel
-
A standard informational message.
- initialize(ConfigRepository) - Static method in class com.winterhavenmc.library.messagebuilder.models.validation.ValidationContext
-
Initializes the validation context with the provided locale source.
- initiate(ValidMessage) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.MessagePipeline
- initiate(ValidMessage) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.Pipeline
- install() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceInstaller
-
Install resources listed in auto_install.txt to the plugin data directory
- install() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundResourceInstaller
- install() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceInstaller
-
Install resources listed in auto_install.txt to the plugin data directory
- installByName(String) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceInstaller
-
Install resource from plugin jar to plugin data directory.
- installIfMissing(String) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceInstaller
-
Check if a resource is already present in the plugin data directory
- installResources() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceManager
-
Installs any language resource files listed in auto-install.txt if they are not already installed.
- installResources() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundResourceManager
-
Installs sound resource files if not already present in the plugin data folder
- installResources() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceManager
-
Installs any language resource files listed in auto-install.txt if they are not already installed.
- INSTANT - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- Instantable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.instant
-
An interface for types that expose a single
Instantvalue, such as a timestamp for creation, expiration, modification, or other moments in time. - InstantAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.instant
-
An adapter that supports any object implementing the
Instantableinterface. - InstantAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.instant.InstantAdapter
- Invalid(CommandSender, Recipient.InvalidReason) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Invalid
-
Creates an instance of a
Invalidrecord class. - INVALID_SECTION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.ErrorMessageKey
-
Indicates that a required configuration section is invalid or missing.
- InvalidConstantKey - Record Class in com.winterhavenmc.library.messagebuilder.models.keys
- InvalidConstantKey(String, InvalidKeyReason) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidConstantKey
-
Creates an instance of a
InvalidConstantKeyrecord class. - InvalidConstantRecord - Record Class in com.winterhavenmc.library.messagebuilder.models.language
-
A
ConstantRecordrepresenting a missing or invalid constant from theCONSTANTSsection of a language YAML file. - InvalidConstantRecord(RecordKey, InvalidRecordReason) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.language.InvalidConstantRecord
-
Creates an instance of a
InvalidConstantRecordrecord class. - InvalidItemKey - Record Class in com.winterhavenmc.library.messagebuilder.models.keys
- InvalidItemKey(String, InvalidKeyReason) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidItemKey
-
Creates an instance of a
InvalidItemKeyrecord class. - InvalidItemRecord - Record Class in com.winterhavenmc.library.messagebuilder.models.language
-
An
ItemRecordrepresenting a missing or invalid item entry from theITEMSsection of a language YAML file. - InvalidItemRecord(RecordKey, InvalidRecordReason) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.language.InvalidItemRecord
-
Creates an instance of a
InvalidItemRecordrecord class. - InvalidKey - Record Class in com.winterhavenmc.library.messagebuilder.models.keys
- InvalidKey(String, InvalidKeyReason) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKey
-
Creates an instance of a
InvalidKeyrecord class. - InvalidKeyReason - Enum Class in com.winterhavenmc.library.messagebuilder.models.keys
- InvalidMessage - Record Class in com.winterhavenmc.library.messagebuilder.core.message
-
A fallback
Messageimplementation representing an invalid or unrenderable message. - InvalidMessage(String) - Constructor for record class com.winterhavenmc.library.messagebuilder.core.message.InvalidMessage
-
Creates an instance of a
InvalidMessagerecord class. - InvalidMessageKey - Record Class in com.winterhavenmc.library.messagebuilder.models.keys
- InvalidMessageKey(String, InvalidKeyReason) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidMessageKey
-
Creates an instance of a
InvalidMessageKeyrecord class. - InvalidMessageRecord - Record Class in com.winterhavenmc.library.messagebuilder.models.language
-
A
MessageRecordrepresenting a missing or invalid entry from theMESSAGESsection of a language file. - InvalidMessageRecord(RecordKey, InvalidRecordReason) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.language.InvalidMessageRecord
-
Creates an instance of a
InvalidMessageRecordrecord class. - invalidReason() - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Invalid
-
Returns the value of the
invalidReasonrecord component. - InvalidRecordReason - Enum Class in com.winterhavenmc.library.messagebuilder.models.language
- InvalidSoundRecord - Record Class in com.winterhavenmc.library.messagebuilder.models.sound
- InvalidSoundRecord(String, String) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.sound.InvalidSoundRecord
-
Creates an instance of a
InvalidSoundRecordrecord class. - IS_INVALID_KEY - Static variable in interface com.winterhavenmc.library.messagebuilder.models.keys.StandardKey
- isDateBased() - Method in class com.winterhavenmc.library.messagebuilder.models.time.Tick
- isDurationEstimated() - Method in class com.winterhavenmc.library.messagebuilder.models.time.Tick
- isEmpty() - Method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroStringMap
-
Returns
trueif this map is empty. - isEnabled(String) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitWorldRepository
-
Check if a world is enabled by name
- isEnabled(String) - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.WorldRepository
-
Check if a world is enabled by name
- isEnabled(UUID) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitWorldRepository
-
Check if a world is enabled by bukkit world UID
- isEnabled(UUID) - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.WorldRepository
-
Check if a world is enabled by bukkit world UID
- isGreaterThan(long) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- isGreaterThan(TimeUnit) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- isItem(ItemStack) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlItemRepository
- isItem(ItemStack) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ItemRepository
- isLessThan(long) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- isLessThan(TimeUnit) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- isLessThan(Duration, ChronoUnit) - Static method in enum class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration.DurationType
-
Checks if the given duration is shorter than the provided precision threshold.
- isRegistrySound(String) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundRepository
- isRegistrySound(String) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.sound.SoundRepository
- isTimeBased() - Method in class com.winterhavenmc.library.messagebuilder.models.time.Tick
- isUnlimited(Duration) - Static method in enum class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration.DurationType
-
Checks if the given duration should be treated as "unlimited" (i.e., negative).
- isValid() - Method in interface com.winterhavenmc.library.messagebuilder.models.keys.ConstantKey
- isValid() - Method in interface com.winterhavenmc.library.messagebuilder.models.keys.ItemKey
- isValid() - Method in interface com.winterhavenmc.library.messagebuilder.models.keys.MacroKey
- isValid() - Method in interface com.winterhavenmc.library.messagebuilder.models.keys.MessageKey
- isValid() - Method in interface com.winterhavenmc.library.messagebuilder.models.language.ItemRecord
- isValidBukkitSoundName(String) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundRepository
- isValidBukkitSoundName(String) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.sound.SoundRepository
-
Deprecated.
- isValidSoundConfigKey(String) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundRepository
- isValidSoundConfigKey(String) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.sound.SoundRepository
-
Test string is valid sound config key in sounds.yml file
- ITEM_ENTRY_MISSING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
- ITEM_KEY_INVALID - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
- ITEM_SECTION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- ITEM_SECTION_MISSING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
- itemDisplayNameResolver() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.AccessorCtx
-
Returns the value of the
itemDisplayNameResolverrecord component. - ItemDisplayNameResolver - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.itemname
- ItemKey - Interface in com.winterhavenmc.library.messagebuilder.models.keys
-
A type that represents a validated string for a record.
- itemNameResolver() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.AccessorCtx
-
Returns the value of the
itemNameResolverrecord component. - ItemNameResolver - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.itemname
- itemPluralNameResolver() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.AccessorCtx
-
Returns the value of the
itemPluralNameResolverrecord component. - ItemPluralNameResolver - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.itemname
- ItemRecord - Interface in com.winterhavenmc.library.messagebuilder.models.language
-
A sealed interface representing a record loaded from the
ITEMSsection of a language YAML file. - ItemRecord.Field - Enum Class in com.winterhavenmc.library.messagebuilder.models.language
-
Enumeration of field keys within an
ItemRecord, mapping enum constants to their corresponding YAML string paths. - ItemRecordRepository - Interface in com.winterhavenmc.library.messagebuilder.core.ports.resources.language
- ItemRepository - Interface in com.winterhavenmc.library.messagebuilder.core.ports.resources.language
- items() - Method in class com.winterhavenmc.library.messagebuilder.MessageBuilder
-
Provides external access to the item repository
- ITEMS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.Section
J
- justShyOf(int) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
K
- key() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns the value of the
keyrecord component. - key() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidConstantRecord
-
Returns the value of the
keyrecord component. - key() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidItemRecord
-
Returns the value of the
keyrecord component. - key() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidMessageRecord
-
Returns the value of the
keyrecord component. - key() - Method in interface com.winterhavenmc.library.messagebuilder.models.language.SectionRecord
- key() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidConstantRecord
-
Returns the valid key associated with this record.
- key() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidItemRecord
- key() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidMessageRecord
- key() - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.InvalidSoundRecord
-
Returns the value of the
keyrecord component. - key() - Method in interface com.winterhavenmc.library.messagebuilder.models.sound.SoundRecord
- key() - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.ValidSoundRecord
-
Returns the value of the
keyrecord component. - key(ItemStack) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlItemRepository
- key(ItemStack) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ItemRepository
- KEY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- KEY_BLANK - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKeyReason
- KEY_INVALID - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKeyReason
- KEY_NULL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKeyReason
- Key Components - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.matchers
- Section
- Key Components - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.processors
- Section
- Key Components - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.replacers
- Section
- Key Components - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.retrievers
- Section
- Key Components - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.senders
- Section
- Key Components - Search tag in package com.winterhavenmc.library.messagebuilder.models.configuration
- Section
- Key Concepts - Search tag in package com.winterhavenmc.library.messagebuilder
- Section
- keySet() - Method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroStringMap
-
Returns the set of keys contained in this map.
- Killable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.killer
-
An interface for objects that provide information about the entity that killed them.
- KILLER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- KillerAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.killer
-
Accessor that maps supported objects to the
Killableinterface for macro extraction. - KillerAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.killer.KillerAdapter
- KyoriMessageSender - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.senders
-
Sends chat messages to a
Recipient.Sendablebased on the contents of aFinalMessageRecord. - KyoriMessageSender(MessageCooldownMap, MiniMessage, BukkitAudiences, SoundRepository) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.senders.KyoriMessageSender
-
Constructs a
KyoriMessageSenderwith the specified cooldown map for managing message repeat suppression. - KyoriTitleSender - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.senders
-
Sends a title and optional subtitle to a
Playerusing values from aFinalMessageRecord. - KyoriTitleSender(MessageCooldownMap, MiniMessage, BukkitAudiences) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.senders.KyoriTitleSender
-
Constructs a
KyoriTitleSenderusing the specified cooldown map.
L
- language() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitConfigRepository
- language() - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.ConfigRepository
- LANGUAGE_QUERY_HANDLER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- LANGUAGE_RESOURCE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- LANGUAGE_RESOURCE_MANAGER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- LANGUAGE_TAG - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- LanguageConfigConstant - Enum Class in com.winterhavenmc.library.messagebuilder.adapters.resources.language
-
Enum containing constants for various yaml parameters
- LanguageProvider - Interface in com.winterhavenmc.library.messagebuilder.models.configuration
- LanguageSetting - Record Class in com.winterhavenmc.library.messagebuilder.models.configuration
-
Represents a configured language file identifier.
- LanguageSetting(String) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.configuration.LanguageSetting
-
Creates an instance of a
LanguageSettingrecord class. - languageTag() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitConfigRepository
-
Returns the resolved
LanguageTagrepresenting the locale tag. - languageTag() - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.ConfigRepository
-
Returns the resolved
LanguageTagrepresenting the locale tag. - languageTag() - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.LocaleSetting
-
Returns the value of the
languageTagrecord component. - LanguageTag - Class in com.winterhavenmc.library.messagebuilder.models.configuration
-
A class that wraps a string-based IETF BCP 47 language tag, allowing for validation against locales that are known to the system at runtime.
- LEADING_SLASHES - Static variable in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceInstaller
- LEGACY_SERIALIZER - Static variable in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlItemRepository
- LESS_THAN - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration.DurationType
- load() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceLoader
-
Load the language configuration object for the configured language from file and return it.
- load() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundResourceLoader
- load() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceLoader
-
Load the language configuration object for the configured language from file and return it.
- loadFromResource(LanguageTag) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceLoader
-
Loads a language YAML file directly from the JAR resource as a last resort.
- loadFromResource(LanguageTag) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundResourceLoader
-
Loads a language YAML file directly from the JAR resource as a last resort.
- loadWithFallback(LanguageTag, LanguageTag) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceLoader
-
Attempts to load the preferred language file from disk.
- locale() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitConfigRepository
-
Returns the resolved
Localeobject derived from the configuration. - locale() - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.ConfigRepository
-
Returns the
Localeobject derived from the configuration. - locale() - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.LocaleSetting
-
Returns the
Localecorresponding to the encapsulatedLanguageTag. - LOCALE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- LOCALE_PROVIDER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- localeNumberFormatter() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.FormatterCtx
-
Returns the value of the
localeNumberFormatterrecord component. - LocaleNumberFormatter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.number
-
A locale-aware implementation of the
NumberFormatterinterface that formats numeric values using the default number format for the locale provided by aConfigRepository. - LocaleNumberFormatter(ConfigRepository) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.number.LocaleNumberFormatter
-
Constructs a new
LocaleNumberFormatterwith the given locale provider. - LocaleSetting - Record Class in com.winterhavenmc.library.messagebuilder.models.configuration
-
Represents a locale setting derived from a valid
LanguageTag. - LocaleSetting(LanguageTag) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.configuration.LocaleSetting
-
Creates an instance of a
LocaleSettingrecord class. - Localization - Search tag in package com.winterhavenmc.library.messagebuilder.models.validation
- Section
- LocalizedDurationFormatter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration
-
A
DurationFormatterimplementation that localizes duration strings using configurable constants from the language file, while delegating formatting of standard durations to another formatter. - LocalizedDurationFormatter(DurationFormatter, ConstantRepository) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration.LocalizedDurationFormatter
-
Constructs a
LocalizedDurationFormatterwith a backing delegate and query handler factory. - LocalizedMessageRetriever - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers
-
Default implementation of the
MessageRetrieverinterface that retrieves aMessageRecord - LocalizedMessageRetriever(MessageRepository) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.LocalizedMessageRetriever
-
Constructs a
LocalizedMessageRetrieverusing the specified query handler. - Locatable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location
-
Represents an object that has a
Location, which can be extracted and used for macro substitution in messages. - Locatable.Field - Enum Class in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location
-
Enumeration of subfields extractable from a
Location. - LOCATION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- LOCATION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- LocationAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.location
-
Accessor for objects that expose a
Location, either directly or via aLocatableinterface. - LocationAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.location.LocationAdapter
- logging(LogLevel, ErrorMessageKey, Parameter) - Static method in interface com.winterhavenmc.library.messagebuilder.models.validation.Validator
-
Returns a handler that logs a validation warning or error using the specified log level, message string, and parameter.
- Logging<T> - Record Class in com.winterhavenmc.library.messagebuilder.models.validation
-
A
Validatorimplementation that logs a warning or error when a value fails validation, but does not throw. - Logging(LogLevel, ErrorMessageKey, Parameter) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.validation.Logging
-
Creates an instance of a
Loggingrecord class. - logLevel() - Method in record class com.winterhavenmc.library.messagebuilder.models.validation.Logging
-
Returns the value of the
logLevelrecord component. - LogLevel - Enum Class in com.winterhavenmc.library.messagebuilder.models.validation
-
Represents standard log severity levels used for validation feedback and internal diagnostics.
- Lootable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.looter
-
Represents an object that exposes looter or claimant information for permission or access control.
- LOOTER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- LooterAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.looter
-
Accessor that converts supported objects into the
Lootableinterface for macro resolution. - LooterAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.looter.LooterAdapter
- lore() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidItemRecord
- LORE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.ItemRecord.Field
- LOWER_BOUND - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
M
- MACRO - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- MACRO_KEY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- MacroFieldAccessor - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors
-
Default implementation of the
FieldAccessorinterface that delegates field extraction to the appropriate functional interface based on the adapter type. - MacroFieldAccessor(AccessorCtx) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.MacroFieldAccessor
-
Constructs a new
MacroFieldAccessorwith the provided context container. - MacroKey - Interface in com.winterhavenmc.library.messagebuilder.models.keys
- MacroObjectMap - Class in com.winterhavenmc.library.messagebuilder.core.maps
- MacroObjectMap() - Constructor for class com.winterhavenmc.library.messagebuilder.core.maps.MacroObjectMap
- MacroReplacer - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.replacers
-
A functional interface representing a macro replacement engine that substitutes placeholder values within a message string using data from a
MacroObjectMap. - MacroStringMap - Class in com.winterhavenmc.library.messagebuilder.core.maps
-
A specialized map for storing string macro values keyed by
ValidMacroKey. - MacroStringMap() - Constructor for class com.winterhavenmc.library.messagebuilder.core.maps.MacroStringMap
-
Constructs an empty
MacroStringMap. - Macro Support - Search tag in package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.location
- Section
- MacroValueResolver - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.value
-
A
ValueResolverimplementation that delegates resolution to a chain of otherValueResolverinstances in order. - MacroValueResolver(List<ValueResolver>) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.value.MacroValueResolver
-
Constructs a
MacroValueResolverwith the given list of delegate resolvers. - match(String, Pattern) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.matchers.RegexPlaceholderMatcher
- match(String, Pattern) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.matchers.PlaceholderMatcher
-
Extracts macro keys from the given input string using the specified regular expression pattern.
- matchLongest(Enum<?>) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundRepository
- matchLongest(Enum<?>) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.sound.SoundRepository
- material() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidItemRecord
- MATERIAL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.ItemRecord.Field
- message() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns the value of the
messagerecord component. - message() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidMessageRecord
- Message - Interface in com.winterhavenmc.library.messagebuilder.core.message
-
A sealed interface representing a message that can be composed using macros and sent to a valid recipient.
- MESSAGE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- MESSAGE_ENTRY_MISSING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
- MESSAGE_ID - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- MESSAGE_KEY_INVALID - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
- MESSAGE_PROCESSOR - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- MESSAGE_RECORD - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- MESSAGE_SECTION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- MESSAGE_SECTION_MISSING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
- MESSAGE_STRING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- MESSAGE_TEXT - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.MessageRecord.Field
- MessageBuilder - Class in com.winterhavenmc.library.messagebuilder
-
A class that implements a builder pattern for messages to be sent to a player or console.
- MessageCooldownMap - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.cooldown
-
An implementation of
CooldownMapthat maintains a per-message cooldown map. - MessageCooldownMap() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.cooldown.MessageCooldownMap
- MessageCtx - Record Class in com.winterhavenmc.library.messagebuilder.core.context
- MessageCtx(Plugin, ValidMessage, ValidMessageKey, Pipeline) - Constructor for record class com.winterhavenmc.library.messagebuilder.core.context.MessageCtx
-
Creates an instance of a
MessageCtxrecord class. - Message Implementations - Search tag in package com.winterhavenmc.library.messagebuilder.core.message
- Section
- messageKey() - Method in record class com.winterhavenmc.library.messagebuilder.models.validation.Logging
-
Returns the value of the
messageKeyrecord component. - MessageKey - Interface in com.winterhavenmc.library.messagebuilder.models.keys
-
A type that represents a validated string for a record.
- messagePipeline() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessageCtx
-
Returns the value of the
messagePipelinerecord component. - MessagePipeline - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline
- MessagePipeline(MessagePipelineCtx) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.MessagePipeline
- MessagePipelineCtx - Record Class in com.winterhavenmc.library.messagebuilder.core.context
- MessagePipelineCtx(MessageRetriever, Processor, CooldownMap, List<Sender>) - Constructor for record class com.winterhavenmc.library.messagebuilder.core.context.MessagePipelineCtx
-
Creates an instance of a
MessagePipelineCtxrecord class. - messageProcessor() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessagePipelineCtx
-
Returns the value of the
messageProcessorrecord component. - MessageProcessor - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.processors
-
Default implementation of the
Processorinterface responsible for performing macro replacement on message fields. - MessageProcessor(ValueResolver, PlaceholderMatcher) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.processors.MessageProcessor
-
Constructs a
MessageProcessorusing the providedValueResolverandPlaceholderMatcherto configure the underlyingMacroReplacer. - MessageRecord - Interface in com.winterhavenmc.library.messagebuilder.models.language
-
A sealed interface representing a structured message record loaded from the
MESSAGESsection of a language YAML file. - MessageRecord.Field - Enum Class in com.winterhavenmc.library.messagebuilder.models.language
-
Enum representing the fields defined in a
ValidMessageRecord. - MessageRepository - Interface in com.winterhavenmc.library.messagebuilder.core.ports.resources.language
- messageRetriever() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessagePipelineCtx
-
Returns the value of the
messageRetrieverrecord component. - MessageRetriever - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.retrievers
-
A functional interface representing the first stage of the message pipeline: retrieving a
MessageRecordassociated with a givenValidMessageKey. - MESSAGES - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.Section
- MILLISECONDS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- MINUTES - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- MISSING_LANGUAGE_FILE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.ErrorMessageKey
-
Indicates that a language file could not be found for the configured locale.
- MISSING_LANGUAGE_RESOURCE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.ErrorMessageKey
-
Indicates that a required language resource file is missing from the plugin jar.
- MISSING_RESOURCE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.ErrorMessageKey
-
Indicates a general failure to locate a required resource.
- MONTHS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- MultiverseResolver - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.worldname
-
A
WorldNameResolverimplementation that retrieves world name aliases using the Multiverse-Core plugin. - MultiverseResolver(Plugin) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.worldname.MultiverseResolver
-
Constructs a
MultiverseV4WorldNameResolverusing the given instance ofMultiverseCore. - MultiverseRetriever - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.spawnlocation
- MultiverseRetriever - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.worldname
-
A
WorldNameRetrieverimplementation that retrieves the alias name of aWorldusing the Multiverse-Core API. - MultiverseRetriever() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.spawnlocation.MultiverseRetriever
- MultiverseRetriever(MultiverseCore) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.worldname.MultiverseRetriever
-
Constructs a
Multiverse4Retrieverwith the given Multiverse-Core instance.
N
- name() - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.LanguageSetting
-
Returns the value of the
namerecord component. - name() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidItemRecord
- name(ValidItemKey) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlItemRepository
- name(ValidItemKey) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ItemRepository
- NAME - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- NAME - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.ItemRecord.Field
- NAME - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- Nameable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.name
-
A functional interface representing an object with a name field, commonly used in
Accessorimplementations that expose agetName()method. - NameAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.name
-
An
Accessorfor extracting name information from objects that expose agetName()method. - NameAdapter(AccessorCtx) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.name.NameAdapter
-
Constructs a new
DisplayNameAdapterwith the given context container. - NORMAL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration.DurationType
- notCooling(CooldownKey) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.cooldown.MessageCooldownMap
-
Checks whether the message corresponding to the given cooldown string is currently cooling down for a recipient.
- notCooling(CooldownKey) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.cooldown.CooldownMap
-
Determines if the given cooldown string is not currently cooling down.
- NULL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.DefaultSymbol
- NULL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.InvalidReason
- NumberFormatter - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.number
-
A functional interface for formatting numeric values into localized
Stringrepresentations.
O
- of(ValidConstantKey, Object) - Static method in interface com.winterhavenmc.library.messagebuilder.models.language.ConstantRecord
-
Factory method that attempts to create a
ConstantRecordfrom the given value. - of(ValidItemKey, ConfigurationSection) - Static method in interface com.winterhavenmc.library.messagebuilder.models.language.ItemRecord
-
Creates an
ItemRecordfrom the given configuration section. - of(ValidMessageKey, ConfigurationSection) - Static method in interface com.winterhavenmc.library.messagebuilder.models.language.MessageRecord
-
Factory method that constructs a
MessageRecordfrom a YAML configuration section. - of(Recipient.Sendable, ValidMessageKey) - Static method in class com.winterhavenmc.library.messagebuilder.models.keys.CooldownKey
-
Static factory method with Message parameter
- of(E) - Static method in interface com.winterhavenmc.library.messagebuilder.models.keys.MacroKey
- of(E) - Static method in interface com.winterhavenmc.library.messagebuilder.models.keys.MessageKey
- of(String) - Static method in class com.winterhavenmc.library.messagebuilder.models.configuration.LanguageTag
-
Static factory method that creates a new validated LanguageTag from a Section
- of(String) - Static method in interface com.winterhavenmc.library.messagebuilder.models.keys.ConstantKey
- of(String) - Static method in interface com.winterhavenmc.library.messagebuilder.models.keys.ItemKey
- of(String) - Static method in interface com.winterhavenmc.library.messagebuilder.models.keys.MacroKey
- of(String) - Static method in interface com.winterhavenmc.library.messagebuilder.models.keys.MessageKey
- of(String, boolean, boolean, String, float, float) - Static method in interface com.winterhavenmc.library.messagebuilder.models.sound.SoundRecord
- of(Locale) - Static method in class com.winterhavenmc.library.messagebuilder.models.configuration.LanguageTag
-
Static factory method that creates a new LanguageTag from a Locale
- of(CommandSender) - Static method in interface com.winterhavenmc.library.messagebuilder.models.recipient.Recipient
-
Factory method that analyzes the given
CommandSenderand returns a categorizedRecipientinstance. - one() - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- OPEN - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.Delimiter
- OTHER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.InvalidReason
- Overview - Search tag in package com.winterhavenmc.library.messagebuilder.models.language
- Section
- Ownable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.owner
-
Represents an object that has a concept of ownership, expressed through an
AnimalTamer. - OWNER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- OwnerAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.owner
-
Accessor that extracts ownership information from objects that either implement
Ownableor areTameableBukkit entities. - OwnerAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.owner.OwnerAdapter
P
- parameter() - Method in record class com.winterhavenmc.library.messagebuilder.models.validation.Logging
-
Returns the value of the
parameterrecord component. - Parameter - Enum Class in com.winterhavenmc.library.messagebuilder.models.validation
-
Enumerates the names of parameters that may be subject to validation within the MessageBuilder library.
- PARAMETER_INVALID - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.ErrorMessageKey
-
Indicates that a parameter failed validation, but no specific cause is given.
- PARAMETER_NULL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.ErrorMessageKey
-
Indicates that a required parameter was
null. - PARAMETER_TYPE_MISMATCH - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.ErrorMessageKey
-
Indicates that a parameter was of the wrong type.
- Pipeline - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline
- pitch() - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.ValidSoundRecord
-
Returns the value of the
pitchrecord component. - PLACEHOLDER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- PlaceholderMatcher - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.matchers
-
A functional interface representing a strategy for extracting
ValidMacroKeyinstances from an input string using a specified regular expression pattern. - play(CommandSender, Enum<?>) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundRepository
-
Play sound effect for player
- play(CommandSender, Enum<?>) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.sound.SoundRepository
-
Play sound effect for player
- play(CommandSender, String) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundRepository
-
Play sound effect for player
- play(CommandSender, String) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.sound.SoundRepository
- play(Location, Enum<?>) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundRepository
-
Play sound effect for location
- play(Location, Enum<?>) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.sound.SoundRepository
-
Play sound effect for location
- playerOnly() - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.ValidSoundRecord
-
Returns the value of the
playerOnlyrecord component. - plugin() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessageCtx
-
Returns the value of the
pluginrecord component. - PLUGIN - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- PluginBasedResolver - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.spawnlocation
- PluginBasedResolver(Plugin) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.spawnlocation.PluginBasedResolver
- Plugin Extension - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors
- Section
- Plugin Integration - Search tag in package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.name
- Section
- PLURAL_NAME - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- PLURAL_NAME - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.ItemRecord.Field
- pluralName() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidItemRecord
- PluralNameable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.pluralname
-
An interface representing objects that expose a pluralized name for macro replacement.
- PluralNameAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.pluralname
-
Accessor implementation for extracting display names from supported object types.
- PluralNameAdapter(AccessorCtx) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.pluralname.PluralNameAdapter
-
Constructs a new
PluralNameAdapterwith the given context container. - precision() - Method in record class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.duration.BoundedDuration
-
Returns the value of the
precisionrecord component. - PRECISION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- process(ValidMessageRecord, MacroObjectMap) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.processors.MessageProcessor
-
Processes a
ValidMessageRecordby replacing all macros in its fields using the providedMacroObjectMap, and return new message record with final string fields added with macro replacements performed. - process(ValidMessageRecord, MacroObjectMap) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.processors.Processor
-
Processes a valid message record by replacing all macros using the provided macro object map.
- Processor - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.processors
-
A functional interface representing the final stage in the message pipeline: transforming a
ValidMessageRecordinto aFinalMessageRecordby resolving and replacing all macro placeholders. - Protectable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.protection
-
An interface representing objects that have a limited protection period, retrievable via an
Instanttimestamp. - PROTECTION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- ProtectionAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.protection
-
An
Accessorimplementation for adapting objects that implement theProtectableinterface. - ProtectionAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.protection.ProtectionAdapter
- Proxied(CommandSender, ProxiedCommandSender) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Proxied
-
Creates an instance of a
Proxiedrecord class. - proxy() - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Proxied
-
Returns the value of the
proxyrecord component. - put(MacroKey, T) - Method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroObjectMap
-
Inserts a string-value pair into the map.
- put(ValidMacroKey, String) - Method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroStringMap
-
Inserts a string-value pair into the map.
- putAll(MacroStringMap) - Method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroStringMap
-
Inserts all entries from another
MacroStringMapinto this map. - putExpirationTime(Recipient.Sendable, FinalMessageRecord) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.cooldown.MessageCooldownMap
-
Registers a new cooldown expiration time for the given message and recipient.
- putExpirationTime(Recipient.Sendable, FinalMessageRecord) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.cooldown.CooldownMap
- putIfAbsent(MacroKey, T) - Method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroObjectMap
-
Inserts a string-value pair only if the string is not already present in the map.
- putIfAbsent(ValidMacroKey, String) - Method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroStringMap
-
Inserts a string-value pair into the map only if the string is not already present.
Q
- Quantifiable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.quantity
-
Represents objects that expose a numerical quantity for macro replacement.
- QUANTITY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- QUANTITY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- QUERY_HANDLER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
R
- reason() - Method in record class com.winterhavenmc.library.messagebuilder.core.message.InvalidMessage
-
Returns the value of the
reasonrecord component. - reason() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidConstantKey
-
Returns the value of the
reasonrecord component. - reason() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidItemKey
-
Returns the value of the
reasonrecord component. - reason() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidMessageKey
-
Returns the value of the
reasonrecord component. - reason() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidConstantRecord
-
Returns the value of the
reasonrecord component. - reason() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidItemRecord
-
Returns the value of the
reasonrecord component. - reason() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidMessageRecord
-
Returns the value of the
reasonrecord component. - reason() - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.InvalidSoundRecord
-
Returns the value of the
reasonrecord component. - Reason() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKey
-
Returns the value of the
Reasonrecord component. - Recipient - Interface in com.winterhavenmc.library.messagebuilder.models.recipient
-
A sealed interface and its related types that represent different categories of message recipients in a player message context.
- RECIPIENT - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- Recipient.Invalid - Record Class in com.winterhavenmc.library.messagebuilder.models.recipient
-
Represents an invalid or unrecognized message recipient.
- Recipient.InvalidReason - Enum Class in com.winterhavenmc.library.messagebuilder.models.recipient
-
Indicates the reason a
Recipientwas deemed invalid. - Recipient.Proxied - Record Class in com.winterhavenmc.library.messagebuilder.models.recipient
-
Represents a proxied command sender (e.g., from another plugin or dispatch chain).
- Recipient.Sendable - Interface in com.winterhavenmc.library.messagebuilder.models.recipient
-
A marker subinterface for
Recipienttypes that are capable of receiving messages directly. - Recipient.Valid - Record Class in com.winterhavenmc.library.messagebuilder.models.recipient
-
Represents a valid, recognized message recipient such as a player, console, or command block.
- Recipient Categories - Search tag in package com.winterhavenmc.library.messagebuilder.models.recipient
- Section
- record(ValidItemKey) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlItemRepository
- record(ValidItemKey) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.language.ItemRepository
- RECORD_TYPE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- RecordKey - Interface in com.winterhavenmc.library.messagebuilder.models.keys
- RegexMacroReplacer - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.replacers
-
Default implementation of the
MacroReplacerinterface that performs macro substitution on input strings using values derived from aMacroObjectMap. - RegexMacroReplacer(ValueResolver, PlaceholderMatcher) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.replacers.RegexMacroReplacer
-
Constructs a
RegexMacroReplacerwith the given resolver and placeholder matcher. - RegexPlaceholderMatcher - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.matchers
-
Default implementation of the
PlaceholderMatcherinterface that uses Java’s built-inPatternandMatchResultAPIs to extract macro keys from an input string. - RegexPlaceholderMatcher() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.matchers.RegexPlaceholderMatcher
- register(Accessor) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.FieldAccessorRegistry
-
Registers a new
Accessorinto the registry. - register(Accessor) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.AccessorRegistry
-
Registers a new
Accessorinto the registry. - reload() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceManager
-
Reload the language resource.
- reload() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundResourceManager
-
reload sound configuration from yaml file in plugin data folder
- reload() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceManager
-
Reload resource into a bukkit Configuration object
- reload() - Method in class com.winterhavenmc.library.messagebuilder.MessageBuilder
-
Reload resources
- RELOAD_FAILED - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.ErrorMessageKey
-
Indicates that a configuration reload operation failed.
- removeExpired() - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.cooldown.MessageCooldownMap
-
Removes all expired cooldown entries from the internal map.
- removeExpired() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.cooldown.CooldownMap
- REPEAT_DELAY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.MessageRecord.Field
- repeatDelay() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns the value of the
repeatDelayrecord component. - repeatDelay() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidMessageRecord
- replace(MacroObjectMap, String) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.replacers.RegexMacroReplacer
-
Replaces all macro placeholders found in the given message string using the provided
MacroObjectMap. - replace(MacroObjectMap, String) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.replacers.MacroReplacer
-
Replaces all macro placeholders in the provided message string using values from the given macro object map.
- REPLACEMENT_MAP - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- Resolution Behavior - Search tag in package com.winterhavenmc.library.messagebuilder.models.configuration
- Section
- resolve(ValidMacroKey, MacroObjectMap) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.value.AtomicResolver
-
Resolves a single value mapped to the provided
ValidMacroKeyinto a string representation, if the object exists and can be formatted. - resolve(ValidMacroKey, MacroObjectMap) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.value.CompositeResolver
-
Resolves a
ValidMacroKeyby attempting to adapt the associated object from theMacroObjectMapusing applicableAccessorinstances. - resolve(ValidMacroKey, MacroObjectMap) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.value.MacroValueResolver
-
Resolves a
ValidMacroKeyusing the available macro objects in the givenMacroObjectMap, by delegating to each registered resolver in sequence. - resolve(ValidMacroKey, MacroObjectMap) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.macro.ValueResolver
-
Resolves a set of string values from the given
MacroObjectMapfor the providedValidMacroKey. - resolve(ItemStack) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.itemname.BukkitItemDisplayNameResolver
- resolve(ItemStack) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.itemname.BukkitItemNameResolver
- resolve(ItemStack) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.itemname.BukkitItemPluralNameResolver
- resolve(ItemStack) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.itemname.ItemDisplayNameResolver
- resolve(ItemStack) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.itemname.ItemNameResolver
- resolve(ItemStack) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.itemname.ItemPluralNameResolver
- resolve(World) - Method in interface com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.spawnlocation.BukkitSpawnLocationResolver
- resolve(World) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.spawnlocation.DefaultResolver
-
Returns the default Bukkit world name by calling
WorldInfo.getName(). - resolve(World) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.spawnlocation.PluginBasedResolver
- resolve(World) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.worldname.DefaultResolver
-
Returns the default Bukkit world name using an instance of
DefaultRetriever - resolve(World) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.resolvers.worldname.MultiverseResolver
-
Attempts to retrieve the alias name of the specified world using
Multiverse4Retriever. - resolve(World) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.spawnlocation.SpawnLocationResolver
- resolve(World) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.worldname.WorldNameResolver
-
Resolves the user-facing name of the given
World, using either the native Bukkit name or a plugin-provided alias. - Resolved Fields - Search tag in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
- Section
- RESOURCE_AUTO_INSTALL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.language.LanguageConfigConstant
- RESOURCE_FALLBACK_FAILED - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- RESOURCE_FALLBACK_MISSING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- RESOURCE_FALLBACK_SUCCESS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- RESOURCE_INSTALL_EXCEPTION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- RESOURCE_INSTALL_MISSING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- RESOURCE_INSTALL_SUCCESS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- RESOURCE_INSTALLER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- RESOURCE_INVALID_FILE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- RESOURCE_INVALID_YAML - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- RESOURCE_LOAD_EXCEPTION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- RESOURCE_LOAD_MISSING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- RESOURCE_LOAD_SUCCESS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- RESOURCE_LOADER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- RESOURCE_NAME - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.SoundResourceConstant
- RESOURCE_NAME - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- RESOURCE_NOT_FOUND - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- RESOURCE_SUBDIRECTORY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.language.LanguageConfigConstant
- RESOURCE_TAG_MISSING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- RESOURCE_TYPE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- RESOURCE_UNREADABLE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- ResourceInstaller - Interface in com.winterhavenmc.library.messagebuilder.core.ports.resources
-
An interface that describes classes that are responsible for installing resources from the jar to the plugin data directory.
- ResourceInstaller.InstallerStatus - Enum Class in com.winterhavenmc.library.messagebuilder.core.ports.resources
- ResourceLoader - Interface in com.winterhavenmc.library.messagebuilder.core.ports.resources
-
An interface that represents classes responsible for loading an installed resource file from the plugin data directory.
- ResourceManager - Interface in com.winterhavenmc.library.messagebuilder.core.ports.resources
-
An interface that describes a resource manager that is responsible for installing resources from the plugin jar file to the plugin data directory, as well as loading and reloading the installed files at startup or issuance of the
reloadcommand. - ResourceMessage - Enum Class in com.winterhavenmc.library.messagebuilder.adapters.resources
- Runtime Integration - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.worldname
- Section
S
- SECONDS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- Section - Enum Class in com.winterhavenmc.library.messagebuilder.models.language
-
An enumeration of Sections that correspond directly to each top level
ConfigurationSectionof the language file. - SECTION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- SECTION_SUPPLIER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- SectionProvider - Interface in com.winterhavenmc.library.messagebuilder.core.ports.resources
- SectionRecord - Interface in com.winterhavenmc.library.messagebuilder.models.language
-
A sealed interface representing a validated record loaded from a structured section of a language YAML file.
- send() - Method in record class com.winterhavenmc.library.messagebuilder.core.message.InvalidMessage
- send() - Method in interface com.winterhavenmc.library.messagebuilder.core.message.Message
-
Sends the composed message to the resolved recipient, if valid.
- send() - Method in class com.winterhavenmc.library.messagebuilder.core.message.ValidMessage
- send(Recipient.Sendable, FinalMessageRecord) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.senders.KyoriMessageSender
-
Sends a chat message to the specified recipient if the message is enabled and contains content.
- send(Recipient.Sendable, FinalMessageRecord) - Method in class com.winterhavenmc.library.messagebuilder.adapters.pipeline.senders.KyoriTitleSender
-
Sends a title and subtitle to a player if applicable, using values from the given message record.
- send(Recipient.Sendable, FinalMessageRecord) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.senders.Sender
-
Sends a processed message to the given recipient using the implementation’s delivery strategy.
- sender() - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Invalid
-
Returns the value of the
senderrecord component. - sender() - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Proxied
-
Returns the value of the
senderrecord component. - sender() - Method in interface com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Sendable
-
The actual
CommandSenderthat may receive messages. - sender() - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Valid
-
Returns the value of the
senderrecord component. - Sender - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.senders
-
A functional interface representing a message dispatch strategy responsible for delivering a fully rendered
FinalMessageRecordto aRecipient.Sendable. - senders() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessagePipelineCtx
-
Returns the value of the
sendersrecord component. - Sending - Search tag in interface com.winterhavenmc.library.messagebuilder.core.message.Message
- Section
- setMacro(int, K, V) - Method in record class com.winterhavenmc.library.messagebuilder.core.message.InvalidMessage
- setMacro(int, K, V) - Method in interface com.winterhavenmc.library.messagebuilder.core.message.Message
-
Associates a macro string with a value and explicit quantity, useful for pluralization or contextual substitution that depends on numeric counts.
- setMacro(int, K, V) - Method in class com.winterhavenmc.library.messagebuilder.core.message.ValidMessage
- setMacro(K, Duration, ChronoUnit) - Method in record class com.winterhavenmc.library.messagebuilder.core.message.InvalidMessage
- setMacro(K, Duration, ChronoUnit) - Method in interface com.winterhavenmc.library.messagebuilder.core.message.Message
-
Associates a duration with the given macro string, using a defined precision.
- setMacro(K, Duration, ChronoUnit) - Method in class com.winterhavenmc.library.messagebuilder.core.message.ValidMessage
- setMacro(K, V) - Method in record class com.winterhavenmc.library.messagebuilder.core.message.InvalidMessage
- setMacro(K, V) - Method in interface com.winterhavenmc.library.messagebuilder.core.message.Message
-
Associates a macro string with a value for later substitution during message rendering.
- setMacro(K, V) - Method in class com.winterhavenmc.library.messagebuilder.core.message.ValidMessage
- Single-field Adapters - Search tag in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- Section
- size() - Method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroStringMap
-
Returns the number of entries in this map.
- SOUND_RESOURCE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- SOUND_RESOURCE_MANAGER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- soundEffectsDisabled() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundRepository
- soundEffectsDisabled() - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.sound.SoundRepository
- soundName() - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.ValidSoundRecord
-
Returns the value of the
soundNamerecord component. - SoundRecord - Interface in com.winterhavenmc.library.messagebuilder.models.sound
- SoundRepository - Interface in com.winterhavenmc.library.messagebuilder.core.ports.resources.sound
-
An interface that facilitates loading a custom sound configuration file and provides methods to play sounds in game
- SoundResourceConstant - Enum Class in com.winterhavenmc.library.messagebuilder.adapters.resources.sound
-
Enum containing constants for various yaml parameters
- sounds() - Method in class com.winterhavenmc.library.messagebuilder.MessageBuilder
-
Provides external access to the sound repository
- spawnLocation(UUID) - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitWorldRepository
- spawnLocation(UUID) - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.WorldRepository
- SpawnLocationResolver - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.spawnlocation
- SpawnLocationRetriever - Interface in com.winterhavenmc.library.messagebuilder.adapters.pipeline.retrievers.spawnlocation
- StandardKey - Interface in com.winterhavenmc.library.messagebuilder.models.keys
-
An interface that defines a standard string type.
- Standard Support - Search tag in package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.name
- Section
- string() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidConstantKey
-
Returns the value of the
stringrecord component. - string() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidItemKey
-
Returns the value of the
stringrecord component. - string() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKey
-
Returns the value of the
stringrecord component. - string() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidMessageKey
-
Returns the value of the
stringrecord component. - STRING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable.Field
- STRING_BLANK - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.ErrorMessageKey
-
Indicates that a provided string was blank (empty or only whitespace).
- Subpackages - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters
- Section
- subtitle() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns the value of the
subtitlerecord component. - subtitle() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidMessageRecord
- SUBTITLE_TEXT - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.MessageRecord.Field
- SUCCESS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceInstaller.InstallerStatus
- supports(Object) - Method in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor
-
Returns
trueif this adapter can successfully adapt the given object. - symbol() - Method in enum class com.winterhavenmc.library.messagebuilder.models.DefaultSymbol
T
- TARGET_DIR_PATH - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- throwing(ErrorMessageKey, Parameter) - Static method in interface com.winterhavenmc.library.messagebuilder.models.validation.Validator
-
Returns a handler that throws a
ValidationExceptionusing the given error message string and parameter. - Throwing<T> - Record Class in com.winterhavenmc.library.messagebuilder.models.validation
-
A
Validatorimplementation that throws aValidationExceptionwhen a value fails validation. - Throwing(Supplier<ValidationException>) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.validation.Throwing
-
Creates an instance of a
Throwingrecord class. - Tick - Class in com.winterhavenmc.library.messagebuilder.models.time
- Tick() - Constructor for class com.winterhavenmc.library.messagebuilder.models.time.Tick
- TICKS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- TICKS - Static variable in class com.winterhavenmc.library.messagebuilder.MessageBuilder
- Time4jDurationFormatter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration
-
A
DurationFormatterimplementation that uses the Time4J library'sPrettyTimeto renderDurationvalues as human-readable, localized strings. - Time4jDurationFormatter(ConfigRepository) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration.Time4jDurationFormatter
-
Constructs a
Time4jDurationFormatterwith the providedConfigRepository. - times(int) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- TimeUnit - Enum Class in com.winterhavenmc.library.messagebuilder.models.time
- title() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns the value of the
titlerecord component. - title() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidMessageRecord
- TITLE_FADE_IN - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.MessageRecord.Field
- TITLE_FADE_OUT - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.MessageRecord.Field
- TITLE_STAY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.MessageRecord.Field
- TITLE_TEXT - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.language.MessageRecord.Field
- titleFadeIn() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns the value of the
titleFadeInrecord component. - titleFadeIn() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidMessageRecord
- titleFadeOut() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns the value of the
titleFadeOutrecord component. - titleFadeOut() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidMessageRecord
- titleStay() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns the value of the
titleStayrecord component. - titleStay() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidMessageRecord
- toDays(long) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- toHours(long) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- toJavaUtilLevel() - Method in enum class com.winterhavenmc.library.messagebuilder.models.validation.LogLevel
-
Returns the corresponding
Levelfor this log level. - toKey() - Method in enum class com.winterhavenmc.library.messagebuilder.models.language.ItemRecord.Field
-
Returns the YAML string path string associated with this field.
- toKey() - Method in enum class com.winterhavenmc.library.messagebuilder.models.language.MessageRecord.Field
-
Returns the raw YAML string associated with this field.
- toMillis(long) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- toMinutes(long) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- toMonths(long) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- toSeconds(long) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- toString() - Method in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.language.LanguageConfigConstant
- toString() - Method in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
- toString() - Method in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.SoundResourceConstant
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.AccessorCtx
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.FormatterCtx
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessageCtx
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessagePipelineCtx
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.core.message.InvalidMessage
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.formatters.duration.BoundedDuration
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.DisabledWorldsSetting
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.EnabledWorldsSetting
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.LanguageSetting
-
Returns a string representation of this record class.
- toString() - Method in class com.winterhavenmc.library.messagebuilder.models.configuration.LanguageTag
-
Retrieve the IETF language tag associated with a potential language resource, as a Section
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.LocaleSetting
-
Returns a string representation of this record class.
- toString() - Method in enum class com.winterhavenmc.library.messagebuilder.models.Delimiter
- toString() - Method in class com.winterhavenmc.library.messagebuilder.models.keys.CooldownKey
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidConstantKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidItemKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKey
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.keys.InvalidMessageKey
-
Returns a string representation of this record class.
- toString() - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidConstantKey
- toString() - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidItemKey
- toString() - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidMacroKey
- toString() - Method in class com.winterhavenmc.library.messagebuilder.models.keys.ValidMessageKey
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.FinalMessageRecord
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidConstantRecord
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidItemRecord
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.language.InvalidMessageRecord
-
Returns a string representation of this record class.
- toString() - Method in enum class com.winterhavenmc.library.messagebuilder.models.language.ItemRecord.Field
- toString() - Method in enum class com.winterhavenmc.library.messagebuilder.models.language.MessageRecord.Field
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Invalid
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Proxied
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Valid
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.InvalidSoundRecord
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.ValidSoundRecord
-
Returns a string representation of this record class.
- toString() - Method in class com.winterhavenmc.library.messagebuilder.models.time.Tick
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.validation.Logging
-
Returns a string representation of this record class.
- toString() - Method in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
-
Returns the display name of the parameter.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.models.validation.Throwing
-
Returns a string representation of this record class.
- toTicks(long) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- toWeeks(long) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- toYears(long) - Method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- TRACE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.LogLevel
-
The lowest level of logging, typically used for very fine-grained tracing.
- TWO_OR_MORE_DOTS - Static variable in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceInstaller
- TWO_OR_MORE_SLASHES - Static variable in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceInstaller
- TYPE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- Typical Usage - Search tag in package com.winterhavenmc.library.messagebuilder
- Section
- Typical Usage - Search tag in package com.winterhavenmc.library.messagebuilder.models.language
- Section
- Typical usage: - Search tag in class com.winterhavenmc.library.messagebuilder.models.configuration.LanguageTag
- Section
- Typical usage: - Search tag in record class com.winterhavenmc.library.messagebuilder.models.validation.Logging
- Section
- Typical usage: - Search tag in record class com.winterhavenmc.library.messagebuilder.models.validation.Throwing
- Section
- Typical Use Case - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.cooldown
- Section
U
- UNAVAILABLE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceInstaller.InstallerStatus
- UNIQUE_ID - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- UniqueIdAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.identity
-
Accessor for identifying objects with a unique
UUID. - UniqueIdAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.identity.UniqueIdAdapter
- UNKNOWN - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.DefaultSymbol
- UNKNOWN - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- UNKNOWN_VALUE - Static variable in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor
- UNLIMITED - Enum constant in enum class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration.DurationType
- URL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- UrlAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.url
- UrlAdapter(AccessorCtx) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.url.UrlAdapter
- UrlAddressable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.url
- Usage - Search tag in interface com.winterhavenmc.library.messagebuilder.models.language.SectionRecord
- Section
- Usage - Search tag in package com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors
- Section
- Usage - Search tag in package com.winterhavenmc.library.messagebuilder.core.message
- Section
- Usage - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.worldname
- Section
- Usage - Search tag in package com.winterhavenmc.library.messagebuilder.models.recipient
- Section
- Usage Example - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors
- Section
- Usage Pattern - Search tag in package com.winterhavenmc.library.messagebuilder.models.validation
- Section
- Use Case - Search tag in package com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.macro
- Section
- UUID - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
V
- Valid(CommandSender) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.Valid
-
Creates an instance of a
Validrecord class. - VALID_DISPLAY_NAME - Static variable in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.displayname.DisplayNameable
-
A predicate used to validate that a display name is non-null and non-blank.
- VALID_KEY_PATTERN - Static variable in interface com.winterhavenmc.library.messagebuilder.models.keys.StandardKey
- VALID_KILLER - Static variable in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.killer.Killable
-
Predicate that evaluates whether a killer is considered valid and non-blank.
- VALID_LOCALE - Static variable in class com.winterhavenmc.library.messagebuilder.models.configuration.LanguageTag
-
Predicate that evaluates to
trueif the input string resolves to a valid ISO 639 language code recognized by the JVM. - VALID_LOOTER - Static variable in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.looter.Lootable
-
Predicate to validate whether a looter has a valid, non-blank name.
- VALID_NAME - Static variable in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.name.Nameable
-
A predicate that determines whether a given name string is valid.
- VALID_OWNER - Static variable in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.owner.Ownable
-
Predicate used to validate an owner.
- VALID_PLURAL_NAME - Static variable in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.pluralname.PluralNameable
-
A predicate used to validate that a display name is non-null and non-blank.
- VALID_URL - Static variable in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.url.UrlAddressable
- VALID_VERSION - Static variable in interface com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.version.Versionable
- validate(T, Predicate<T>, Validator<T>) - Static method in interface com.winterhavenmc.library.messagebuilder.models.validation.Validator
-
Validates a value using the given predicate and handler.
- Validation - Search tag in package com.winterhavenmc.library.messagebuilder.core.maps
- Section
- ValidationContext - Class in com.winterhavenmc.library.messagebuilder.models.validation
-
Provides global access to the plugin-configured locale used during validation message formatting.
- ValidationException - Exception Class in com.winterhavenmc.library.messagebuilder.models.validation
-
Thrown to indicate that a parameter validation has failed.
- ValidationException(ErrorMessageKey, Parameter) - Constructor for exception class com.winterhavenmc.library.messagebuilder.models.validation.ValidationException
-
Constructs a new
ValidationExceptionwith the specifiedErrorMessageKeyandParameterdescribing the failed validation. - Validator<T> - Interface in com.winterhavenmc.library.messagebuilder.models.validation
-
A functional interface representing a strategy for handling invalid values detected during validation.
- ValidConstantKey - Class in com.winterhavenmc.library.messagebuilder.models.keys
- ValidConstantRecord - Class in com.winterhavenmc.library.messagebuilder.models.language
-
A validated, immutable
ConstantRecordrepresenting a constant value loaded from theCONSTANTSsection of a language YAML file. - ValidItemKey - Class in com.winterhavenmc.library.messagebuilder.models.keys
- ValidItemRecord - Class in com.winterhavenmc.library.messagebuilder.models.language
-
A validated, immutable
ItemRecordrepresenting a localized or macro-enabled item definition loaded from theITEMSsection of a language YAML file. - ValidMacroKey - Class in com.winterhavenmc.library.messagebuilder.models.keys
-
A type that represents a validated string for a macro.
- validMessage() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessageCtx
-
Returns the value of the
validMessagerecord component. - ValidMessage - Class in com.winterhavenmc.library.messagebuilder.core.message
-
A concrete implementation of
Messagerepresenting a fully constructed, resolvable, and sendable message. - ValidMessage(Plugin, Recipient.Sendable, ValidMessageKey, Pipeline) - Constructor for class com.winterhavenmc.library.messagebuilder.core.message.ValidMessage
-
Class constructor
- validMessageKey() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.MessageCtx
-
Returns the value of the
validMessageKeyrecord component. - ValidMessageKey - Class in com.winterhavenmc.library.messagebuilder.models.keys
- ValidMessageRecord - Class in com.winterhavenmc.library.messagebuilder.models.language
-
A validated, immutable
MessageRecordrepresenting a single entry from theMESSAGESsection of a language YAML file. - ValidSoundRecord - Record Class in com.winterhavenmc.library.messagebuilder.models.sound
-
A class that contains the key and fields of a sound entry in the sound configuration
- ValidSoundRecord(String, boolean, boolean, String, float, float) - Constructor for record class com.winterhavenmc.library.messagebuilder.models.sound.ValidSoundRecord
-
Creates an instance of a
ValidSoundRecordrecord class. - value() - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidConstantRecord
-
Returns the raw constant value associated with this record.
- VALUE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration.DurationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.language.LanguageConfigConstant
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.SoundResourceConstant
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable.Field
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceInstaller.InstallerStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.models.DefaultSymbol
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.models.Delimiter
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKeyReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.models.language.ItemRecord.Field
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.models.language.MessageRecord.Field
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.models.language.Section
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.InvalidReason
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.models.validation.ErrorMessageKey
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.models.validation.LogLevel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
-
Returns the enum constant of this class with the specified name.
- ValueResolver - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.macro
-
Defines a contract for resolving values from a
MacroObjectMapinto a set of string-replaceable entries mapped byValidMacroKeys. - values() - Static method in enum class com.winterhavenmc.library.messagebuilder.adapters.pipeline.formatters.duration.DurationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.language.LanguageConfigConstant
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.ResourceMessage
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.SoundResourceConstant
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable.Field
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceInstaller.InstallerStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.models.DefaultSymbol
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.models.Delimiter
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.models.keys.InvalidKeyReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.models.language.InvalidRecordReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.models.language.ItemRecord.Field
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.models.language.MessageRecord.Field
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.models.language.Section
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.models.recipient.Recipient.InvalidReason
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.models.validation.ErrorMessageKey
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.models.validation.LogLevel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VERSION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.Accessor.BuiltIn
- Versionable - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.version
- VersionAdapter - Class in com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.version
- VersionAdapter(AccessorCtx) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.pipeline.accessors.version.VersionAdapter
- volume() - Method in record class com.winterhavenmc.library.messagebuilder.models.sound.ValidSoundRecord
-
Returns the value of the
volumerecord component.
W
- WARN - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.LogLevel
-
A warning that indicates a potential issue or recoverable problem.
- WEEKS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
- WHITESPACE - Static variable in interface com.winterhavenmc.library.messagebuilder.core.ports.resources.ResourceInstaller
- with(ValidMacroKey, String) - Method in class com.winterhavenmc.library.messagebuilder.core.maps.MacroStringMap
-
Adds a string-value pair to this map and returns the map itself.
- withFinalStrings(String, String, String) - Method in class com.winterhavenmc.library.messagebuilder.models.language.ValidMessageRecord
-
Creates a
FinalMessageRecordusing the current record data, combined with finalized message, title, and subtitle strings after macro resolution. - WORLD - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable.Field
- WORLD - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.validation.Parameter
- worldNameResolver() - Method in record class com.winterhavenmc.library.messagebuilder.core.context.AccessorCtx
-
Returns the value of the
worldNameResolverrecord component. - WorldNameResolver - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.worldname
-
A runtime-resolvable strategy interface for obtaining a display-friendly name for a
World, optionally integrating with external plugins such as Multiverse-Core. - WorldNameRetriever - Interface in com.winterhavenmc.library.messagebuilder.core.ports.pipeline.resolvers.worldname
-
Strategy interface for retrieving a user-friendly name for a given
World. - worldNames() - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.DisabledWorldsSetting
-
Returns the value of the
worldNamesrecord component. - WorldRepository - Interface in com.winterhavenmc.library.messagebuilder.models.configuration
- worlds() - Method in class com.winterhavenmc.library.messagebuilder.MessageBuilder
-
Provides external access to the enabled worlds provider
- worldUids() - Method in record class com.winterhavenmc.library.messagebuilder.models.configuration.EnabledWorldsSetting
-
Returns the value of the
worldUidsrecord component.
X
- X - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable.Field
Y
- Y - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable.Field
- YamlConstantRepository - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.language
- YamlConstantRepository(ResourceManager) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlConstantRepository
- YamlItemRepository - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.language
- YamlItemRepository(Plugin, ResourceManager) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlItemRepository
- YamlLanguageConfigurationProvider - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.language
- YamlLanguageConfigurationProvider(Supplier<Configuration>) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageConfigurationProvider
- YamlLanguageResourceInstaller - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.language
-
This class is responsible for installing localization resources from the language directory of the jar archive to the language subdirectory of the plugin data directory.
- YamlLanguageResourceInstaller(Plugin, ConfigRepository) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceInstaller
-
Class constructor
- YamlLanguageResourceLoader - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.language
-
This class is responsible for the loading of the language file from the plugin data directory into a configuration object.
- YamlLanguageResourceLoader(Plugin, ConfigRepository) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceLoader
-
Class constructor
- YamlLanguageResourceLoader(Plugin, Supplier<YamlConfiguration>, ConfigRepository) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceLoader
-
Testable constructor allowing custom YamlConfiguration supplier.
- YamlLanguageResourceManager - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.language
-
This class is responsible for the management and lifecycle of the language resource.
- YamlLanguageResourceManager(ResourceInstaller, ResourceLoader) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceManager
-
Class constructor
- YamlLanguageResourceManager(ResourceInstaller, ResourceLoader, Configuration) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageResourceManager
-
package-private constructor for testing purposes
- YamlLanguageSectionProvider - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.language
- YamlLanguageSectionProvider(Supplier<Configuration>, String) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlLanguageSectionProvider
- YamlMessageRepository - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.language
- YamlMessageRepository(ResourceManager) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.language.YamlMessageRepository
- YamlSoundConfigurationProvider - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.sound
- YamlSoundConfigurationProvider(Supplier<Configuration>) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundConfigurationProvider
- YamlSoundRepository - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.sound
-
A class that implements SoundRepository interface
- YamlSoundRepository(Plugin, ResourceManager) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundRepository
-
Class constructor
- YamlSoundResourceInstaller - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.sound
- YamlSoundResourceInstaller(Plugin) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundResourceInstaller
- YamlSoundResourceLoader - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.sound
- YamlSoundResourceLoader(Plugin, ConfigRepository) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundResourceLoader
- YamlSoundResourceLoader(Plugin, Supplier<YamlConfiguration>, ConfigRepository) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundResourceLoader
- YamlSoundResourceManager - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.sound
- YamlSoundResourceManager(ResourceInstaller, ResourceLoader) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundResourceManager
- YamlSoundSectionProvider - Class in com.winterhavenmc.library.messagebuilder.adapters.resources.sound
- YamlSoundSectionProvider(Supplier<Configuration>, String) - Constructor for class com.winterhavenmc.library.messagebuilder.adapters.resources.sound.YamlSoundSectionProvider
- YEARS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.models.time.TimeUnit
Z
- Z - Enum constant in enum class com.winterhavenmc.library.messagebuilder.core.ports.pipeline.accessors.location.Locatable.Field
- zoneId() - Method in class com.winterhavenmc.library.messagebuilder.adapters.resources.configuration.BukkitConfigRepository
-
Returns the configured
ZoneIdif valid, or the system default otherwise. - zoneId() - Method in interface com.winterhavenmc.library.messagebuilder.models.configuration.ConfigRepository
-
Returns the configured
ZoneIdif valid, or the system default otherwise.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form