Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractKey - Class in com.winterhavenmc.library.messagebuilder.keys
-
An abstract class that provides common methods for implementations of the StandardKey interface
- AbstractKey(String) - Constructor for class com.winterhavenmc.library.messagebuilder.keys.AbstractKey
-
Class constructor
- adapt(Object) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter
-
Attempts to adapt the given object to a type-specific representation for macro extraction.
- adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.adapters.displayname.DisplayNameAdapter
-
Attempts to adapt the given object to a
DisplayNameable
instance. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.adapters.duration.DurationAdapter
-
Attempts to adapt the given object into a
Durationable
if it explicitly implements the interface. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.adapters.expiration.ExpirationAdapter
-
Attempts to adapt the given object into an
Expirable
, if applicable. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.adapters.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.pipeline.adapters.killer.KillerAdapter
-
Attempts to adapt an object to the
Killable
interface. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.adapters.location.LocationAdapter
- adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.adapters.looter.LooterAdapter
-
Attempts to adapt an object into a
Lootable
. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.adapters.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.pipeline.adapters.owner.OwnerAdapter
-
Attempts to adapt the given object to the
Ownable
interface, either directly or by wrapping supported Bukkit types. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.adapters.protection.ProtectionAdapter
-
Attempts to adapt the given object to the
Protectable
interface. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.adapters.quantity.QuantityAdapter
-
Attempts to adapt the given object into a
Quantifiable
instance. - adapt(Object) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.adapters.uuid.UniqueIdAdapter
-
Attempts to adapt the given object to an
Identifiable
instance. - Adapter - Interface in com.winterhavenmc.library.messagebuilder.pipeline.adapters
-
A functional interface representing an adapter capable of extracting macro-relevant data from an object.
- ADAPTER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- Adapter.BuiltIn - Enum Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters
-
Enumeration of all built-in adapter types supported by the message builder pipeline.
- AdapterContextContainer - Record Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters
-
A simple context container that provides shared services to adapter implementations during macro extraction.
- AdapterContextContainer(WorldNameResolver, FormatterContainer) - Constructor for record class com.winterhavenmc.library.messagebuilder.pipeline.adapters.AdapterContextContainer
-
Creates an instance of a
AdapterContextContainer
record class. - Adapter Registration and Precedence - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.adapters
- Section
- AdapterRegistry - Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters
-
Maintains an ordered registry of all
Adapter
instances available to the macro resolution pipeline. - AdapterRegistry(AdapterContextContainer) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.adapters.AdapterRegistry
-
Constructs an
AdapterRegistry
and registers all built-in adapters in preferred priority order. - addTo(R, long) - Method in class com.winterhavenmc.library.time.Tick
- append(E) - Method in class com.winterhavenmc.library.messagebuilder.keys.MacroKey
-
Create a new key by suffixing a dot-separated subkey to this existing key
- append(String) - Method in class com.winterhavenmc.library.messagebuilder.keys.MacroKey
-
Create a new key by suffixing a dot-separated subkey to this existing key
- asPlaceholder() - Method in class com.winterhavenmc.library.messagebuilder.keys.MacroKey
- AtomicResolver - Class in com.winterhavenmc.library.messagebuilder.pipeline.resolvers
- AtomicResolver(FormatterContainer) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.AtomicResolver
-
Constructs an
AtomicResolver
using the provided formatter container. - autoInstall() - Method in class com.winterhavenmc.library.messagebuilder.resources.language.LanguageResourceInstaller
-
Install resources listed in auto_install.txt to the plugin data directory
- autoInstall() - Method in interface com.winterhavenmc.library.messagebuilder.resources.ResourceInstaller
-
Install resources listed in auto_install.txt to the plugin data directory
B
- BASE_KEY_PATTERN - Static variable in class com.winterhavenmc.library.messagebuilder.pipeline.replacer.MacroReplacer
-
Pattern used to match base macro keys (e.g.,
[ITEM
}) for macro resolution via theResolver
. - between(Temporal, Temporal) - Method in class com.winterhavenmc.library.time.Tick
- BoundedDuration - Record Class in com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration
-
A simple data container that encapsulates a
Duration
and its corresponding lower bound of precision, represented by aChronoUnit
. - BoundedDuration(Duration, ChronoUnit) - Constructor for record class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.BoundedDuration
-
Creates an instance of a
BoundedDuration
record class. - Built-in Adapter Support - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.adapters
- Section
- BUNDLE_NAME - Static variable in interface com.winterhavenmc.library.messagebuilder.validation.Validator
C
- Classification - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration
- Section
- classify(Duration, ChronoUnit) - Static method in enum class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.DurationType
-
Classifies a
Duration
into one of threeDurationType
categories 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.util.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.keys - package com.winterhavenmc.library.messagebuilder.keys
-
This package contains the StandardKey interface and implementations
- com.winterhavenmc.library.messagebuilder.model - package com.winterhavenmc.library.messagebuilder.model
-
This package contains data structure models used in the library.
- com.winterhavenmc.library.messagebuilder.model.language - package com.winterhavenmc.library.messagebuilder.model.language
-
Provides interfaces and data models that represent entries from the plugin's language YAML file.
- com.winterhavenmc.library.messagebuilder.model.message - package com.winterhavenmc.library.messagebuilder.model.message
-
Contains the sealed
Message
interface and its implementations, which represent composed messages ready for macro substitution and delivery. - com.winterhavenmc.library.messagebuilder.model.recipient - package com.winterhavenmc.library.messagebuilder.model.recipient
-
Contains a sealed model hierarchy representing classified message recipients in a Bukkit-based command or messaging context.
- com.winterhavenmc.library.messagebuilder.pipeline - package com.winterhavenmc.library.messagebuilder.pipeline
-
Provides the core processing components of the message pipeline.
- com.winterhavenmc.library.messagebuilder.pipeline.adapters - package com.winterhavenmc.library.messagebuilder.pipeline.adapters
-
Defines the adapter mechanism for macro value extraction within the message-building pipeline.
- com.winterhavenmc.library.messagebuilder.pipeline.adapters.displayname - package com.winterhavenmc.library.messagebuilder.pipeline.adapters.displayname
-
Provides an adapter and interface for extracting and formatting display names from objects.
- com.winterhavenmc.library.messagebuilder.pipeline.adapters.duration - package com.winterhavenmc.library.messagebuilder.pipeline.adapters.duration
-
Provides an adapter for objects that expose a
Duration
. - com.winterhavenmc.library.messagebuilder.pipeline.adapters.expiration - package com.winterhavenmc.library.messagebuilder.pipeline.adapters.expiration
-
Provides adapter and interface support for expiration-based macro replacements.
- com.winterhavenmc.library.messagebuilder.pipeline.adapters.instant - package com.winterhavenmc.library.messagebuilder.pipeline.adapters.instant
-
Provides adapter support for objects that expose a timestamp via the
Instant
API. - com.winterhavenmc.library.messagebuilder.pipeline.adapters.killer - package com.winterhavenmc.library.messagebuilder.pipeline.adapters.killer
-
Provides support for extracting killer information from entities or plugin-defined objects.
- com.winterhavenmc.library.messagebuilder.pipeline.adapters.location - package com.winterhavenmc.library.messagebuilder.pipeline.adapters.location
-
Provides support for extracting and formatting location-based macro values from objects.
- com.winterhavenmc.library.messagebuilder.pipeline.adapters.looter - package com.winterhavenmc.library.messagebuilder.pipeline.adapters.looter
-
Contains support for adapting objects that represent looting permissions or claims.
- com.winterhavenmc.library.messagebuilder.pipeline.adapters.name - package com.winterhavenmc.library.messagebuilder.pipeline.adapters.name
-
Provides the
Nameable
interface and its corresponding adapter used to extract and format name-related fields from objects passed into the message pipeline. - com.winterhavenmc.library.messagebuilder.pipeline.adapters.owner - package com.winterhavenmc.library.messagebuilder.pipeline.adapters.owner
-
Provides support for extracting ownership information from objects and applying it to macro placeholders.
- com.winterhavenmc.library.messagebuilder.pipeline.adapters.protection - package com.winterhavenmc.library.messagebuilder.pipeline.adapters.protection
-
Provides support for adapting objects with time-based protection attributes into macro string values.
- com.winterhavenmc.library.messagebuilder.pipeline.adapters.quantity - package com.winterhavenmc.library.messagebuilder.pipeline.adapters.quantity
-
Provides support for macro replacement of quantity-related values.
- com.winterhavenmc.library.messagebuilder.pipeline.adapters.uuid - package com.winterhavenmc.library.messagebuilder.pipeline.adapters.uuid
-
Provides support for macro replacement of UUID values from objects.
- com.winterhavenmc.library.messagebuilder.pipeline.cooldown - package com.winterhavenmc.library.messagebuilder.pipeline.cooldown
-
Provides support for message rate limiting through a cooldown mechanism.
- com.winterhavenmc.library.messagebuilder.pipeline.extractor - package com.winterhavenmc.library.messagebuilder.pipeline.extractor
-
Provides mechanisms for extracting macro-compatible string values from objects that have been adapted by the
Adapter
system. - com.winterhavenmc.library.messagebuilder.pipeline.formatters - package com.winterhavenmc.library.messagebuilder.pipeline.formatters
-
Contains formatters responsible for converting data types into localized, human-readable strings.
- com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration - package com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration
-
Provides formatting for
Duration
values into localized, human-readable strings. - com.winterhavenmc.library.messagebuilder.pipeline.formatters.number - package com.winterhavenmc.library.messagebuilder.pipeline.formatters.number
-
Provides locale-aware number formatting for use in the message-building pipeline.
- com.winterhavenmc.library.messagebuilder.pipeline.maps - package com.winterhavenmc.library.messagebuilder.pipeline.maps
-
Provides internal map types used in macro extraction and message formatting.
- com.winterhavenmc.library.messagebuilder.pipeline.matcher - package com.winterhavenmc.library.messagebuilder.pipeline.matcher
-
Provides utilities for identifying macro placeholders within message strings.
- com.winterhavenmc.library.messagebuilder.pipeline.processor - package com.winterhavenmc.library.messagebuilder.pipeline.processor
-
Defines the final stage in the message processing pipeline, responsible for converting a structured
ValidMessageRecord
into a fully resolvedFinalMessageRecord
. - com.winterhavenmc.library.messagebuilder.pipeline.replacer - package com.winterhavenmc.library.messagebuilder.pipeline.replacer
-
Contains interfaces and classes responsible for replacing macros in message strings using resolved values from a
MacroObjectMap
. - com.winterhavenmc.library.messagebuilder.pipeline.resolvers - package com.winterhavenmc.library.messagebuilder.pipeline.resolvers
-
Provides a hierarchy of
Resolver
implementations responsible for converting macro-related input values into string representations for use in templated messages. - com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname - package com.winterhavenmc.library.messagebuilder.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.pipeline.retriever - package com.winterhavenmc.library.messagebuilder.pipeline.retriever
-
Defines the entry point to the message pipeline, responsible for retrieving
MessageRecord
instances from a configuration-backed query system. - com.winterhavenmc.library.messagebuilder.pipeline.sender - package com.winterhavenmc.library.messagebuilder.pipeline.sender
-
Defines the final dispatch stage in the message pipeline, responsible for delivering resolved and formatted messages to recipients.
- com.winterhavenmc.library.messagebuilder.query - package com.winterhavenmc.library.messagebuilder.query
-
This package contains the QueryHandler interface and implementations for the language file sections.
- com.winterhavenmc.library.messagebuilder.resources - package com.winterhavenmc.library.messagebuilder.resources
-
This package contains packages that pertain to resources and their handlers.
- com.winterhavenmc.library.messagebuilder.resources.configuration - package com.winterhavenmc.library.messagebuilder.resources.configuration
-
Provides configuration accessors for server-defined language, locale, and timezone settings.
- com.winterhavenmc.library.messagebuilder.resources.language - package com.winterhavenmc.library.messagebuilder.resources.language
-
This package encapsulates the handling and querying of a language resource.
- com.winterhavenmc.library.messagebuilder.util - package com.winterhavenmc.library.messagebuilder.util
-
This package contains utility classes, interfaces and enums used by the library.
- com.winterhavenmc.library.messagebuilder.validation - package com.winterhavenmc.library.messagebuilder.validation
-
Provides a flexible, localized validation framework for use within the MessageBuilder library.
- com.winterhavenmc.library.time - package com.winterhavenmc.library.time
- COMMAND_SENDER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.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.pipeline.resolvers
- CompositeResolver(AdapterRegistry, FieldExtractor) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.CompositeResolver
-
Constructs a
CompositeResolver
with the given adapter registry and field extractor. - Compound-field Adapters - Search tag in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter.BuiltIn
- Section
- CONFIG_LANGUAGE_KEY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.resources.language.LanguageSetting
- CONFIG_LOCALE_KEY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.resources.language.LanguageSetting
- ConfigProvider<T> - Interface in com.winterhavenmc.library.messagebuilder.resources.configuration
-
Represents a functional interface for retrieving dynamic configuration values.
- CONFIGURATION_SUPPLIER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- ConstantQueryHandler - Class in com.winterhavenmc.library.messagebuilder.query
-
Query handler for the 'CONSTANTS' section of the language file.
- ConstantQueryHandler(SectionProvider) - Constructor for class com.winterhavenmc.library.messagebuilder.query.ConstantQueryHandler
-
Class constructor
- ConstantRecord - Interface in com.winterhavenmc.library.messagebuilder.model.language
-
A sealed interface representing a key–value pair loaded from the
CONSTANTS
section of a language YAML file. - ConstantResolver - Class in com.winterhavenmc.library.messagebuilder
-
A class that allows clients of the library to access values in the constants section of the language file
- CONSTANTS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.Section
- containsKey(MacroKey) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroStringMap
-
Returns
true
if this map contains the specified key. - CONTEXT_MAP - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- convert(long, TimeUnit) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- Cooldown - Interface in com.winterhavenmc.library.messagebuilder.pipeline.cooldown
-
A functional interface representing a cooldown check for a given key.
- CooldownKey - Class in com.winterhavenmc.library.messagebuilder.pipeline.cooldown
-
An implementation of a key for use in the cooldown map.
- CooldownMap - Class in com.winterhavenmc.library.messagebuilder.pipeline.cooldown
-
An implementation of
Cooldown
that maintains a per-message cooldown map. - CooldownMap() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.cooldown.CooldownMap
- Core Concepts - Search tag in package com.winterhavenmc.library.messagebuilder.validation
- Section
- create(RecordKey, Object) - Static method in class com.winterhavenmc.library.messagebuilder.model.language.ValidConstantRecord
-
Creates a
ValidConstantRecord
from the provided key and value. - create(RecordKey, ConfigurationSection) - Static method in class com.winterhavenmc.library.messagebuilder.model.language.ValidItemRecord
-
Creates a
ValidItemRecord
from a configuration section. - create(RecordKey, ConfigurationSection) - Static method in class com.winterhavenmc.library.messagebuilder.model.language.ValidMessageRecord
-
Creates a
ValidMessageRecord
from a YAML configuration section. - create(Plugin) - Static method in class com.winterhavenmc.library.messagebuilder.MessageBuilder
-
A static factory method for instantiating this class.
- create(Plugin) - Static method in class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageProvider
-
Creates a
LanguageProvider
by reading the configuration from the given plugin. - create(Plugin) - Static method in class com.winterhavenmc.library.messagebuilder.resources.configuration.LocaleProvider
-
Factory method to construct a
LocaleProvider
using a plugin's configuration. - createHandler(SectionProvider) - Method in enum class com.winterhavenmc.library.messagebuilder.model.language.Section
-
Retrieve an instance of the section query handler that is bound to this enum constant from the enum map.
D
- DAYS - Enum constant in enum class com.winterhavenmc.library.time.TimeUnit
- DEBUG - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.LogLevel
-
A fine-grained debug message.
- DEFAULT_LANGUAGE_TAG - Enum constant in enum class com.winterhavenmc.library.messagebuilder.resources.language.LanguageSetting
- DefaultResolver - Class in com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname
-
Default implementation of
WorldNameResolver
that returns the raw name of aWorld
usingWorld#getName()
. - DefaultResolver() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname.DefaultResolver
- DefaultRetriever - Class in com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname
-
A
WorldNameRetriever
implementation that retrieves the alias name of aWorld
using the Multiverse-Core API. - DefaultRetriever() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname.DefaultRetriever
- DELEGATE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- Delimiter - Enum Class in com.winterhavenmc.library.messagebuilder.util
-
An Enum containing the placeholder delimiters
- DEPENDENCY_CONTEXT - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- Design and Behavior - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.cooldown
- Section
- Design Highlights - Search tag in package com.winterhavenmc.library.messagebuilder
- Section
- Design Notes - Search tag in package com.winterhavenmc.library.messagebuilder.model.language
- Section
- Design Overview - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.resolvers
- Section
- DISPLAY_NAME - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter.BuiltIn
- DisplayNameable - Interface in com.winterhavenmc.library.messagebuilder.pipeline.adapters.displayname
-
An interface representing objects that expose a display name for macro replacement.
- DisplayNameAdapter - Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters.displayname
-
Adapter implementation for extracting display names from supported object types.
- DisplayNameAdapter(AdapterContextContainer) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.adapters.displayname.DisplayNameAdapter
-
Constructs a new
DisplayNameAdapter
with the given context container. - duration() - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.BoundedDuration
-
Returns the value of the
duration
record component. - DURATION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter.BuiltIn
- DURATION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- Durationable - Interface in com.winterhavenmc.library.messagebuilder.pipeline.adapters.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.pipeline.adapters.duration
-
Adapter for objects that expose a
Duration
via theDurationable
interface. - DurationAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.adapters.duration.DurationAdapter
- durationFormatter() - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.formatters.FormatterContainer
-
Returns the value of the
durationFormatter
record component. - DurationFormatter - Interface in com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration
-
Formats
Duration
values into localized human-readable strings. - DurationType - Enum Class in com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration
-
Enumeration representing the classification of a
Duration
for use in formatting logic and conditional display of duration-related values. - durationUntil(Instant) - Static method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.duration.Durationable
-
Computes the duration from the current moment until the given
Instant
.
E
- empty() - Static method in record class com.winterhavenmc.library.messagebuilder.model.message.InvalidMessage
-
Returns a reusable
InvalidMessage
instance representing an empty message caused by anull
recipient passed to thecompose()
method. - empty() - Static method in interface com.winterhavenmc.library.messagebuilder.model.message.Message
-
Returns an empty
Message
instance that performs no action when sent. - empty() - Static method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroStringMap
-
Returns a new, empty
MacroStringMap
. - empty(RecordKey) - Static method in interface com.winterhavenmc.library.messagebuilder.model.language.ConstantRecord
-
Returns an
InvalidConstantRecord
representing a missing or null constant entry. - empty(RecordKey) - Static method in interface com.winterhavenmc.library.messagebuilder.model.language.ItemRecord
-
Returns an
InvalidItemRecord
representing a missing or unresolved item section. - empty(RecordKey) - Static method in interface com.winterhavenmc.library.messagebuilder.model.language.MessageRecord
-
Returns an
InvalidMessageRecord
representing a missing or invalid message definition. - enabled() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns the value of the
enabled
record component. - enabled() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidMessageRecord
- ENABLED - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.MessageRecord.Field
- ENTITY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- entrySet() - Method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroStringMap
-
Returns the set of key-value entries in this map.
- equals(Object) - Method in class com.winterhavenmc.library.messagebuilder.keys.AbstractKey
-
Test for equality.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidConstantRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidItemRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidMessageRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidConstantRecord
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.model.message.InvalidMessage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Invalid
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Proxied
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Valid
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.adapters.AdapterContextContainer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.cooldown.CooldownKey
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.BoundedDuration
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.formatters.FormatterContainer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageSetting
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.resources.configuration.LocaleSetting
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.validation.Logging
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.winterhavenmc.library.messagebuilder.validation.Throwing
-
Indicates whether some other object is "equal to" this one.
- ERROR - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.LogLevel
-
A serious error that should be brought to immediate attention.
- ErrorMessageKey - Enum Class in com.winterhavenmc.library.messagebuilder.validation
-
Enumeration of structured keys used to identify localized error messages for validation and configuration-related exceptions.
- exceptionSupplier() - Method in record class com.winterhavenmc.library.messagebuilder.validation.Throwing
-
Returns the value of the
exceptionSupplier
record component. - Expirable - Interface in com.winterhavenmc.library.messagebuilder.pipeline.adapters.expiration
-
Provides an adapter for objects that expose an expiration
Instant
. - EXPIRATION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter.BuiltIn
- ExpirationAdapter - Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters.expiration
-
Adapter for objects that implement the
Expirable
interface. - ExpirationAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.adapters.expiration.ExpirationAdapter
- extract(MacroKey, Adapter, T) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.extractor.Extractor
-
Extracts a set of macro string values from an adapted object and returns a map of placeholder keys to replacement strings.
- extract(MacroKey, Adapter, T) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.extractor.FieldExtractor
-
Extracts macro string values from the adapted object using the adapter's corresponding interface, such as
Nameable
orLocatable
. - extractDisplayName(MacroKey, AdapterContextContainer) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.displayname.DisplayNameable
-
Extracts a
MacroStringMap
containing the formatted display name under theDISPLAY_NAME
subkey of the given base key. - extractDuration(MacroKey, ChronoUnit, AdapterContextContainer) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.duration.Durationable
-
Extracts a
MacroStringMap
containing a single entry mapping the providedMacroKey
(with.DURATION
appended) to a localized string representation of this object's duration. - extractExpiration(MacroKey, ChronoUnit, FormatStyle, AdapterContextContainer) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.expiration.Expirable
-
Extracts macro key-value pairs for this object's expiration, including a formatted duration and a formatted instant string.
- extractInstant(MacroKey, FormatStyle, AdapterContextContainer) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.instant.Instantable
-
Extracts a formatted timestamp field from this
Instantable
, based on the givenFormatStyle
and locale context. - extractKiller(MacroKey, AdapterContextContainer) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.killer.Killable
-
Extracts a macro string map with the killer's name, using the given base key and context.
- extractLocation(MacroKey, AdapterContextContainer) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.location.Locatable
-
Extracts macro key-value pairs representing location data from this object.
- extractLooter(MacroKey, AdapterContextContainer) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.looter.Lootable
-
Extracts the looter's name as a macro replacement field.
- extractName(MacroKey, AdapterContextContainer) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.name.Nameable
-
Extracts the name field into a
MacroStringMap
, using the provided base key to construct a dot-notated macro key (e.g.,OBJECT.NAME
). - Extractor - Interface in com.winterhavenmc.library.messagebuilder.pipeline.extractor
-
Functional interface representing a strategy for extracting macro-replaceable fields from an object that has been successfully adapted by a given
Adapter
. - extractOwner(MacroKey, AdapterContextContainer) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.owner.Ownable
-
Extracts the macro value for the owner's name and adds it to a
MacroStringMap
, using the{OBJECT.OWNER}
key. - extractProtection(MacroKey, ChronoUnit, FormatStyle, AdapterContextContainer) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.protection.Protectable
-
Extracts protection-related fields from this object into a
MacroStringMap
. - extractQuantity(MacroKey, AdapterContextContainer) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.quantity.Quantifiable
-
Extracts a
MacroStringMap
containing the formatted quantity string. - extractUid(MacroKey, AdapterContextContainer) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.uuid.Identifiable
-
Extracts a macro string map containing the UUID field.
F
- Factory Methods - Search tag in interface com.winterhavenmc.library.messagebuilder.model.language.MessageRecord
- Section
- FAIL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.resources.ResourceInstaller.InstallerStatus
- Fallback Behavior - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration
- Section
- FieldExtractor - Class in com.winterhavenmc.library.messagebuilder.pipeline.extractor
-
Default implementation of the
Extractor
interface that delegates field extraction to the appropriate functional interface based on the adapter type. - FieldExtractor(AdapterContextContainer) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.extractor.FieldExtractor
-
Constructs a new
FieldExtractor
with the provided context container. - FieldResolver - Class in com.winterhavenmc.library.messagebuilder.pipeline.resolvers
- FieldResolver(List<Resolver>) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.FieldResolver
-
Constructs a
FieldResolver
with the given list of delegate resolvers. - FILE_EXISTS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.resources.ResourceInstaller.InstallerStatus
- FinalMessageRecord - Record Class in com.winterhavenmc.library.messagebuilder.model.language
-
A
MessageRecord
representing a fully constructed, macro-resolved message ready for delivery to a recipient. - FinalMessageRecord(RecordKey, boolean, String, Duration, String, int, int, int, String, Optional<String>, Optional<String>, Optional<String>) - Constructor for record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Creates an instance of a
FinalMessageRecord
record class. - finalMessageString() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns the value of the
finalMessageString
record component. - finalSubtitleString() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns the value of the
finalSubtitleString
record component. - finalTitleString() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns the value of the
finalTitleString
record component. - Fluent Macro Assignment - Search tag in interface com.winterhavenmc.library.messagebuilder.model.message.Message
- Section
- format(Duration, ChronoUnit) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.DurationFormatter
- format(Duration, ChronoUnit) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.LocalizedDurationFormatter
-
Formats a
Duration
into a localized string, applying special handling for unlimited or too-small durations. - format(Duration, ChronoUnit) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.Time4jDurationFormatter
-
Formats a
Duration
using Time4J'sPrettyTime
engine. - formatDisplayName(String) - Static method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.displayname.DisplayNameable
-
Attempts to format and return a display name if valid.
- formatDuration(Duration, ChronoUnit, DurationFormatter) - Static method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.duration.Durationable
-
Uses the configured
DurationFormatter
to format the givenDuration
according to the specified precision. - formatInstant(Instant, FormatStyle, LocaleProvider) - Static method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.instant.Instantable
-
Formats the provided
Instant
using the specifiedFormatStyle
and locale. - formatKiller(Entity) - Static method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.killer.Killable
-
Formats the killer name for use in placeholder replacement.
- formatLocation(Location, AdapterContextContainer) - Static method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.location.Locatable
-
Produces a formatted string representation of the given location, consisting of the world name followed by localized coordinates.
- formatLooter(Entity) - Static method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.looter.Lootable
-
Formats the looter name for placeholder substitution.
- formatMessage(ErrorMessageKey, Parameter) - Static method in interface com.winterhavenmc.library.messagebuilder.validation.Validator
-
Formats a localized error message using the specified key and parameter.
- formatName(String) - Static method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.name.Nameable
-
Formats the given name string, returning it as an
Optional
if valid. - formatOwner(AnimalTamer) - Static method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.owner.Ownable
-
Returns a formatted string representing the owner's name, if available and valid.
- formatQuantity(int, NumberFormatter) - Static method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.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.validation.Parameter
- formatterContainer() - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.adapters.AdapterContextContainer
-
Returns the value of the
formatterContainer
record component. - FormatterContainer - Record Class in com.winterhavenmc.library.messagebuilder.pipeline.formatters
- FormatterContainer(LocaleProvider, DurationFormatter, LocaleNumberFormatter) - Constructor for record class com.winterhavenmc.library.messagebuilder.pipeline.formatters.FormatterContainer
-
Creates an instance of a
FormatterContainer
record class. - formatUid(UUID) - Static method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.uuid.Identifiable
-
Returns an optional string representation of a UUID.
- from(RecordKey, Object) - Static method in interface com.winterhavenmc.library.messagebuilder.model.language.ConstantRecord
-
Factory method that attempts to create a
ConstantRecord
from the given value. - from(RecordKey, ConfigurationSection) - Static method in interface com.winterhavenmc.library.messagebuilder.model.language.ItemRecord
-
Creates an
ItemRecord
from the given configuration section. - from(RecordKey, ConfigurationSection) - Static method in interface com.winterhavenmc.library.messagebuilder.model.language.MessageRecord
-
Factory method that constructs a
MessageRecord
from a YAML configuration section. - FULL_KEY_PATTERN - Static variable in class com.winterhavenmc.library.messagebuilder.pipeline.replacer.MacroReplacer
-
Pattern used to match fully qualified macro placeholders (e.g.,
%ITEM.NAME_SINGULAR%
) for the purpose of final string replacement.
G
- get() - Method in interface com.winterhavenmc.library.messagebuilder.resources.configuration.ConfigProvider
- get() - Method in class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageProvider
-
Returns the current
LanguageSetting
. - get() - Method in class com.winterhavenmc.library.messagebuilder.resources.configuration.LocaleProvider
-
Returns the resolved
LocaleSetting
based on the plugin configuration. - get(MacroKey) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroObjectMap
-
Retrieves the value associated with the specified
MacroKey
, if present. - get(MacroKey) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroStringMap
-
Returns the value associated with the given key, or
null
if not found. - get(PluginManager) - Static method in interface com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname.WorldNameResolver
-
Returns an appropriate
WorldNameResolver
implementation based on the availability of theMultiverse-Core
plugin. - getBase() - Method in class com.winterhavenmc.library.messagebuilder.keys.MacroKey
- getBoolean(String) - Method in class com.winterhavenmc.library.messagebuilder.ConstantResolver
-
Retrieves an Optional Boolean from the constants section of the language file
- getConfiguredLanguageTag() - Method in class com.winterhavenmc.library.messagebuilder.resources.language.LanguageResourceLoader
-
Gets language tag specified in config.yml.
- getConfiguredLanguageTag() - Method in interface com.winterhavenmc.library.messagebuilder.resources.ResourceLoader
-
Gets language tag specified in config.yml.
- getConfiguredLocale() - Method in class com.winterhavenmc.library.messagebuilder.resources.language.LanguageResourceLoader
- getConfiguredLocale() - Method in interface com.winterhavenmc.library.messagebuilder.resources.ResourceLoader
- getConstantResolver() - Method in class com.winterhavenmc.library.messagebuilder.MessageBuilder
- getDisplayName() - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.displayname.DisplayNameable
-
Returns the display name associated with this object.
- getDisplayName() - Method in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
-
Returns the canonical display name for this parameter, as used in localized error messages.
- getDuration() - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.duration.Durationable
-
Returns the duration value associated with this object.
- getDuration() - Method in class com.winterhavenmc.library.time.Tick
- getExpiration() - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.expiration.Expirable
-
Returns the expiration timestamp for this object.
- getFileName(LanguageTag) - Static method in class com.winterhavenmc.library.messagebuilder.resources.language.LanguageResourceManager
-
Retrieve the name of the potential language resource file as installed in the plugin data directory, as a String.
- getFormatted(Number) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.formatters.number.LocaleNumberFormatter
-
Formats the specified number using the
NumberFormat
instance associated with the locale provided by theLocaleProvider
. - getFormatted(Number) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.formatters.number.NumberFormatter
-
Formats the provided
Number
using a locale-specific format. - getInstant() - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.instant.Instantable
-
Returns the
Instant
that this object represents. - getInt(RecordKey) - Method in class com.winterhavenmc.library.messagebuilder.query.ConstantQueryHandler
-
Query the constants section of the language file for an
int
with the keyPath - getInteger(String) - Method in class com.winterhavenmc.library.messagebuilder.ConstantResolver
-
Retrieves an Optional Integer from the constants section of the language file
- getKiller() - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.killer.Killable
-
Returns the killer of this object, typically a
Player
. - getLanguageTag() - Method in class com.winterhavenmc.library.messagebuilder.resources.configuration.LocaleProvider
-
Returns the resolved
LanguageTag
representing the locale tag. - getLocale() - Method in class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageTag
-
Retrieve the
Locale
associated with this language tag - getLocale() - Method in class com.winterhavenmc.library.messagebuilder.resources.configuration.LocaleProvider
-
Returns the
Locale
object derived from the configuration. - getLocale() - Method in record class com.winterhavenmc.library.messagebuilder.resources.configuration.LocaleSetting
-
Returns the
Locale
corresponding to the encapsulatedLanguageTag
. - getLocale() - Static method in class com.winterhavenmc.library.messagebuilder.validation.ValidationContext
-
Returns the current locale used for formatting validation messages.
- getLocation() - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.location.Locatable
-
Returns the Bukkit
Location
associated with this object. - getLocationWorldName(Location, AdapterContextContainer) - Static method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.location.Locatable
-
Resolves the name of the world for the given
Location
. - getLooter() - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.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.pipeline.adapters.AdapterRegistry
-
Returns a stream of all registered
Adapter
instances that support the given object. - getMessage() - Method in exception class com.winterhavenmc.library.messagebuilder.validation.ValidationException
-
Returns the localized message for this validation exception.
- getMessageKey() - Method in record class com.winterhavenmc.library.messagebuilder.model.message.InvalidMessage
- getMessageKey() - Method in interface com.winterhavenmc.library.messagebuilder.model.message.Message
-
Returns the
RecordKey
identifying the message template used in composition. - getMessageKey() - Method in class com.winterhavenmc.library.messagebuilder.model.message.ValidMessage
- getMessageKey() - Method in class com.winterhavenmc.library.messagebuilder.pipeline.cooldown.CooldownKey
-
Retrieve the message key used for this cooldown key
- getMillis() - Method in enum class com.winterhavenmc.library.time.TimeUnit
-
Get the number of milliseconds for each time unit.
- getName() - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.name.Nameable
-
Returns the name associated with the implementing object.
- getName() - Method in class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageProvider
-
Returns the configured language file name string (e.g.,
en-US
). - getObjectMap() - Method in record class com.winterhavenmc.library.messagebuilder.model.message.InvalidMessage
- getObjectMap() - Method in interface com.winterhavenmc.library.messagebuilder.model.message.Message
-
Returns the
MacroObjectMap
of macro values bound to this message. - getObjectMap() - Method in class com.winterhavenmc.library.messagebuilder.model.message.ValidMessage
- getOwner() - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.owner.Ownable
-
Returns the
AnimalTamer
representing the owner of this object. - getProtection() - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.protection.Protectable
-
Returns the protection
Instant
, representing the moment at which protection ends or expires. - getQuantity() - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.quantity.Quantifiable
-
Returns the numeric quantity associated with this object.
- getQueryHandler(Section) - Method in class com.winterhavenmc.library.messagebuilder.query.QueryHandlerFactory
-
Retrieve query handler for section
- getRecipient() - Method in record class com.winterhavenmc.library.messagebuilder.model.message.InvalidMessage
- getRecipient() - Method in interface com.winterhavenmc.library.messagebuilder.model.message.Message
-
Returns the
Recipient.Sendable
to whom the message will be sent. - getRecipient() - Method in class com.winterhavenmc.library.messagebuilder.model.message.ValidMessage
- getRecord(RecordKey) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.retriever.MessageRetriever
-
Retrieves a
MessageRecord
for the given key using the underlyingQueryHandler
. - getRecord(RecordKey) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.retriever.Retriever
- getRecord(RecordKey) - Method in class com.winterhavenmc.library.messagebuilder.query.ConstantQueryHandler
-
Stub method until implemented
- getRecord(RecordKey) - Method in class com.winterhavenmc.library.messagebuilder.query.ItemQueryHandler
-
Retrieve an item record from the language file for the currently configured language.
- getRecord(RecordKey) - Method in class com.winterhavenmc.library.messagebuilder.query.MessageQueryHandler
-
Retrieve a message record from the language file for the provided key
- getRecord(RecordKey) - Method in interface com.winterhavenmc.library.messagebuilder.query.QueryHandler
- getResourceName(LanguageTag) - Static method in class com.winterhavenmc.library.messagebuilder.resources.language.LanguageResourceManager
-
Constructs the resource path (in the JAR) for a given language tag, e.g.
- getSection() - Method in class com.winterhavenmc.library.messagebuilder.resources.language.LanguageSectionProvider
- getSection() - Method in interface com.winterhavenmc.library.messagebuilder.resources.language.SectionProvider
- getSectionProvider(Section) - Method in class com.winterhavenmc.library.messagebuilder.resources.language.LanguageResourceManager
-
Retrieve the configuration provider, a container that carries the current configuration
- getSectionProvider(Section) - Method in interface com.winterhavenmc.library.messagebuilder.resources.language.SectionResourceManager
- getString(RecordKey) - Method in class com.winterhavenmc.library.messagebuilder.query.ConstantQueryHandler
-
Query the constants section of the language file for a String with keyPath
- getString(String) - Method in class com.winterhavenmc.library.messagebuilder.ConstantResolver
-
Retrieves an Optional String from the constants section of the language file
- getStringList(RecordKey) - Method in class com.winterhavenmc.library.messagebuilder.query.ConstantQueryHandler
-
Query the constants section of the language file for a List of String with the keyPath
- getSystemDefault() - Static method in class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageTag
-
Get the system default locale expressed as a LanguageTag
- getUniqueId() - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.uuid.Identifiable
-
Returns the unique ID for this object.
- getWorldName(World) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname.DefaultRetriever
-
Attempts to retrieve the alias name of the given
World
using the Multiverse world manager. - getWorldName(World) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname.Multiverse4Retriever
-
Attempts to retrieve the alias name of the given
World
using the Multiverse world manager. - getWorldName(World) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname.Multiverse5Retriever
-
Attempts to retrieve the alias or name of the given
World
using the Multiverse world manager. - getWorldName(World) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname.WorldNameRetriever
- getZoneId() - Method in class com.winterhavenmc.library.messagebuilder.resources.configuration.LocaleProvider
-
Returns the configured
ZoneId
if valid, or the system default otherwise.
H
- handleInvalid(T) - Method in record class com.winterhavenmc.library.messagebuilder.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.validation.Throwing
-
Throws the supplied exception when the value is invalid.
- handleInvalid(T) - Method in interface com.winterhavenmc.library.messagebuilder.validation.Validator
-
Handles an invalid value detected during validation.
- hashCode() - Method in class com.winterhavenmc.library.messagebuilder.keys.AbstractKey
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidConstantRecord
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidItemRecord
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidMessageRecord
-
Returns a hash code value for this object.
- hashCode() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidConstantRecord
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.model.message.InvalidMessage
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Invalid
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Proxied
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Valid
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.adapters.AdapterContextContainer
-
Returns a hash code value for this object.
- hashCode() - Method in class com.winterhavenmc.library.messagebuilder.pipeline.cooldown.CooldownKey
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.BoundedDuration
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.formatters.FormatterContainer
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageSetting
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.resources.configuration.LocaleSetting
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.validation.Logging
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.winterhavenmc.library.messagebuilder.validation.Throwing
-
Returns a hash code value for this object.
- HOURS - Enum constant in enum class com.winterhavenmc.library.time.TimeUnit
I
- Identifiable - Interface in com.winterhavenmc.library.messagebuilder.pipeline.adapters.uuid
-
Represents an object that exposes a unique
UUID
. - Immutability and Thread Safety - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.maps
- Section
- Implementations - Search tag in interface com.winterhavenmc.library.messagebuilder.model.language.ConstantRecord
- Section
- Implementations - Search tag in interface com.winterhavenmc.library.messagebuilder.model.language.ItemRecord
- Section
- Implementations - Search tag in interface com.winterhavenmc.library.messagebuilder.model.language.MessageRecord
- Section
- Implementations - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration
- Section
- INFO - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.LogLevel
-
A standard informational message.
- initialize(LocaleProvider) - Static method in class com.winterhavenmc.library.messagebuilder.validation.ValidationContext
-
Initializes the validation context with the provided locale source.
- initiate(ValidMessage) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.MessagePipeline
- initiate(ValidMessage) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.Pipeline
- INSTANT - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter.BuiltIn
- Instantable - Interface in com.winterhavenmc.library.messagebuilder.pipeline.adapters.instant
-
An interface for types that expose a single
Instant
value, such as a timestamp for creation, expiration, modification, or other moments in time. - InstantAdapter - Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters.instant
-
An adapter that supports any object implementing the
Instantable
interface. - InstantAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.adapters.instant.InstantAdapter
- Invalid(CommandSender, Recipient.InvalidReason) - Constructor for record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Invalid
-
Creates an instance of a
Invalid
record class. - INVALID_SECTION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.ErrorMessageKey
-
Indicates that a required configuration section is invalid or missing.
- InvalidConstantRecord - Record Class in com.winterhavenmc.library.messagebuilder.model.language
-
A
ConstantRecord
representing a missing or invalid constant from theCONSTANTS
section of a language YAML file. - InvalidConstantRecord(RecordKey, String) - Constructor for record class com.winterhavenmc.library.messagebuilder.model.language.InvalidConstantRecord
-
Creates an instance of a
InvalidConstantRecord
record class. - InvalidItemRecord - Record Class in com.winterhavenmc.library.messagebuilder.model.language
-
An
ItemRecord
representing a missing or invalid item entry from theITEMS
section of a language YAML file. - InvalidItemRecord(RecordKey, String) - Constructor for record class com.winterhavenmc.library.messagebuilder.model.language.InvalidItemRecord
-
Creates an instance of a
InvalidItemRecord
record class. - InvalidMessage - Record Class in com.winterhavenmc.library.messagebuilder.model.message
-
A fallback
Message
implementation representing an invalid or unrenderable message. - InvalidMessage(String) - Constructor for record class com.winterhavenmc.library.messagebuilder.model.message.InvalidMessage
-
Creates an instance of a
InvalidMessage
record class. - InvalidMessageRecord - Record Class in com.winterhavenmc.library.messagebuilder.model.language
-
A
MessageRecord
representing a missing or invalid entry from theMESSAGES
section of a language file. - InvalidMessageRecord(RecordKey, String) - Constructor for record class com.winterhavenmc.library.messagebuilder.model.language.InvalidMessageRecord
-
Creates an instance of a
InvalidMessageRecord
record class. - invalidReason() - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Invalid
-
Returns the value of the
invalidReason
record component. - INVENTORY_NAME_PLURAL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.ItemRecord.Field
- INVENTORY_NAME_SINGULAR - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.ItemRecord.Field
- IS_INVALID_KEY - Static variable in class com.winterhavenmc.library.messagebuilder.keys.AbstractKey
- isDateBased() - Method in class com.winterhavenmc.library.time.Tick
- isDurationEstimated() - Method in class com.winterhavenmc.library.time.Tick
- isEmpty() - Method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroStringMap
-
Returns
true
if this map is empty. - isGreaterThan(long) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- isGreaterThan(TimeUnit) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- isLessThan(long) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- isLessThan(TimeUnit) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- isLessThan(Duration, ChronoUnit) - Static method in enum class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.DurationType
-
Checks if the given duration is shorter than the provided precision threshold.
- isTimeBased() - Method in class com.winterhavenmc.library.time.Tick
- isUnlimited(Duration) - Static method in enum class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.DurationType
-
Checks if the given duration should be treated as "unlimited" (i.e., negative).
- ITEM_SECTION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- ItemQueryHandler - Class in com.winterhavenmc.library.messagebuilder.query
-
Handles queries for item records from the current language file.
- ItemQueryHandler(SectionProvider) - Constructor for class com.winterhavenmc.library.messagebuilder.query.ItemQueryHandler
-
Class constructor
- ItemRecord - Interface in com.winterhavenmc.library.messagebuilder.model.language
-
A sealed interface representing a record loaded from the
ITEMS
section of a language YAML file. - ItemRecord.Field - Enum Class in com.winterhavenmc.library.messagebuilder.model.language
-
Enumeration of field keys within an
ItemRecord
, mapping enum constants to their corresponding YAML key paths. - ITEMS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.Section
J
- justShyOf(int) - Method in enum class com.winterhavenmc.library.time.TimeUnit
K
- key() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns the value of the
key
record component. - key() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidConstantRecord
-
Returns the value of the
key
record component. - key() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidItemRecord
-
Returns the value of the
key
record component. - key() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidMessageRecord
-
Returns the value of the
key
record component. - key() - Method in interface com.winterhavenmc.library.messagebuilder.model.language.SectionRecord
- key() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidConstantRecord
- key() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidItemRecord
- key() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidMessageRecord
- KEY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- Key Components - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.matcher
- Section
- Key Components - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.processor
- Section
- Key Components - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.replacer
- Section
- Key Components - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.retriever
- Section
- Key Components - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.sender
- Section
- Key Components - Search tag in package com.winterhavenmc.library.messagebuilder.resources.configuration
- Section
- Key Concepts - Search tag in package com.winterhavenmc.library.messagebuilder
- Section
- keySet() - Method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroStringMap
-
Returns the set of keys contained in this map.
- Killable - Interface in com.winterhavenmc.library.messagebuilder.pipeline.adapters.killer
-
An interface for objects that provide information about the entity that killed them.
- KILLER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter.BuiltIn
- KillerAdapter - Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters.killer
-
Adapter that maps supported objects to the
Killable
interface for macro extraction. - KillerAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.adapters.killer.KillerAdapter
L
- LANGUAGE_FILE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- LANGUAGE_QUERY_HANDLER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- LANGUAGE_RESOURCE_MANAGER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- LANGUAGE_TAG - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- LanguageProvider - Class in com.winterhavenmc.library.messagebuilder.resources.configuration
-
Provides a dynamic
LanguageSetting
derived from the plugin'sconfig.yml
. - LanguageResourceInstaller - Class in com.winterhavenmc.library.messagebuilder.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.
- LanguageResourceInstaller(Plugin) - Constructor for class com.winterhavenmc.library.messagebuilder.resources.language.LanguageResourceInstaller
-
Class constructor
- LanguageResourceLoader - Class in com.winterhavenmc.library.messagebuilder.resources.language
-
This class is responsible for the loading of the language file from the plugin data directory into a configuration object.
- LanguageResourceLoader(Plugin) - Constructor for class com.winterhavenmc.library.messagebuilder.resources.language.LanguageResourceLoader
-
Class constructor
- LanguageResourceLoader(Plugin, Supplier<YamlConfiguration>) - Constructor for class com.winterhavenmc.library.messagebuilder.resources.language.LanguageResourceLoader
-
Testable constructor allowing custom YamlConfiguration supplier.
- LanguageResourceManager - Class in com.winterhavenmc.library.messagebuilder.resources.language
-
This class is responsible for the management and lifecycle of the language resource.
- LanguageResourceManager(LanguageResourceInstaller, LanguageResourceLoader) - Constructor for class com.winterhavenmc.library.messagebuilder.resources.language.LanguageResourceManager
-
Class constructor
- LanguageSectionProvider - Class in com.winterhavenmc.library.messagebuilder.resources.language
- LanguageSectionProvider(Supplier<Configuration>, Section) - Constructor for class com.winterhavenmc.library.messagebuilder.resources.language.LanguageSectionProvider
- LanguageSetting - Enum Class in com.winterhavenmc.library.messagebuilder.resources.language
-
Enum containing constants for various yaml parameters
- LanguageSetting - Record Class in com.winterhavenmc.library.messagebuilder.resources.configuration
-
Represents a configured language file identifier.
- LanguageSetting(String) - Constructor for record class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageSetting
-
Creates an instance of a
LanguageSetting
record class. - languageTag() - Method in record class com.winterhavenmc.library.messagebuilder.resources.configuration.LocaleSetting
-
Returns the value of the
languageTag
record component. - LanguageTag - Class in com.winterhavenmc.library.messagebuilder.resources.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.
- LESS_THAN - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.DurationType
- load() - Method in class com.winterhavenmc.library.messagebuilder.resources.language.LanguageResourceLoader
-
Load the language configuration object for the configured language from file and return it.
- load() - Method in interface com.winterhavenmc.library.messagebuilder.resources.ResourceLoader
-
Load the language configuration object for the configured language from file and return it.
- loadWithFallback(LanguageTag, LanguageTag) - Method in class com.winterhavenmc.library.messagebuilder.resources.language.LanguageResourceLoader
-
Attempts to load the preferred language file from disk.
- LOCALE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- LOCALE_PROVIDER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- localeNumberFormatter() - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.formatters.FormatterContainer
-
Returns the value of the
localeNumberFormatter
record component. - LocaleNumberFormatter - Class in com.winterhavenmc.library.messagebuilder.pipeline.formatters.number
-
A locale-aware implementation of the
NumberFormatter
interface that formats numeric values using the default number format for the locale provided by aLocaleProvider
. - LocaleNumberFormatter(LocaleProvider) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.formatters.number.LocaleNumberFormatter
-
Constructs a new
LocaleNumberFormatter
with the given locale provider. - localeProvider() - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.formatters.FormatterContainer
-
Returns the value of the
localeProvider
record component. - LocaleProvider - Class in com.winterhavenmc.library.messagebuilder.resources.configuration
- LocaleSetting - Record Class in com.winterhavenmc.library.messagebuilder.resources.configuration
-
Represents a locale setting derived from a valid
LanguageTag
. - LocaleSetting(LanguageTag) - Constructor for record class com.winterhavenmc.library.messagebuilder.resources.configuration.LocaleSetting
-
Creates an instance of a
LocaleSetting
record class. - Localization - Search tag in package com.winterhavenmc.library.messagebuilder.validation
- Section
- LocalizedDurationFormatter - Class in com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration
-
A
DurationFormatter
implementation that localizes duration strings using configurable constants from the language file, while delegating formatting of standard durations to another formatter. - LocalizedDurationFormatter(DurationFormatter, QueryHandlerFactory) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.LocalizedDurationFormatter
-
Constructs a
LocalizedDurationFormatter
with a backing delegate and query handler factory. - Locatable - Interface in com.winterhavenmc.library.messagebuilder.pipeline.adapters.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.pipeline.adapters.location
-
Enumeration of subfields extractable from a
Location
. - LOCATION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter.BuiltIn
- LOCATION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- LocationAdapter - Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters.location
-
Adapter for objects that expose a
Location
, either directly or via aLocatable
interface. - LocationAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.adapters.location.LocationAdapter
- logging(LogLevel, ErrorMessageKey, Parameter) - Static method in interface com.winterhavenmc.library.messagebuilder.validation.Validator
-
Returns a handler that logs a validation warning or error using the specified log level, message key, and parameter.
- Logging<T> - Record Class in com.winterhavenmc.library.messagebuilder.validation
-
A
Validator
implementation 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.validation.Logging
-
Creates an instance of a
Logging
record class. - logLevel() - Method in record class com.winterhavenmc.library.messagebuilder.validation.Logging
-
Returns the value of the
logLevel
record component. - LogLevel - Enum Class in com.winterhavenmc.library.messagebuilder.validation
-
Represents standard log severity levels used for validation feedback and internal diagnostics.
- Lootable - Interface in com.winterhavenmc.library.messagebuilder.pipeline.adapters.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.pipeline.adapters.Adapter.BuiltIn
- LooterAdapter - Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters.looter
-
Adapter that converts supported objects into the
Lootable
interface for macro resolution. - LooterAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.adapters.looter.LooterAdapter
- LORE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.ItemRecord.Field
- LOWER_BOUND - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
M
- MACRO - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- MACRO_KEY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- MacroKey - Class in com.winterhavenmc.library.messagebuilder.keys
-
A type that represents a validated key for a macro.
- MacroObjectMap - Class in com.winterhavenmc.library.messagebuilder.pipeline.maps
- MacroObjectMap() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroObjectMap
- MacroReplacer - Class in com.winterhavenmc.library.messagebuilder.pipeline.replacer
-
Default implementation of the
Replacer
interface that performs macro substitution on input strings using values derived from aMacroObjectMap
. - MacroReplacer(Resolver, Matcher) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.replacer.MacroReplacer
-
Constructs a
MacroReplacer
with the given resolver and placeholder matcher. - MacroStringMap - Class in com.winterhavenmc.library.messagebuilder.pipeline.maps
-
A specialized map for storing string macro values keyed by
MacroKey
. - MacroStringMap() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroStringMap
-
Constructs an empty
MacroStringMap
. - Macro Support - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.adapters.location
- Section
- match(String, Pattern) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.matcher.Matcher
-
Extracts macro keys from the given input string using the specified regular expression pattern.
- match(String, Pattern) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.matcher.PlaceholderMatcher
- Matcher - Interface in com.winterhavenmc.library.messagebuilder.pipeline.matcher
-
A functional interface representing a strategy for extracting
MacroKey
instances from an input string using a specified regular expression pattern. - message() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns the value of the
message
record component. - message() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidMessageRecord
- Message - Interface in com.winterhavenmc.library.messagebuilder.model.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.validation.Parameter
- MESSAGE_ID - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- MESSAGE_PROCESSOR - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- MESSAGE_RECORD - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- MESSAGE_SECTION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- MESSAGE_STRING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- MESSAGE_TEXT - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.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.
- Message Implementations - Search tag in package com.winterhavenmc.library.messagebuilder.model.message
- Section
- messageKey() - Method in record class com.winterhavenmc.library.messagebuilder.validation.Logging
-
Returns the value of the
messageKey
record component. - MessagePipeline - Class in com.winterhavenmc.library.messagebuilder.pipeline
- MessagePipeline(MessageRetriever, MessageProcessor, CooldownMap, List<Sender>) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.MessagePipeline
- MessageProcessor - Class in com.winterhavenmc.library.messagebuilder.pipeline.processor
-
Default implementation of the
Processor
interface responsible for performing macro replacement on message fields. - MessageProcessor(Resolver, Matcher) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.processor.MessageProcessor
-
Constructs a
MessageProcessor
using the providedResolver
andMatcher
to configure the underlyingMacroReplacer
. - MessageQueryHandler - Class in com.winterhavenmc.library.messagebuilder.query
-
Handles queries for message records from the current language file.
- MessageQueryHandler(SectionProvider) - Constructor for class com.winterhavenmc.library.messagebuilder.query.MessageQueryHandler
-
Class constructor
- MessageRecord - Interface in com.winterhavenmc.library.messagebuilder.model.language
-
A sealed interface representing a structured message record loaded from the
MESSAGES
section of a language YAML file. - MessageRecord.Field - Enum Class in com.winterhavenmc.library.messagebuilder.model.language
-
Enum representing the fields defined in a
ValidMessageRecord
. - MessageRetriever - Class in com.winterhavenmc.library.messagebuilder.pipeline.retriever
-
Default implementation of the
Retriever
interface that retrieves aMessageRecord
using aQueryHandler
. - MessageRetriever(QueryHandler<MessageRecord>) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.retriever.MessageRetriever
-
Constructs a
MessageRetriever
using the specified query handler. - MESSAGES - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.Section
- MessageSender - Class in com.winterhavenmc.library.messagebuilder.pipeline.sender
-
Sends chat messages to a
Recipient.Sendable
based on the contents of aFinalMessageRecord
. - MessageSender(CooldownMap) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.sender.MessageSender
-
Constructs a
MessageSender
with the specified cooldown map for managing message repeat suppression. - MILLISECONDS - Enum constant in enum class com.winterhavenmc.library.time.TimeUnit
- MINUTES - Enum constant in enum class com.winterhavenmc.library.time.TimeUnit
- MISSING_LANGUAGE_FILE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.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.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.validation.ErrorMessageKey
-
Indicates a general failure to locate a required resource.
- MONTHS - Enum constant in enum class com.winterhavenmc.library.time.TimeUnit
- Multiverse4Retriever - Class in com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname
-
A
WorldNameRetriever
implementation that retrieves the alias name of aWorld
using the Multiverse-Core API. - Multiverse4Retriever(MultiverseCore) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname.Multiverse4Retriever
-
Constructs a
Multiverse4Retriever
with the given Multiverse-Core instance. - Multiverse5Retriever - Class in com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname
-
A
WorldNameRetriever
implementation that retrieves the alias name of aWorld
using the Multiverse-Core API. - Multiverse5Retriever(MultiverseCore) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname.Multiverse5Retriever
-
Constructs a
Multiverse4Retriever
with the given Multiverse-Core instance.
N
- name() - Method in record class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageSetting
-
Returns the value of the
name
record component. - NAME - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter.BuiltIn
- NAME - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- NAME_PLURAL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.ItemRecord.Field
- NAME_SINGULAR - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.ItemRecord.Field
- Nameable - Interface in com.winterhavenmc.library.messagebuilder.pipeline.adapters.name
-
A functional interface representing an object with a name field, commonly used in
Adapter
implementations that expose agetName()
method. - NameAdapter - Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters.name
-
An
Adapter
for extracting name information from objects that expose agetName()
method. - NameAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.adapters.name.NameAdapter
- nameFor(int) - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidItemRecord
-
Returns the appropriate name form (singular or plural) based on quantity.
- nameFor(int) - Method in interface com.winterhavenmc.library.messagebuilder.util.Pluralizable
- namePlural() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidItemRecord
- namePlural() - Method in interface com.winterhavenmc.library.messagebuilder.util.Pluralizable
- nameSingular() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidItemRecord
- nameSingular() - Method in interface com.winterhavenmc.library.messagebuilder.util.Pluralizable
- NORMAL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.DurationType
- notCooling(CooldownKey) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.cooldown.Cooldown
-
Determines if the given cooldown key is not currently cooling down.
- notCooling(CooldownKey) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.cooldown.CooldownMap
-
Checks whether the message corresponding to the given cooldown key is currently cooling down for a recipient.
- NULL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.InvalidReason
- NumberFormatter - Interface in com.winterhavenmc.library.messagebuilder.pipeline.formatters.number
-
A functional interface for formatting numeric values into localized
String
representations.
O
- of(Recipient.Sendable, RecordKey) - Static method in class com.winterhavenmc.library.messagebuilder.pipeline.cooldown.CooldownKey
-
Static factory method with Message parameter
- of(E) - Static method in class com.winterhavenmc.library.messagebuilder.keys.MacroKey
-
Static factory method for instantiating a record key from an enum constant
- of(E) - Static method in class com.winterhavenmc.library.messagebuilder.keys.RecordKey
-
Static factory method for instantiating a record key from an enum constant
- of(String) - Static method in class com.winterhavenmc.library.messagebuilder.keys.MacroKey
-
Static factory method for instantiating a record key from a string
- of(String) - Static method in class com.winterhavenmc.library.messagebuilder.keys.RecordKey
-
Static factory method for instantiating a record key from a string
- of(String) - Static method in class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageTag
-
Static factory method that creates a new validated LanguageTag from a String
- of(Locale) - Static method in class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageTag
-
Static factory method that creates a new LanguageTag from a Locale
- of(CommandSender) - Static method in interface com.winterhavenmc.library.messagebuilder.model.recipient.Recipient
-
Factory method that analyzes the given
CommandSender
and returns a categorizedRecipient
instance. - one() - Method in enum class com.winterhavenmc.library.time.TimeUnit
- OPEN - Enum constant in enum class com.winterhavenmc.library.messagebuilder.util.Delimiter
- OTHER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.InvalidReason
- Overview - Search tag in package com.winterhavenmc.library.messagebuilder.model.language
- Section
- Ownable - Interface in com.winterhavenmc.library.messagebuilder.pipeline.adapters.owner
-
Represents an object that has a concept of ownership, expressed through an
AnimalTamer
. - OWNER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter.BuiltIn
- OwnerAdapter - Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters.owner
-
Adapter that extracts ownership information from objects that either implement
Ownable
or areTameable
Bukkit entities. - OwnerAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.adapters.owner.OwnerAdapter
P
- parameter() - Method in record class com.winterhavenmc.library.messagebuilder.validation.Logging
-
Returns the value of the
parameter
record component. - Parameter - Enum Class in com.winterhavenmc.library.messagebuilder.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.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.validation.ErrorMessageKey
-
Indicates that a required parameter was
null
. - PARAMETER_TYPE_MISMATCH - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.ErrorMessageKey
-
Indicates that a parameter was of the wrong type.
- Pipeline - Interface in com.winterhavenmc.library.messagebuilder.pipeline
- PLACEHOLDER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- PlaceholderMatcher - Class in com.winterhavenmc.library.messagebuilder.pipeline.matcher
-
Default implementation of the
Matcher
interface that uses Java’s built-inPattern
andMatchResult
APIs to extract macro keys from an input string. - PlaceholderMatcher() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.matcher.PlaceholderMatcher
- PLUGIN - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- Plugin Extension - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.adapters
- Section
- Plugin Integration - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.adapters.name
- Section
- PluginResolver - Class in com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname
-
A
WorldNameResolver
implementation that retrieves world name aliases using the Multiverse-Core plugin. - PluginResolver(Plugin) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname.PluginResolver
-
Constructs a
MultiverseV4WorldNameResolver
using the given instance ofMultiverseCore
. - Pluralizable - Interface in com.winterhavenmc.library.messagebuilder.util
- precision() - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.BoundedDuration
-
Returns the value of the
precision
record component. - PRECISION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- process(ValidMessageRecord, MacroObjectMap) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.processor.MessageProcessor
-
Processes a
ValidMessageRecord
by replacing all macros in its fields using the providedMacroObjectMap
. - process(ValidMessageRecord, MacroObjectMap) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.processor.Processor
-
Processes a valid message record by replacing all macros using the provided macro object map.
- Processor - Interface in com.winterhavenmc.library.messagebuilder.pipeline.processor
-
A functional interface representing the final stage in the message pipeline: transforming a
ValidMessageRecord
into aFinalMessageRecord
by resolving and replacing all macro placeholders. - Protectable - Interface in com.winterhavenmc.library.messagebuilder.pipeline.adapters.protection
-
An interface representing objects that have a limited protection period, retrievable via an
Instant
timestamp. - PROTECTION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter.BuiltIn
- ProtectionAdapter - Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters.protection
-
An
Adapter
implementation for adapting objects that implement theProtectable
interface. - ProtectionAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.adapters.protection.ProtectionAdapter
- Proxied(CommandSender, ProxiedCommandSender) - Constructor for record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Proxied
-
Creates an instance of a
Proxied
record class. - proxy() - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Proxied
-
Returns the value of the
proxy
record component. - put(MacroKey, String) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroStringMap
-
Inserts a key-value pair into the map.
- put(MacroKey, T) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroObjectMap
-
Inserts a key-value pair into the map.
- putAll(MacroStringMap) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroStringMap
-
Inserts all entries from another
MacroStringMap
into this map. - putExpirationTime(Recipient.Sendable, FinalMessageRecord) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.cooldown.CooldownMap
-
Registers a new cooldown expiration time for the given message and recipient.
- putIfAbsent(MacroKey, String) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroStringMap
-
Inserts a key-value pair into the map only if the key is not already present.
- putIfAbsent(MacroKey, T) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroObjectMap
-
Inserts a key-value pair only if the key is not already present in the map.
Q
- Quantifiable - Interface in com.winterhavenmc.library.messagebuilder.pipeline.adapters.quantity
-
Represents objects that expose a numerical quantity for macro replacement.
- QUANTITY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter.BuiltIn
- QUANTITY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- QuantityAdapter - Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters.quantity
-
Adapter implementation for extracting quantity values from supported objects.
- QuantityAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.adapters.quantity.QuantityAdapter
- QUERY_HANDLER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- QueryHandler<T> - Interface in com.winterhavenmc.library.messagebuilder.query
-
An interface that declares a query handler that is typed constrained to implementations of the SectionRecord interface
- QueryHandlerFactory - Class in com.winterhavenmc.library.messagebuilder.query
- QueryHandlerFactory(SectionResourceManager) - Constructor for class com.winterhavenmc.library.messagebuilder.query.QueryHandlerFactory
-
Class constructor
R
- reason() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidConstantRecord
-
Returns the value of the
reason
record component. - reason() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidItemRecord
-
Returns the value of the
reason
record component. - reason() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidMessageRecord
-
Returns the value of the
reason
record component. - reason() - Method in record class com.winterhavenmc.library.messagebuilder.model.message.InvalidMessage
-
Returns the value of the
reason
record component. - Recipient - Interface in com.winterhavenmc.library.messagebuilder.model.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.validation.Parameter
- Recipient.Invalid - Record Class in com.winterhavenmc.library.messagebuilder.model.recipient
-
Represents an invalid or unrecognized message recipient.
- Recipient.InvalidReason - Enum Class in com.winterhavenmc.library.messagebuilder.model.recipient
-
Indicates the reason a
Recipient
was deemed invalid. - Recipient.Proxied - Record Class in com.winterhavenmc.library.messagebuilder.model.recipient
-
Represents a proxied command sender (e.g., from another plugin or dispatch chain).
- Recipient.Sendable - Interface in com.winterhavenmc.library.messagebuilder.model.recipient
-
A marker subinterface for
Recipient
types that are capable of receiving messages directly. - Recipient.Valid - Record Class in com.winterhavenmc.library.messagebuilder.model.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.model.recipient
- Section
- RECORD_TYPE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- RecordKey - Class in com.winterhavenmc.library.messagebuilder.keys
-
A type that represents a validated key for a record.
- register(Adapter) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.adapters.AdapterRegistry
-
Registers a new
Adapter
into the registry. - reload() - Method in class com.winterhavenmc.library.messagebuilder.MessageBuilder
-
Reload messages from configured language file
- reload() - Method in class com.winterhavenmc.library.messagebuilder.resources.language.LanguageResourceManager
-
Reload the language resource.
- reload() - Method in interface com.winterhavenmc.library.messagebuilder.resources.ResourceManager
-
Reload resource into a bukkit Configuration object
- RELOAD_FAILED - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.ErrorMessageKey
-
Indicates that a configuration reload operation failed.
- removeExpired() - Method in class com.winterhavenmc.library.messagebuilder.pipeline.cooldown.CooldownMap
-
Removes all expired cooldown entries from the internal map.
- REPEAT_DELAY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.MessageRecord.Field
- repeatDelay() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns the value of the
repeatDelay
record component. - repeatDelay() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidMessageRecord
- replace(MacroObjectMap, String) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.replacer.MacroReplacer
-
Replaces all macro placeholders found in the given message string using the provided
MacroObjectMap
. - replace(MacroObjectMap, String) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.replacer.Replacer
-
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.validation.Parameter
- Replacer - Interface in com.winterhavenmc.library.messagebuilder.pipeline.replacer
-
A functional interface representing a macro replacement engine that substitutes placeholder values within a message string using data from a
MacroObjectMap
. - Resolution Behavior - Search tag in package com.winterhavenmc.library.messagebuilder.resources.configuration
- Section
- resolve(MacroKey, MacroObjectMap) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.AtomicResolver
-
Resolves a single value mapped to the provided
MacroKey
into a string representation, if the object exists and can be formatted. - resolve(MacroKey, MacroObjectMap) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.CompositeResolver
-
Resolves a
MacroKey
by attempting to adapt the associated object from theMacroObjectMap
using applicableAdapter
instances. - resolve(MacroKey, MacroObjectMap) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.FieldResolver
-
Resolves a
MacroKey
using the available macro objects in the givenMacroObjectMap
, by delegating to each registered resolver in sequence. - resolve(MacroKey, MacroObjectMap) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.resolvers.Resolver
-
Resolves a set of string values from the given
MacroObjectMap
for the providedMacroKey
. - resolve(World) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname.DefaultResolver
-
Returns the default Bukkit world name using an instance of
DefaultRetriever
- resolve(World) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname.PluginResolver
-
Attempts to retrieve the alias name of the specified world using
Multiverse4Retriever
. - resolve(World) - Method in interface com.winterhavenmc.library.messagebuilder.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.model.language.FinalMessageRecord
- Section
- Resolver - Interface in com.winterhavenmc.library.messagebuilder.pipeline.resolvers
-
Defines a contract for resolving values from a
MacroObjectMap
into a set of string-replaceable entries mapped byMacroKey
s. - RESOURCE_AUTO_INSTALL - Enum constant in enum class com.winterhavenmc.library.messagebuilder.resources.language.LanguageSetting
- RESOURCE_INSTALLER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- RESOURCE_LANGUAGE_EN_US_YML - Enum constant in enum class com.winterhavenmc.library.messagebuilder.resources.language.LanguageSetting
- RESOURCE_LOADER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- RESOURCE_NAME - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- RESOURCE_SUBDIRECTORY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.resources.language.LanguageSetting
- RESOURCE_TYPE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- ResourceInstaller - Interface in com.winterhavenmc.library.messagebuilder.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.resources
- ResourceLoader - Interface in com.winterhavenmc.library.messagebuilder.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.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
reload
command. - Retriever - Interface in com.winterhavenmc.library.messagebuilder.pipeline.retriever
-
A functional interface representing the first stage of the message pipeline: retrieving a
MessageRecord
associated with a givenRecordKey
. - Runtime Integration - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname
- Section
S
- SECONDS - Enum constant in enum class com.winterhavenmc.library.time.TimeUnit
- Section - Enum Class in com.winterhavenmc.library.messagebuilder.model.language
-
An enumeration of Sections that correspond directly to each top level
ConfigurationSection
of the language file. - SECTION - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- SECTION_SUPPLIER - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- SectionProvider - Interface in com.winterhavenmc.library.messagebuilder.resources.language
- SectionRecord - Interface in com.winterhavenmc.library.messagebuilder.model.language
-
A sealed interface representing a validated record loaded from a structured section of a language YAML file.
- SectionResourceManager - Interface in com.winterhavenmc.library.messagebuilder.resources.language
- send() - Method in record class com.winterhavenmc.library.messagebuilder.model.message.InvalidMessage
- send() - Method in interface com.winterhavenmc.library.messagebuilder.model.message.Message
-
Sends the composed message to the resolved recipient, if valid.
- send() - Method in class com.winterhavenmc.library.messagebuilder.model.message.ValidMessage
- send(Recipient.Sendable, FinalMessageRecord) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.sender.MessageSender
-
Sends a chat message to the specified recipient if the message is enabled and contains content.
- send(Recipient.Sendable, FinalMessageRecord) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.sender.Sender
-
Sends a processed message to the given recipient using the implementation’s delivery strategy.
- send(Recipient.Sendable, FinalMessageRecord) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.sender.TitleSender
-
Sends a title and subtitle to a player if applicable, using values from the given message record.
- sender() - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Invalid
-
Returns the value of the
sender
record component. - sender() - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Proxied
-
Returns the value of the
sender
record component. - sender() - Method in interface com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Sendable
-
The actual
CommandSender
that may receive messages. - sender() - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Valid
-
Returns the value of the
sender
record component. - Sender - Interface in com.winterhavenmc.library.messagebuilder.pipeline.sender
-
A functional interface representing a message dispatch strategy responsible for delivering a fully rendered
FinalMessageRecord
to aRecipient.Sendable
. - Sending - Search tag in interface com.winterhavenmc.library.messagebuilder.model.message.Message
- Section
- setMacro(int, K, V) - Method in record class com.winterhavenmc.library.messagebuilder.model.message.InvalidMessage
- setMacro(int, K, V) - Method in interface com.winterhavenmc.library.messagebuilder.model.message.Message
-
Associates a macro key 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.model.message.ValidMessage
- setMacro(K, Duration, ChronoUnit) - Method in record class com.winterhavenmc.library.messagebuilder.model.message.InvalidMessage
- setMacro(K, Duration, ChronoUnit) - Method in interface com.winterhavenmc.library.messagebuilder.model.message.Message
-
Associates a duration with the given macro key, using a defined precision.
- setMacro(K, Duration, ChronoUnit) - Method in class com.winterhavenmc.library.messagebuilder.model.message.ValidMessage
- setMacro(K, V) - Method in record class com.winterhavenmc.library.messagebuilder.model.message.InvalidMessage
- setMacro(K, V) - Method in interface com.winterhavenmc.library.messagebuilder.model.message.Message
-
Associates a macro key with a value for later substitution during message rendering.
- setMacro(K, V) - Method in class com.winterhavenmc.library.messagebuilder.model.message.ValidMessage
- Single-field Adapters - Search tag in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter.BuiltIn
- Section
- size() - Method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroStringMap
-
Returns the number of entries in this map.
- StandardKey - Interface in com.winterhavenmc.library.messagebuilder.keys
-
An interface that defines a standard key type.
- Standard Support - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.adapters.name
- Section
- STRING - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.location.Locatable.Field
- STRING_BLANK - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.ErrorMessageKey
-
Indicates that a provided string was blank (empty or only whitespace).
- Subpackages - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.formatters
- Section
- subtitle() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns the value of the
subtitle
record component. - subtitle() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidMessageRecord
- SUBTITLE_TEXT - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.MessageRecord.Field
- SUCCESS - Enum constant in enum class com.winterhavenmc.library.messagebuilder.resources.ResourceInstaller.InstallerStatus
- supports(Object) - Method in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter
-
Returns
true
if this adapter can successfully adapt the given object.
T
- TARGET_DIR_PATH - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- throwing(ErrorMessageKey, Parameter) - Static method in interface com.winterhavenmc.library.messagebuilder.validation.Validator
-
Returns a handler that throws a
ValidationException
using the given error message key and parameter. - Throwing<T> - Record Class in com.winterhavenmc.library.messagebuilder.validation
-
A
Validator
implementation that throws aValidationException
when a value fails validation. - Throwing(Supplier<ValidationException>) - Constructor for record class com.winterhavenmc.library.messagebuilder.validation.Throwing
-
Creates an instance of a
Throwing
record class. - Tick - Class in com.winterhavenmc.library.time
- Tick() - Constructor for class com.winterhavenmc.library.time.Tick
- TICKS - Enum constant in enum class com.winterhavenmc.library.time.TimeUnit
- TICKS - Static variable in class com.winterhavenmc.library.messagebuilder.MessageBuilder
- Time4jDurationFormatter - Class in com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration
-
A
DurationFormatter
implementation that uses the Time4J library'sPrettyTime
to renderDuration
values as human-readable, localized strings. - Time4jDurationFormatter(LocaleProvider) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.Time4jDurationFormatter
-
Constructs a
Time4jDurationFormatter
with the providedLocaleProvider
. - times(int) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- TimeUnit - Enum Class in com.winterhavenmc.library.time
- title() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns the value of the
title
record component. - title() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidMessageRecord
- TITLE_FADE_IN - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.MessageRecord.Field
- TITLE_FADE_OUT - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.MessageRecord.Field
- TITLE_STAY - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.MessageRecord.Field
- TITLE_TEXT - Enum constant in enum class com.winterhavenmc.library.messagebuilder.model.language.MessageRecord.Field
- titleFadeIn() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns the value of the
titleFadeIn
record component. - titleFadeIn() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidMessageRecord
- titleFadeOut() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns the value of the
titleFadeOut
record component. - titleFadeOut() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidMessageRecord
- TitleSender - Class in com.winterhavenmc.library.messagebuilder.pipeline.sender
-
Sends a title and optional subtitle to a
Player
using values from aFinalMessageRecord
. - TitleSender(CooldownMap) - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.sender.TitleSender
-
Constructs a
TitleSender
using the specified cooldown map. - titleStay() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns the value of the
titleStay
record component. - titleStay() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidMessageRecord
- toDays(long) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- toHours(long) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- toJavaUtilLevel() - Method in enum class com.winterhavenmc.library.messagebuilder.validation.LogLevel
-
Returns the corresponding
Level
for this log level. - toKey() - Method in enum class com.winterhavenmc.library.messagebuilder.model.language.ItemRecord.Field
-
Returns the YAML key path string associated with this field.
- toKey() - Method in enum class com.winterhavenmc.library.messagebuilder.model.language.MessageRecord.Field
-
Returns the raw YAML key string associated with this field.
- toMillis(long) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- toMinutes(long) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- toMonths(long) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- toSeconds(long) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- toString() - Method in class com.winterhavenmc.library.messagebuilder.keys.AbstractKey
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.FinalMessageRecord
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidConstantRecord
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidItemRecord
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.model.language.InvalidMessageRecord
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.model.message.InvalidMessage
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Invalid
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Proxied
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Valid
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.adapters.AdapterContextContainer
-
Returns a string representation of this record class.
- toString() - Method in class com.winterhavenmc.library.messagebuilder.pipeline.cooldown.CooldownKey
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.BoundedDuration
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.formatters.FormatterContainer
-
Returns a string representation of this record class.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageSetting
-
Returns a string representation of this record class.
- toString() - Method in class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageTag
-
Retrieve the IETF language tag associated with a potential language resource, as a String
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.resources.configuration.LocaleSetting
-
Returns a string representation of this record class.
- toString() - Method in enum class com.winterhavenmc.library.messagebuilder.resources.language.LanguageSetting
- toString() - Method in enum class com.winterhavenmc.library.messagebuilder.util.Delimiter
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.validation.Logging
-
Returns a string representation of this record class.
- toString() - Method in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
-
Returns the display name of the parameter.
- toString() - Method in record class com.winterhavenmc.library.messagebuilder.validation.Throwing
-
Returns a string representation of this record class.
- toString() - Method in class com.winterhavenmc.library.time.Tick
- toTicks(long) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- toWeeks(long) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- toYears(long) - Method in enum class com.winterhavenmc.library.time.TimeUnit
- TRACE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.LogLevel
-
The lowest level of logging, typically used for very fine-grained tracing.
- TYPE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- Typical Usage - Search tag in package com.winterhavenmc.library.messagebuilder
- Section
- Typical Usage - Search tag in package com.winterhavenmc.library.messagebuilder.model.language
- Section
- Typical usage: - Search tag in class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageTag
- Section
- Typical usage: - Search tag in record class com.winterhavenmc.library.messagebuilder.validation.Logging
- Section
- Typical usage: - Search tag in record class com.winterhavenmc.library.messagebuilder.validation.Throwing
- Section
- Typical Use Case - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.cooldown
- Section
U
- UNAVAILABLE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.resources.ResourceInstaller.InstallerStatus
- UNIQUE_ID - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- UniqueIdAdapter - Class in com.winterhavenmc.library.messagebuilder.pipeline.adapters.uuid
-
Adapter for identifying objects with a unique
UUID
. - UniqueIdAdapter() - Constructor for class com.winterhavenmc.library.messagebuilder.pipeline.adapters.uuid.UniqueIdAdapter
- UNKNOWN - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- UNKNOWN_VALUE - Static variable in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter
- UNLIMITED - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.formatters.duration.DurationType
- Usage - Search tag in interface com.winterhavenmc.library.messagebuilder.model.language.SectionRecord
- Section
- Usage - Search tag in package com.winterhavenmc.library.messagebuilder.model.message
- Section
- Usage - Search tag in package com.winterhavenmc.library.messagebuilder.model.recipient
- Section
- Usage - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.resolvers.worldname
- Section
- Usage Example - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.extractor
- Section
- Usage Pattern - Search tag in package com.winterhavenmc.library.messagebuilder.validation
- Section
- Use Case - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.resolvers
- Section
- UUID - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.Adapter.BuiltIn
V
- Valid(CommandSender) - Constructor for record class com.winterhavenmc.library.messagebuilder.model.recipient.Recipient.Valid
-
Creates an instance of a
Valid
record class. - VALID_DISPLAY_NAME - Static variable in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.displayname.DisplayNameable
-
A predicate used to validate that a display name is non-null and non-blank.
- VALID_KEY - Static variable in class com.winterhavenmc.library.messagebuilder.keys.AbstractKey
- VALID_KILLER - Static variable in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.killer.Killable
-
Predicate that evaluates whether a killer is considered valid and non-blank.
- VALID_LOCALE - Static variable in class com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageTag
-
Predicate that evaluates to
true
if 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.pipeline.adapters.looter.Lootable
-
Predicate to validate whether a looter has a valid, non-blank name.
- VALID_NAME - Static variable in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.name.Nameable
-
A predicate that determines whether a given name string is valid.
- VALID_OWNER - Static variable in interface com.winterhavenmc.library.messagebuilder.pipeline.adapters.owner.Ownable
-
Predicate used to validate an owner.
- validate(T, Predicate<T>, Validator<T>) - Static method in interface com.winterhavenmc.library.messagebuilder.validation.Validator
-
Validates a value using the given predicate and handler.
- Validation - Search tag in package com.winterhavenmc.library.messagebuilder.pipeline.maps
- Section
- ValidationContext - Class in com.winterhavenmc.library.messagebuilder.validation
-
Provides global access to the plugin-configured locale used during validation message formatting.
- ValidationException - Exception Class in com.winterhavenmc.library.messagebuilder.validation
-
Thrown to indicate that a parameter validation has failed.
- ValidationException(ErrorMessageKey, Parameter) - Constructor for exception class com.winterhavenmc.library.messagebuilder.validation.ValidationException
-
Constructs a new
ValidationException
with the specifiedErrorMessageKey
andParameter
describing the failed validation. - Validator<T> - Interface in com.winterhavenmc.library.messagebuilder.validation
-
A functional interface representing a strategy for handling invalid values detected during validation.
- ValidConstantRecord - Class in com.winterhavenmc.library.messagebuilder.model.language
-
A validated, immutable
ConstantRecord
representing a constant value loaded from theCONSTANTS
section of a language YAML file. - ValidItemRecord - Class in com.winterhavenmc.library.messagebuilder.model.language
-
A validated, immutable
ItemRecord
representing a localized or macro-enabled item definition loaded from theITEMS
section of a language YAML file. - ValidMessage - Class in com.winterhavenmc.library.messagebuilder.model.message
-
A concrete implementation of
Message
representing a fully constructed, resolvable, and sendable message. - ValidMessage(Recipient.Sendable, RecordKey, MessagePipeline) - Constructor for class com.winterhavenmc.library.messagebuilder.model.message.ValidMessage
-
Class constructor
- ValidMessageRecord - Class in com.winterhavenmc.library.messagebuilder.model.language
-
A validated, immutable
MessageRecord
representing a single entry from theMESSAGES
section of a language YAML file. - value() - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidConstantRecord
-
Returns the raw constant value associated with this record.
- VALUE - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.model.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.model.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.model.language.Section
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.model.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.pipeline.adapters.Adapter.BuiltIn
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.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.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.resources.language.LanguageSetting
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.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.util.Delimiter
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.validation.ErrorMessageKey
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.validation.LogLevel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.winterhavenmc.library.time.TimeUnit
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.winterhavenmc.library.messagebuilder.model.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.model.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.model.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.model.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.pipeline.adapters.Adapter.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.pipeline.adapters.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.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.resources.language.LanguageSetting
-
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.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.util.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.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.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.validation.Parameter
-
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.time.TimeUnit
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WARN - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.LogLevel
-
A warning that indicates a potential issue or recoverable problem.
- WEEKS - Enum constant in enum class com.winterhavenmc.library.time.TimeUnit
- with(MacroKey, String) - Method in class com.winterhavenmc.library.messagebuilder.pipeline.maps.MacroStringMap
-
Adds a key-value pair to this map and returns the map itself.
- withFinalStrings(String, String, String) - Method in class com.winterhavenmc.library.messagebuilder.model.language.ValidMessageRecord
-
Creates a
FinalMessageRecord
using 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.pipeline.adapters.location.Locatable.Field
- WORLD - Enum constant in enum class com.winterhavenmc.library.messagebuilder.validation.Parameter
- worldNameResolver() - Method in record class com.winterhavenmc.library.messagebuilder.pipeline.adapters.AdapterContextContainer
-
Returns the value of the
worldNameResolver
record component. - WorldNameResolver - Interface in com.winterhavenmc.library.messagebuilder.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.pipeline.resolvers.worldname
-
Strategy interface for retrieving a user-friendly name for a given
World
. - wrappedString - Variable in class com.winterhavenmc.library.messagebuilder.keys.AbstractKey
X
- X - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.location.Locatable.Field
Y
- Y - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.location.Locatable.Field
- YEARS - Enum constant in enum class com.winterhavenmc.library.time.TimeUnit
Z
- Z - Enum constant in enum class com.winterhavenmc.library.messagebuilder.pipeline.adapters.location.Locatable.Field
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form