Package software.amazon.smithy.docgen.validation

Class DocValidationEventDecorator

java.lang.Object

software.amazon.smithy.docgen.validation.DocValidationEventDecorator

All Implemented Interfaces:

ValidationEventDecorator

public class DocValidationEventDecorator
extends Object
implements ValidationEventDecorator

Adds context to validation events describing how they impact docs.

Field Summary

Fields inherited from interface software.amazon.smithy.model.validation.ValidationEventDecorator

IDENTITY

Constructor Summary

Constructors

Constructor	Description
DocValidationEventDecorator()

Method Summary

Modifier and Type	Method	Description
boolean	canDecorate(ValidationEvent event)	Returns true if this decorator knows how to decorate this event, usually by looking at the event id.
ValidationEvent	decorate(ValidationEvent event)	Takes an event and potentially updates it to decorate it.

Methods inherited from class java.lang.Object

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

Constructor Details

DocValidationEventDecorator

public DocValidationEventDecorator()

Method Details

canDecorate

public boolean canDecorate(ValidationEvent event)

Description copied from interface: ValidationEventDecorator

Returns true if this decorator knows how to decorate this event, usually by looking at the event id.

Specified by:

canDecorate in interface ValidationEventDecorator

Parameters:

event - The event to test against

Returns:

true if this decorator knows how to decorate this event

decorate

public ValidationEvent decorate(ValidationEvent event)

Description copied from interface: ValidationEventDecorator

Takes an event and potentially updates it to decorate it. Returns the same event if this decorators does not know how to handle the event.

Specified by:

decorate in interface ValidationEventDecorator

Returns:

The decorated event or the original one if no decoration took place.