Enum Class ErrorMessageKey
- All Implemented Interfaces:
Serializable
,Comparable<ErrorMessageKey>
,Constable
Enumeration of structured keys used to identify localized error messages
for validation and configuration-related exceptions.
These keys correspond to entries in a ResourceBundle
,
allowing the library to provide translatable, context-aware messages
to plugin users and administrators.
Typically used in conjunction with ValidationException
and
Validator.formatMessage(ErrorMessageKey, Parameter)
.
Example key in the language file: PARAMETER_NULL=Parameter {0} must not be null.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionIndicates that a required configuration section is invalid or missing.Indicates that a language file could not be found for the configured locale.Indicates that a required language resource file is missing from the plugin jar.Indicates a general failure to locate a required resource.Indicates that a parameter failed validation, but no specific cause is given.Indicates that a required parameter wasnull
.Indicates that a parameter was of the wrong type.Indicates that a configuration reload operation failed.Indicates that a provided string was blank (empty or only whitespace). -
Method Summary
Modifier and TypeMethodDescriptionstatic ErrorMessageKey
Returns the enum constant of this class with the specified name.static ErrorMessageKey[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
INVALID_SECTION
Indicates that a required configuration section is invalid or missing. -
MISSING_LANGUAGE_FILE
Indicates that a language file could not be found for the configured locale. -
MISSING_LANGUAGE_RESOURCE
Indicates that a required language resource file is missing from the plugin jar. -
MISSING_RESOURCE
Indicates a general failure to locate a required resource. -
PARAMETER_INVALID
Indicates that a parameter failed validation, but no specific cause is given. -
PARAMETER_NULL
Indicates that a required parameter wasnull
. -
PARAMETER_TYPE_MISMATCH
Indicates that a parameter was of the wrong type. -
RELOAD_FAILED
Indicates that a configuration reload operation failed. -
STRING_BLANK
Indicates that a provided string was blank (empty or only whitespace).
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-