Record Class ConfigProblems

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.jsonschema.config.ConfigProblems
Record Components:
problems - the problems found.

public record ConfigProblems(List<ConfigProblem> problems) extends Record
The collected results of validating a config object against a ConfigSchema: one ConfigProblem per violation, ordered by path. An acceptable config yields no ConfigProblems at all — ConfigSchema.validate(JsonElement) returns null — so an instance always describes at least one problem.
  • Constructor Details

    • ConfigProblems

      public ConfigProblems(List<ConfigProblem> problems)
      Creates an instance of a ConfigProblems record class.
      Parameters:
      problems - the value for the problems record component
  • Method Details

    • of

      public static ConfigProblems of(ConfigProblem... problems)
    • messages

      public List<String> messages()
      Every problem's message, in path order.
    • toDisplayString

      public String toDisplayString()
      All problems as one displayable string, one problem per line.
    • 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.
    • problems

      public List<ConfigProblem> problems()
      Returns the value of the problems record component.
      Returns:
      the value of the problems record component