MessageBuilder 2.0.0-SNAPSHOT API
Packages
Package
Description
The core package of MessageBuilderLib, a library designed to simplify
the dynamic construction and macro-based substitution of messages in Bukkit plugins.
This package contains the StandardKey interface and implementations
This package contains data structure models used in the library.
Provides interfaces and data models that represent entries from the plugin's
language YAML file.
Contains the sealed
Message
interface and its implementations, which represent composed messages ready for macro
substitution and delivery.Contains a sealed model hierarchy representing classified message recipients
in a Bukkit-based command or messaging context.
Provides the core processing components of the message pipeline.
Defines the adapter mechanism for macro value extraction within the message-building pipeline.
Provides an adapter and interface for extracting and formatting display names from objects.
Provides an adapter for objects that expose a
Duration
.Provides adapter and interface support for expiration-based macro replacements.
Provides adapter support for objects that expose a timestamp via the
Instant
API.Provides support for extracting killer information from entities or plugin-defined objects.
Provides support for extracting and formatting location-based macro values from objects.
Contains support for adapting objects that represent looting permissions or claims.
Provides the
Nameable
interface and its corresponding adapter used to extract and format
name-related fields from objects passed into the message pipeline.Provides support for extracting ownership information from objects and applying it to macro placeholders.
Provides support for adapting objects with time-based protection attributes into macro string values.
Provides support for macro replacement of quantity-related values.
Provides support for macro replacement of UUID values from objects.
Provides support for message rate limiting through a cooldown mechanism.
Provides mechanisms for extracting macro-compatible string values from objects
that have been adapted by the
Adapter
system.Contains formatters responsible for converting data types into localized, human-readable strings.
Provides formatting for
Duration
values into localized, human-readable strings.Provides locale-aware number formatting for use in the message-building pipeline.
Provides internal map types used in macro extraction and message formatting.
Provides utilities for identifying macro placeholders within message strings.
Defines the final stage in the message processing pipeline, responsible for converting a structured
ValidMessageRecord
into a fully resolved
FinalMessageRecord
.Contains interfaces and classes responsible for replacing macros in message strings
using resolved values from a
MacroObjectMap
.Provides a hierarchy of
Resolver
implementations responsible for converting macro-related input values into string representations
for use in templated messages.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.
Defines the entry point to the message pipeline, responsible for retrieving
MessageRecord
instances from a configuration-backed query system.Defines the final dispatch stage in the message pipeline, responsible for delivering
resolved and formatted messages to recipients.
This package contains the QueryHandler interface and implementations for the language file sections.
This package contains packages that pertain to resources and their handlers.
Provides configuration accessors for server-defined language, locale, and timezone settings.
This package encapsulates the handling and querying of a language resource.
This package contains utility classes, interfaces and enums used by the library.
Provides a flexible, localized validation framework for use within the MessageBuilder library.