Package com.winterhavenmc.library.messagebuilder.models.keys

Interface MessageKey

All Superinterfaces:

RecordKey, StandardKey

All Known Implementing Classes:

InvalidMessageKey, ValidMessageKey

public sealed interface MessageKey
extends RecordKey
permits ValidMessageKey, InvalidMessageKey

A type that represents a validated string for a record. This type guarantees a valid string that has been validated upon creation. The static factory methods return an Optional of the LegacyRecordKey, or an empty Optional if the parameter was invalid, as determined by regex pattern and Predicate.

Field Summary

Fields inherited from interface com.winterhavenmc.library.messagebuilder.models.keys.StandardKey

IS_INVALID_KEY, VALID_KEY_PATTERN

Method Summary

Modifier and Type	Method	Description
default Optional<ValidMessageKey>	isValid()
static <E extends Enum<E>> MessageKey	of(E key)
static MessageKey	of(String key)

Method Details

of

static MessageKey of(String key)

of

static <E extends Enum<E>> MessageKey of(E key)

isValid

default Optional<ValidMessageKey> isValid()