Package com.winterhavenmc.library.messagebuilder.models.language

Class ValidMessageRecord

java.lang.Object

com.winterhavenmc.library.messagebuilder.models.language.ValidMessageRecord

All Implemented Interfaces:

MessageRecord, SectionRecord

public final class ValidMessageRecord
extends Object
implements MessageRecord

A validated, immutable MessageRecord representing a single entry from the MESSAGES section of a language YAML file.

This record contains the full structure of a templated message, including:

• A unique ValidMessageKey
• A plain-text message body (with placeholders)
• Optional title and subtitle text
• Title animation parameters (fade-in, stay, fade-out durations)
• An optional repeat delay for scheduled messages

This class is created via the create(ValidMessageKey, ConfigurationSection) factory method, which performs all necessary validation and applies default values where appropriate. Once constructed, instances are considered safe and complete and can be used without additional checks.

See Also:

• MessageRecord
• ValidMessageKey

Nested Class Summary

Nested classes/interfaces inherited from interface com.winterhavenmc.library.messagebuilder.models.language.MessageRecord

MessageRecord.Field

Method Summary

Modifier and Type	Method	Description
static ValidMessageRecord	create(ValidMessageKey key, org.bukkit.configuration.ConfigurationSection section)	Creates a ValidMessageRecord from a YAML configuration section.
boolean	enabled()
ValidMessageKey	key()
String	message()
Duration	repeatDelay()
String	subtitle()
String	title()
Duration	titleFadeIn()
Duration	titleFadeOut()
Duration	titleStay()
FinalMessageRecord	withFinalStrings(String finalMessageString, String finalTitleString, String finalSubTitleString)	Creates a FinalMessageRecord using the current record data, combined with finalized message, title, and subtitle strings after macro resolution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static ValidMessageRecord create(ValidMessageKey key,
 org.bukkit.configuration.ConfigurationSection section)

Creates a ValidMessageRecord from a YAML configuration section.

All expected fields are validated or defaulted according to their definitions in MessageRecord.Field. If a field is missing, a sensible default is applied.

Parameters:

key - the record string representing this message

section - the configuration section containing the message definition

Returns:

a new, fully validated ValidMessageRecord

withFinalStrings

public FinalMessageRecord withFinalStrings(String finalMessageString,
 String finalTitleString,
 String finalSubTitleString)

Creates a FinalMessageRecord using the current record data, combined with finalized message, title, and subtitle strings after macro resolution.

This is typically used as the last step in the message pipeline before dispatch.

Parameters:

finalMessageString - the resolved chat message string

finalTitleString - the resolved title string

finalSubTitleString - the resolved subtitle string

Returns:

a FinalMessageRecord that includes the resolved strings

key

public ValidMessageKey key()

Specified by:

key in interface SectionRecord

enabled

public boolean enabled()

message

public String message()

repeatDelay

public Duration repeatDelay()

title

public String title()

titleFadeIn

public Duration titleFadeIn()

titleStay

public Duration titleStay()

titleFadeOut

public Duration titleFadeOut()

subtitle

public String subtitle()