Package org.fhirfrog.frog.testscriptrender

Record Class TestScriptDisplay

java.lang.Object
java.lang.Record
org.fhirfrog.frog.testscriptrender.TestScriptDisplay
Record Components:
title - the TestScript's title, falling back to name if absent
name - the TestScript's name
url - the TestScript's canonical url
version - the TestScript's version, or null if absent
status - the TestScript's status code (e.g. active), or null if absent
description - the TestScript's description narrative, or null if absent
fixtures - the fixtures declared on the TestScript, in declaration order
variables - the variables declared on the TestScript, in declaration order
phases - setup (if present), then one phase per test, then teardown (if present) - in that order
public record TestScriptDisplay(String title, String name, String url, String version, String status, String description, List<TestScriptDisplay.FixtureDisplay> fixtures, List<TestScriptDisplay.VariableDisplay> variables, List<TestScriptDisplay.PhaseDisplay> phases) extends Record
A display-only, human-readable rendering of a FHIR TestScript definition.

This is not a re-parseable serialization (contrast with TSH, fhir-frog-shorthand's authoring DSL) - it exists purely to be rendered for reading, e.g. to HTML via TestScriptHtmlRenderer. There is no obligation, and no attempt, to preserve enough information to reconstruct the original TestScript resource from this tree.

  • Constructor Details

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

    • title

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

    • name

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

    • url

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

    • version

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

    • status

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

    • description

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

    • fixtures

      public List<TestScriptDisplay.FixtureDisplay> fixtures()
      Returns the value of the fixtures record component.
      Returns:
      the value of the fixtures record component

    • variables

      public List<TestScriptDisplay.VariableDisplay> variables()
      Returns the value of the variables record component.
      Returns:
      the value of the variables record component

    • phases

      public List<TestScriptDisplay.PhaseDisplay> phases()
      Returns the value of the phases record component.
      Returns:
      the value of the phases record component