Package com.arc_e_tect.gradle.apionly.transcriberj.model

Record Class Finding

java.lang.Object
java.lang.Record
com.arc_e_tect.gradle.apionly.transcriberj.model.Finding
Record Components:
location - the JSON pointer, into the bundled contract, of the schema or object the construct occurs in
construct - what occurs there
treatment - how generated code treats it
detail - what exactly was found, for a human reading the report
public record Finding(String location, Construct construct, Treatment treatment, String detail) extends Record
One occurrence of a classified construct.

  • Constructor Details

    • Finding

      public Finding(String location, Construct construct, Treatment treatment, String detail)
      Creates an instance of a Finding record class.
      Parameters:
      location - the value for the location record component
      construct - the value for the construct record component
      treatment - the value for the treatment record component
      detail - the value for the detail record component

  • Method Details

    • remedy

      public String remedy()
      What a specification author can do so the construct is represented in full.
      Returns:
      the remedy, or null when there is nothing to remedy

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

    • location

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

    • construct

      public Construct construct()
      Returns the value of the construct record component.
      Returns:
      the value of the construct record component

    • treatment

      public Treatment treatment()
      Returns the value of the treatment record component.
      Returns:
      the value of the treatment record component

    • detail

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