Package software.amazon.smithy.model.validation.suppressions

Interface Suppression

Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface Suppression
Suppresses ValidationEvents emitted from Validators.

  • Method Details

    • test

      boolean test(ValidationEvent event)
      Determines if the suppression applies to the given event.
      Parameters:
      event - Event to test.
      Returns:
      Returns true if the suppression applies.

    • getReason

      default Optional<String> getReason()
      Gets the optional reason for the suppression.
      Returns:
      Returns the optional suppression reason.

    • fromSuppressTrait

      static Suppression fromSuppressTrait(Shape shape)
      Creates a suppression using the SuppressTrait of the given shape.
      Parameters:
      shape - Shape to get the SuppressTrait from.
      Returns:
      Returns the created suppression.
      Throws:
      ExpectationNotMetException - if the shape has no SuppressTrait.

    • fromMetadata

      static Suppression fromMetadata(Node node)
      Creates a suppression from a Node found in the "suppressions" metadata of a Smithy model.
      Parameters:
      node - Node to parse.
      Returns:
      Returns the loaded suppression.
      Throws:
      ExpectationNotMetException - if the suppression node is malformed.