Package dev.itsharshxd.zentrix.api.scenario

Record Class ScenarioValidation

java.lang.Object
java.lang.Record
dev.itsharshxd.zentrix.api.scenario.ScenarioValidation
Record Components:
valid - whether the combination can be used as-is, without any issue above ScenarioValidation.Severity.INFO
resolved - the scenarios that would actually run, in activation order: descending priority, then ID
issues - everything validation found, in the order it was found
public record ScenarioValidation(boolean valid, @NotNull List<String> resolved, @NotNull List<ScenarioValidation.Issue> issues) extends Record
The verdict on one combination of scenarios.

Validation is what makes combinations deterministic rather than surprising: it resolves dependencies, rejects conflicting pairs, drops scenarios whose required plugins are missing, and reports what it changed. Zentrix runs it before locking a match's scenarios in, and the management GUI runs it while an administrator edits a set.

Since:
1.6.0

  • Constructor Details

    • ScenarioValidation

      public ScenarioValidation(boolean valid, @NotNull @NotNull List<String> resolved, @NotNull @NotNull List<ScenarioValidation.Issue> issues)
      Creates an instance of a ScenarioValidation record class.
      Parameters:
      valid - the value for the valid record component
      resolved - the value for the resolved record component
      issues - the value for the issues record component

  • Method Details

    • hasIssues

      public boolean hasIssues()
      Whether anything at all was reported.

    • errors

      @NotNull public @NotNull List<ScenarioValidation.Issue> errors()
      The findings that make the combination unusable.

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • valid

      public boolean valid()
      Returns the value of the valid record component.
      Returns:
      the value of the valid record component

    • resolved

      @NotNull public @NotNull List<String> resolved()
      Returns the value of the resolved record component.
      Returns:
      the value of the resolved record component

    • issues

      @NotNull public @NotNull List<ScenarioValidation.Issue> issues()
      Returns the value of the issues record component.
      Returns:
      the value of the issues record component