Package com.winterhavenmc.library.messagebuilder.resources.configuration

Record Class LanguageSetting

java.lang.Object
java.lang.Record
com.winterhavenmc.library.messagebuilder.resources.configuration.LanguageSetting
Record Components:
name - the raw language or locale tag string, never null
public record LanguageSetting(@NotNull String name) extends Record
Represents a configured language file identifier.

This record encapsulates a string such as en-US or fr-FR, typically sourced from the plugin's config.yml. It is used by localization components such as LanguageProvider and downstream language or formatting tools to select appropriate resource files, and may also be queried for the locale setting. This allows server operators to include only one setting for both language file and locale in the plugin config.yml file, assuming the chosen setting conforms to a valid IETF language tag.

The name field is expected to follow the IETF BCP 47 language tag format (e.g., en-US, de-DE), although enforcement is deferred to consumers, to allow custom language file names that do not interfere with existing or provided language file names.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LanguageSetting(@NotNull String name)
    Creates an instance of a LanguageSetting record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    @NotNull String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • LanguageSetting

      public LanguageSetting(@NotNull @NotNull String name)
      Creates an instance of a LanguageSetting record class.
      Parameters:
      name - the value for the name record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      @NotNull public @NotNull String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component