Package com.inductiveautomation.ignition.client.util.gui.errors

Record Class DisplayableError

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.client.util.gui.errors.DisplayableError
Record Components:
message - the provided message, the message of the exception, or the exception's simple class name.
public record DisplayableError(String message, String title, Throwable exception) extends Record
A class representing an error or exception that occurred. It has several different possible pieces of display information, such as a title and message in addition to an actual exception.

  • Constructor Details

    • DisplayableError

      public DisplayableError(String message, String title)
      Creates an error based solely on a text message and title.

    • DisplayableError

      public DisplayableError(String message, String title, Throwable exception)
      Creates an error with a message, title, and backing exception. If message is null, the message of the exception will be used.

  • 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.

    • message

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

    • title

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

    • exception

      public Throwable exception()
      Returns the value of the exception record component.
      Returns:
      the value of the exception record component