Record Class KeyHashRule

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.i18n.translation.KeyHashRule
Record Components:
caseInsensitive - Whether to lowercase the key.
ignoreWhitespace - Whether to remove whitespace.
ignorePunctuation - Whether to remove punctuation.
ignoreTags - Whether to remove HTML tags.

public record KeyHashRule(boolean caseInsensitive, boolean ignoreWhitespace, boolean ignorePunctuation, boolean ignoreTags) extends Record
Defines the normalization rules for creating a search key from a source key.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final KeyHashRule
    A KeyHashRule that does not adjust the input key at all
  • Constructor Summary

    Constructors
    Constructor
    Description
    Deprecated.
    Reserved for the Vision XML deserializer, which instantiates rules embedded in windows saved by earlier versions.
    KeyHashRule(boolean caseInsensitive, boolean ignoreWhitespace, boolean ignorePunctuation, boolean ignoreTags)
    Creates an instance of a KeyHashRule record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Returns the value of the caseInsensitive record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    @Nullable String
    getKey(@Nullable String key)
    Generates a normalized hash key for the given key based on the rules.
    final int
    Returns a hash code value for this object.
    boolean
    Returns the value of the ignorePunctuation record component.
    boolean
    Returns the value of the ignoreTags record component.
    boolean
    Returns the value of the ignoreWhitespace record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • IDENTITY

      public static final KeyHashRule IDENTITY
      A KeyHashRule that does not adjust the input key at all
  • Constructor Details

    • KeyHashRule

      @Deprecated(since="2027.2.0") public KeyHashRule()
      Deprecated.
      Reserved for the Vision XML deserializer, which instantiates rules embedded in windows saved by earlier versions. Use IDENTITY or the canonical constructor.
      Creates a rule equivalent to IDENTITY.
    • KeyHashRule

      public KeyHashRule(boolean caseInsensitive, boolean ignoreWhitespace, boolean ignorePunctuation, boolean ignoreTags)
      Creates an instance of a KeyHashRule record class.
      Parameters:
      caseInsensitive - the value for the caseInsensitive record component
      ignoreWhitespace - the value for the ignoreWhitespace record component
      ignorePunctuation - the value for the ignorePunctuation record component
      ignoreTags - the value for the ignoreTags record component
  • Method Details

    • getKey

      @Contract("null -> null; !null -> !null") public @Nullable String getKey(@Nullable String key)
      Generates a normalized hash key for the given key based on the rules.
      Parameters:
      key - The raw source key.
      Returns:
      The normalized "hash key" used for lookups, based on the enabled rules (e.g., lowercased, tags removed).
    • 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 the compare method from their corresponding wrapper classes.
      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.
    • caseInsensitive

      public boolean caseInsensitive()
      Returns the value of the caseInsensitive record component.
      Returns:
      the value of the caseInsensitive record component
    • ignoreWhitespace

      public boolean ignoreWhitespace()
      Returns the value of the ignoreWhitespace record component.
      Returns:
      the value of the ignoreWhitespace record component
    • ignorePunctuation

      public boolean ignorePunctuation()
      Returns the value of the ignorePunctuation record component.
      Returns:
      the value of the ignorePunctuation record component
    • ignoreTags

      public boolean ignoreTags()
      Returns the value of the ignoreTags record component.
      Returns:
      the value of the ignoreTags record component