Package com.winterhavenmc.library.messagebuilder.models.configuration

Record Class LocaleSetting

java.lang.Object
java.lang.Record
com.winterhavenmc.library.messagebuilder.models.configuration.LocaleSetting
Record Components:
languageTag - the LanguageTag representing a specific locale
public record LocaleSetting(LanguageTag languageTag) extends Record
Represents a locale setting derived from a valid LanguageTag.

This record is used as a wrapper around a LanguageTag to provide access to its associated Locale, typically for localization and formatting logic.

See Also:

  • Constructor Details

    • LocaleSetting

      public LocaleSetting(LanguageTag languageTag)
      Creates an instance of a LocaleSetting record class.
      Parameters:
      languageTag - the value for the languageTag record component

  • Method Details

    • locale

      public Locale locale()
      Returns the Locale corresponding to the encapsulated LanguageTag.
      Returns:
      a valid Locale derived from the language tag

    • 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.

    • languageTag

      public LanguageTag languageTag()
      Returns the value of the languageTag record component.
      Returns:
      the value of the languageTag record component