Package software.amazon.smithy.diff.evaluators

Class AbstractDiffEvaluator

java.lang.Object
software.amazon.smithy.diff.evaluators.AbstractDiffEvaluator
All Implemented Interfaces:
DiffEvaluator
Direct Known Subclasses:
AddedEntityBinding, AddedMetadata, AddedOperationError, AddedServiceError, AddedShape, AddedTraitDefinition, ChangedEnumTrait, ChangedLengthTrait, ChangedMemberOrder, ChangedMemberTarget, ChangedMetadata, ChangedNullability, ChangedOperationInput, ChangedOperationOutput, ChangedRangeTrait, ChangedResourceIdentifiers, ChangedShapeType, ModifiedTrait, RemovedAuthenticationScheme, RemovedEntityBinding, RemovedMetadata, RemovedOperationError, RemovedServiceError, RemovedShape, RemovedTraitDefinition, ServiceRename, TraitBreakingChange
public abstract class AbstractDiffEvaluator extends Object implements DiffEvaluator
Provides a default diff evaluator implementation with utility methods for emitting events of different severities.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractDiffEvaluator()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final software.amazon.smithy.model.validation.ValidationEvent
    danger(software.amazon.smithy.model.shapes.Shape shape, String message)
     
    protected final software.amazon.smithy.model.validation.ValidationEvent
    danger(software.amazon.smithy.model.shapes.Shape shape, software.amazon.smithy.model.FromSourceLocation location, String message)
     
    protected final software.amazon.smithy.model.validation.ValidationEvent
    error(software.amazon.smithy.model.shapes.Shape shape, String message)
     
    protected final software.amazon.smithy.model.validation.ValidationEvent
    error(software.amazon.smithy.model.shapes.Shape shape, software.amazon.smithy.model.FromSourceLocation location, String message)
     
    protected String
    getEventId()
    Gets the event ID of the evaluator.
    protected final software.amazon.smithy.model.validation.ValidationEvent
    note(software.amazon.smithy.model.shapes.Shape shape, String message)
     
    protected final software.amazon.smithy.model.validation.ValidationEvent
    note(software.amazon.smithy.model.shapes.Shape shape, software.amazon.smithy.model.FromSourceLocation location, String message)
     
    protected final software.amazon.smithy.model.validation.ValidationEvent
    warning(software.amazon.smithy.model.shapes.Shape shape, String message)
     
    protected final software.amazon.smithy.model.validation.ValidationEvent
    warning(software.amazon.smithy.model.shapes.Shape shape, software.amazon.smithy.model.FromSourceLocation location, String message)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface software.amazon.smithy.diff.DiffEvaluator

    evaluate

  • Constructor Details

    • AbstractDiffEvaluator

      public AbstractDiffEvaluator()

  • Method Details

    • getEventId

      protected String getEventId()
      Gets the event ID of the evaluator.

      This can be overridden in subclasses to use a different ID.

      Returns:
      Returns the computed event ID.

    • error

      protected final software.amazon.smithy.model.validation.ValidationEvent error(software.amazon.smithy.model.shapes.Shape shape, String message)

    • error

      protected final software.amazon.smithy.model.validation.ValidationEvent error(software.amazon.smithy.model.shapes.Shape shape, software.amazon.smithy.model.FromSourceLocation location, String message)

    • danger

      protected final software.amazon.smithy.model.validation.ValidationEvent danger(software.amazon.smithy.model.shapes.Shape shape, String message)

    • danger

      protected final software.amazon.smithy.model.validation.ValidationEvent danger(software.amazon.smithy.model.shapes.Shape shape, software.amazon.smithy.model.FromSourceLocation location, String message)

    • warning

      protected final software.amazon.smithy.model.validation.ValidationEvent warning(software.amazon.smithy.model.shapes.Shape shape, String message)

    • warning

      protected final software.amazon.smithy.model.validation.ValidationEvent warning(software.amazon.smithy.model.shapes.Shape shape, software.amazon.smithy.model.FromSourceLocation location, String message)

    • note

      protected final software.amazon.smithy.model.validation.ValidationEvent note(software.amazon.smithy.model.shapes.Shape shape, String message)

    • note

      protected final software.amazon.smithy.model.validation.ValidationEvent note(software.amazon.smithy.model.shapes.Shape shape, software.amazon.smithy.model.FromSourceLocation location, String message)