Uses of Class
com.winterhavenmc.library.messagebuilder.keys.RecordKey
Packages that use RecordKey
Package
Description
This package contains the StandardKey interface and implementations
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.Provides support for message rate limiting through a cooldown mechanism.
Defines the entry point to the message pipeline, responsible for retrieving
MessageRecord
instances from a configuration-backed query system.This package contains the QueryHandler interface and implementations for the language file sections.
-
Uses of RecordKey in com.winterhavenmc.library.messagebuilder.keys
Methods in com.winterhavenmc.library.messagebuilder.keys that return types with arguments of type RecordKey -
Uses of RecordKey in com.winterhavenmc.library.messagebuilder.model.language
Methods in com.winterhavenmc.library.messagebuilder.model.language that return RecordKeyModifier and TypeMethodDescriptionFinalMessageRecord.key()
Returns the value of thekey
record component.InvalidConstantRecord.key()
Returns the value of thekey
record component.InvalidItemRecord.key()
Returns the value of thekey
record component.InvalidMessageRecord.key()
Returns the value of thekey
record component.SectionRecord.key()
ValidConstantRecord.key()
ValidItemRecord.key()
ValidMessageRecord.key()
Methods in com.winterhavenmc.library.messagebuilder.model.language with parameters of type RecordKeyModifier and TypeMethodDescriptionstatic ValidConstantRecord
Creates aValidConstantRecord
from the provided key and value.static ValidItemRecord
Creates aValidItemRecord
from a configuration section.static ValidMessageRecord
Creates aValidMessageRecord
from a YAML configuration section.static InvalidConstantRecord
Returns anInvalidConstantRecord
representing a missing or null constant entry.static InvalidItemRecord
Returns anInvalidItemRecord
representing a missing or unresolved item section.static InvalidMessageRecord
Returns anInvalidMessageRecord
representing a missing or invalid message definition.static ConstantRecord
Factory method that attempts to create aConstantRecord
from the given value.static ItemRecord
Creates anItemRecord
from the given configuration section.static MessageRecord
MessageRecord.from
(RecordKey messageKey, org.bukkit.configuration.ConfigurationSection messageEntry) Factory method that constructs aMessageRecord
from a YAML configuration section.Constructors in com.winterhavenmc.library.messagebuilder.model.language with parameters of type RecordKeyModifierConstructorDescriptionFinalMessageRecord
(RecordKey key, boolean enabled, String message, Duration repeatDelay, String title, int titleFadeIn, int titleStay, int titleFadeOut, String subtitle, Optional<String> finalMessageString, Optional<String> finalTitleString, Optional<String> finalSubtitleString) Creates an instance of aFinalMessageRecord
record class.InvalidConstantRecord
(RecordKey key, String reason) Creates an instance of aInvalidConstantRecord
record class.InvalidItemRecord
(RecordKey key, String reason) Creates an instance of aInvalidItemRecord
record class.InvalidMessageRecord
(RecordKey key, String reason) Creates an instance of aInvalidMessageRecord
record class. -
Uses of RecordKey in com.winterhavenmc.library.messagebuilder.model.message
Methods in com.winterhavenmc.library.messagebuilder.model.message that return RecordKeyModifier and TypeMethodDescriptionInvalidMessage.getMessageKey()
Message.getMessageKey()
Returns theRecordKey
identifying the message template used in composition.ValidMessage.getMessageKey()
Constructors in com.winterhavenmc.library.messagebuilder.model.message with parameters of type RecordKeyModifierConstructorDescriptionValidMessage
(Recipient.Sendable recipient, RecordKey messageKey, MessagePipeline messagePipeline) Class constructor -
Uses of RecordKey in com.winterhavenmc.library.messagebuilder.pipeline.cooldown
Methods in com.winterhavenmc.library.messagebuilder.pipeline.cooldown that return RecordKeyModifier and TypeMethodDescriptionCooldownKey.getMessageKey()
Retrieve the message key used for this cooldown keyMethods in com.winterhavenmc.library.messagebuilder.pipeline.cooldown with parameters of type RecordKeyModifier and TypeMethodDescriptionstatic Optional
<CooldownKey> CooldownKey.of
(Recipient.Sendable recipient, RecordKey messageKey) Static factory method with Message parameter -
Uses of RecordKey in com.winterhavenmc.library.messagebuilder.pipeline.retriever
Methods in com.winterhavenmc.library.messagebuilder.pipeline.retriever with parameters of type RecordKeyModifier and TypeMethodDescriptionRetrieves aMessageRecord
for the given key using the underlyingQueryHandler
. -
Uses of RecordKey in com.winterhavenmc.library.messagebuilder.query
Methods in com.winterhavenmc.library.messagebuilder.query with parameters of type RecordKeyModifier and TypeMethodDescriptionint
Query the constants section of the language file for anint
with the keyPathStub method until implementedRetrieve an item record from the language file for the currently configured language.Retrieve a message record from the language file for the provided keyQuery the constants section of the language file for a String with keyPathConstantQueryHandler.getStringList
(RecordKey key) Query the constants section of the language file for a List of String with the keyPath