Package software.amazon.smithy.linters

Class ReservedWordsValidator

java.lang.Object

software.amazon.smithy.model.validation.AbstractValidator

software.amazon.smithy.linters.ReservedWordsValidator

All Implemented Interfaces:

Validator

public final class ReservedWordsValidator
extends AbstractValidator

Emits validation events for a configuration of reserved words.

This validator accepts the following optional configuration options:

• reserved: ([object]) A list of reserved word configuration objects as follows:
  • words: ([string]) A list of words that are case-insensitively reserved. Leading and trailing wildcards ("*") are supported.
  • selector: (string) Specifies a selector for this configuration. Defaults to validating all shapes, including member names.
  • reason: (string) A reason to display for why this set of words is reserved.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReservedWordsValidator.Config	ReservedWords validator configuration.
static class	ReservedWordsValidator.Provider
static class	ReservedWordsValidator.ReservedWords	A single reserved words configuration.

Field Summary

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

MODEL_ERROR

Method Summary

Modifier and Type	Method	Description
java.util.List<ValidationEvent>	validate(Model model)	Validates a model and returns a list of validation events.

Methods inherited from class software.amazon.smithy.model.validation.AbstractValidator

danger, danger, error, error, getName, note, note, warning, warning

Methods inherited from class java.lang.Object

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

Method Detail

validate

public java.util.List<ValidationEvent> validate(Model model)

Description copied from interface: Validator

Validates a model and returns a list of validation events.

Parameters:

model - Model to validate.

Returns:

List of validation events.