Module com.github.cowwoc.requirements10.java
Package com.github.cowwoc.requirements10.java

Class ValidationFailures

java.lang.Object
com.github.cowwoc.requirements10.java.ValidationFailures
public final class ValidationFailures extends Object
A collection of validation failures.

  • Field Details

    • EMPTY

      public static final ValidationFailures EMPTY
      A collection that does not contain any failures.

  • Constructor Details

    • ValidationFailures

      public ValidationFailures(boolean cleanStackTrace, List<ValidationFailure> failures)
      Creates a new instance.
      Parameters:
      cleanStackTrace - true if stack traces may be modified, false otherwise
      failures - the validation failures
      Throws:
      NullPointerException - if failures is null

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Checks if any validation has failed.
      Returns:
      false if at least one validation has failed

    • getFailures

      public List<ValidationFailure> getFailures()
      Returns the list of failed validations.
      Returns:
      an unmodifiable list of failed validations

    • throwOnFailure

      public boolean throwOnFailure()
      Throws an exception if a validation failed; otherwise, returns true.
      Returns:
      true if the validation passed
      Throws:
      RuntimeException - if a method precondition was violated
      Error - if a class invariant or method postcondition was violated
      MultipleFailuresException - if more than one validation failed. This exception contains a list of the failures

    • getMessages

      public List<String> getMessages()
      Returns the validation failure messages.
      Returns:
      an empty list if the validation was successful

    • getException

      public Throwable getException()
      Returns the exception for the validation failures, if any.
      1. Returns null if no validation has failed.
      2. Returns MultipleFailuresException if there were multiple failures.
      3. Returns Throwable if there was one failure.
      Returns:
      the exception or null if no validation has failed

    • addAll

      public ValidationFailures addAll(ValidationFailures failures)
      Adds validation failures into this collection.
      Parameters:
      failures - the failures to add
      Returns:
      this
      Throws:
      NullPointerException - if failures is null