Record Class TranslationTermsMessage

java.lang.Object
java.lang.Record
com.inductiveautomation.perspective.gateway.messages.json.TranslationTermsMessage
Record Components:
locale - The IETF code for the locale (i.e. - not the Locale.toString() version, but rather the Locale.forLanguageTag() and toLanguageTag() versions.)
terms - A map of each translation key to its translated value for the locale.

public record TranslationTermsMessage(String locale, Map<String,String> terms) extends Record
Message sent to the perspective client containing information about the localization terms available for a locale.
  • Field Details

  • Constructor Details

    • TranslationTermsMessage

      public TranslationTermsMessage(String locale, Map<String,String> terms)
      Creates an instance of a TranslationTermsMessage record class.
      Parameters:
      locale - the value for the locale record component
      terms - the value for the terms 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.
    • locale

      public String locale()
      Returns the value of the locale record component.
      Returns:
      the value of the locale record component
    • terms

      public Map<String,String> terms()
      Returns the value of the terms record component.
      Returns:
      the value of the terms record component