Package com.inductiveautomation.ignition.gateway.dataroutes.openapi

Record Class ExternalDocumentationObject

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.dataroutes.openapi.ExternalDocumentationObject
public record ExternalDocumentationObject(String description, String url) extends Record
Record class that represents an OpenAPI External Documentation Object

  • Constructor Details

    • ExternalDocumentationObject

      public ExternalDocumentationObject(String description, String url)
      Creates an instance of a ExternalDocumentationObject record class.
      Parameters:
      description - the value for the description record component
      url - the value for the url 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.

    • description

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

    • url

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