Record Class StatefulModificationResponse.InvalidRequest

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.config.actions.StatefulModificationResponse.InvalidRequest
All Implemented Interfaces:
StatefulModificationResponse
Enclosing interface:
StatefulModificationResponse

public static record StatefulModificationResponse.InvalidRequest(Exception problem) extends Record implements StatefulModificationResponse
The request could not be carried out because of something the caller did.
See Also:
  • Constructor Details

    • InvalidRequest

      public InvalidRequest(String message)
      A refusal with nothing to say beyond message; classified as a bad argument.
    • InvalidRequest

      public InvalidRequest(Exception problem)
      Creates an instance of a InvalidRequest record class.
      Parameters:
      problem - the value for the problem record component
  • Method Details

    • message

      public String message()
      The text meant for whoever made the request. Never null — nothing stops a caller supplying an exception with no message, and a null reaches the UI as the raw envelope.
    • 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.
    • problem

      public Exception problem()
      Returns the value of the problem record component.
      Specified by:
      problem in interface StatefulModificationResponse
      Returns:
      the value of the problem record component