Package com.inductiveautomation.ignition.gateway.web.search

Record Class ItemResult

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.web.search.ItemResult
Record Components:
name - the name of the item
matchStrength - the relative match strength score (higher is better)
public record ItemResult(String name, int matchStrength) extends Record
A search result item found by an ItemSearchDelegate.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ItemResult(String name, int matchStrength)
    Creates an instance of a ItemResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    matchStrength()
    Returns the value of the matchStrength record component.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ItemResult

      public ItemResult(String name, int matchStrength)
      Creates an instance of a ItemResult record class.
      Parameters:
      name - the value for the name record component
      matchStrength - the value for the matchStrength 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • matchStrength

      public int matchStrength()
      Returns the value of the matchStrength record component.
      Returns:
      the value of the matchStrength record component