Package limn.i18n

Record Class UnresolvedKey

java.lang.Object
java.lang.Record
limn.i18n.UnresolvedKey
Record Components:
key - the key as it was looked up; a plural sentence with no form in the language at all reports its .other key
english - the English that was shown instead
locale - the locale the key was looked up in

public record UnresolvedKey(String key, String english, Locale locale) extends Record
A key no registered bundle translates into a language, so the text fell back to the English its declaration carries: a typo in a key, a key left behind by a rename, or a file that has not caught up with the code. I18n.observeUnresolvedKeys(java.util.function.Consumer<limn.i18n.UnresolvedKey>) hands one of these to its listeners, once per key and locale.

A record so that what a report carries can grow without breaking the listeners that read it.

  • Constructor Details

    • UnresolvedKey

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

      public String key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component
    • english

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

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