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
SuppressesValidationEvent
s emitted fromValidator
s.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static Suppression
fromMetadata(Node node)
Creates a suppression from aNode
found in the "suppressions" metadata of a Smithy model.static Suppression
fromSuppressTrait(Shape shape)
Creates a suppression using theSuppressTrait
of the given shape.default java.util.Optional<java.lang.String>
getReason()
Gets the optional reason for the suppression.boolean
test(ValidationEvent event)
Determines if the suppression applies to the given event.
-
-
-
Method Detail
-
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 java.util.Optional<java.lang.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 theSuppressTrait
of the given shape.- Parameters:
shape
- Shape to get theSuppressTrait
from.- Returns:
- Returns the created suppression.
- Throws:
ExpectationNotMetException
- if the shape has noSuppressTrait
.
-
fromMetadata
static Suppression fromMetadata(Node node)
Creates a suppression from aNode
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.
-
-