Record Class Translation

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.i18n.translation.Translation
Record Components:
sourceKey - The original key in the base locale.
locale - The target locale for the translation.
translation - The translated string.

public record Translation(String sourceKey, Locale locale, @Nullable String translation) extends Record
A container for a single translated key.
  • Constructor Details

    • Translation

      public Translation(String sourceKey, Locale locale, @Nullable String translation)
      Creates an instance of a Translation record class.
      Parameters:
      sourceKey - the value for the sourceKey record component
      locale - the value for the locale record component
      translation - the value for the translation record component
  • Method Details

    • getSourceKey

      public String getSourceKey()
    • getLocale

      public Locale getLocale()
    • getTranslation

      public @Nullable String getTranslation()
    • 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.
    • sourceKey

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

      public Locale locale()
      Returns the value of the locale record component.
      Returns:
      the value of the locale record component
    • translation

      public @Nullable String translation()
      Returns the value of the translation record component.
      Returns:
      the value of the translation record component