software.amazon.smithy.model.validation

Class ContextualValidationEventFormatter

java.lang.Object

software.amazon.smithy.model.validation.ContextualValidationEventFormatter

All Implemented Interfaces:

ValidationEventFormatter

public final class ContextualValidationEventFormatter
extends java.lang.Object
implements ValidationEventFormatter

This validation event formatter outputs a validation event that points to the source code line that triggered the event.

If the event does not have a source location, then this formatter will not attempt to load the contents of the model.

This formatter outputs messages similar to the following text:

 ERROR: aws.protocols.tests.ec2#IgnoresWrappingXmlName (Model)
     --> /foo/bar.smithy
      |
  403 | apply MyShape @httpResponseTests([
      |                                  ^
      = Unable to resolve trait `smithy.test#httpResponseTests`. If this is a custom trait, [...]
 

Constructor Summary

Constructors

Constructor and Description
ContextualValidationEventFormatter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(ValidationEvent event) Converts the event to a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextualValidationEventFormatter

public ContextualValidationEventFormatter()

Method Detail

format

public java.lang.String format(ValidationEvent event)

Description copied from interface: ValidationEventFormatter

Converts the event to a string.

Specified by:

format in interface ValidationEventFormatter

Parameters:

event - Event to write as a string.

Returns:

Returns the event as a formatted string.