Package software.amazon.smithy.model.validation

Class ValidationEvent

java.lang.Object

software.amazon.smithy.model.validation.ValidationEvent

All Implemented Interfaces:

java.lang.Comparable<ValidationEvent>, ToNode, ToSmithyBuilder<ValidationEvent>

public final class ValidationEvent
extends java.lang.Object
implements java.lang.Comparable<ValidationEvent>, ToNode, ToSmithyBuilder<ValidationEvent>

A validation event created when validating a model.

Validation events are collection while assembling and validating a model. Events with a severity less than ERROR can be suppressed. All events contain a message, severity, and eventId.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ValidationEvent.Builder	Builds ValidationEvent values.

Method Summary

Modifier and Type	Method	Description
static ValidationEvent.Builder	builder()
int	compareTo(ValidationEvent other)
boolean	equals(java.lang.Object o)
static ValidationEvent	fromNode(Node node)
static ValidationEvent	fromSourceException(SourceException exception)	Creates a new ValidationEvent from a SourceException.
static ValidationEvent	fromSourceException(SourceException exception, java.lang.String prefix)	Creates a new ValidationEvent from a SourceException.
static ValidationEvent	fromSourceException(SourceException exception, java.lang.String prefix, ShapeId shapeId)	Creates a new ValidationEvent from a SourceException.
java.lang.String	getEventId()	Deprecated. Use the getId() method to match the node format.
java.lang.String	getId()	Returns the identifier of the validation event.
java.lang.String	getMessage()
Severity	getSeverity()
java.util.Optional<ShapeId>	getShapeId()
SourceLocation	getSourceLocation()
java.util.Optional<java.lang.String>	getSuppressionReason()	Get the reason that the event was suppressed.
int	hashCode()
ValidationEvent.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
Node	toNode()	Converts a value to a Node.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static ValidationEvent.Builder builder()

fromSourceException

public static ValidationEvent fromSourceException(SourceException exception)

Creates a new ValidationEvent from a SourceException.

Parameters:

exception - Exception to use to create the event.

Returns:

Returns a created validation event with an ID of Model.

fromSourceException

public static ValidationEvent fromSourceException(SourceException exception,
                                                  java.lang.String prefix)

Creates a new ValidationEvent from a SourceException.

Parameters:

exception - Exception to use to create the event.

prefix - Prefix string to add to the message.

Returns:

Returns a created validation event with an ID of Model.

fromSourceException

public static ValidationEvent fromSourceException(SourceException exception,
                                                  java.lang.String prefix,
                                                  ShapeId shapeId)

Creates a new ValidationEvent from a SourceException.

Parameters:

exception - Exception to use to create the event.

prefix - Prefix string to add to the message.

shapeId - ShapeId to associate with the event.

Returns:

Returns a created validation event with an ID of Model.

compareTo

public int compareTo(ValidationEvent other)

Specified by:

compareTo in interface java.lang.Comparable<ValidationEvent>

toBuilder

public ValidationEvent.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<ValidationEvent>

Returns:

a builder for type T

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toNode

public Node toNode()

Description copied from interface: ToNode

Converts a value to a Node.

Specified by:

toNode in interface ToNode

Returns:

Returns the creates Node.

fromNode

public static ValidationEvent fromNode(Node node)

getSourceLocation

public SourceLocation getSourceLocation()

Returns:

The location at which the event occurred.

getMessage

public java.lang.String getMessage()

Returns:

The human-readable event message.

getSeverity

public Severity getSeverity()

Returns:

The severity level of the event.

getEventId

public java.lang.String getEventId()

Deprecated.

Use the getId() method to match the node format.

Returns the identifier of the validation event.

The validation event identifier can be used to suppress events.

Returns:

Returns the event ID.

getId

public java.lang.String getId()

Returns the identifier of the validation event.

The validation event identifier can be used to suppress events.

Returns:

Returns the event ID.

getShapeId

public java.util.Optional<ShapeId> getShapeId()

Returns:

The shape ID that is associated with the event.

getSuppressionReason

public java.util.Optional<java.lang.String> getSuppressionReason()

Get the reason that the event was suppressed.

Returns:

Returns the suppression reason if available.