Package software.amazon.smithy.model.validation

Class NodeValidationVisitor

java.lang.Object

software.amazon.smithy.model.validation.NodeValidationVisitor

All Implemented Interfaces:

ShapeVisitor<List<ValidationEvent>>

public final class NodeValidationVisitor
extends Object
implements ShapeVisitor<List<ValidationEvent>>

Validates Node values provided for Shape definitions.

This visitor validator is used to ensure that values provided for custom traits and examples are correct for their schema definitions. A map of shape types to a list of additional validators can be provided to perform additional, non-standard, validation of these values. For example, this can be used to provide additional validation needed for custom traits that are applied to the shape of the data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NodeValidationVisitor.Builder	Builds a NodeValidationVisitor.
static enum	NodeValidationVisitor.Feature	Features to use when validating.

Nested classes/interfaces inherited from interface software.amazon.smithy.model.shapes.ShapeVisitor

ShapeVisitor.Default<R>

Method Summary

Modifier and Type	Method	Description
List<ValidationEvent>	bigDecimalShape(BigDecimalShape shape)
List<ValidationEvent>	bigIntegerShape(BigIntegerShape shape)
List<ValidationEvent>	blobShape(BlobShape shape)
List<ValidationEvent>	booleanShape(BooleanShape shape)
static NodeValidationVisitor.Builder	builder()
List<ValidationEvent>	byteShape(ByteShape shape)
List<ValidationEvent>	documentShape(DocumentShape shape)
List<ValidationEvent>	doubleShape(DoubleShape shape)
List<ValidationEvent>	floatShape(FloatShape shape)
List<ValidationEvent>	integerShape(IntegerShape shape)
List<ValidationEvent>	listShape(ListShape shape)
List<ValidationEvent>	longShape(LongShape shape)
List<ValidationEvent>	mapShape(MapShape shape)
List<ValidationEvent>	memberShape(MemberShape shape)
List<ValidationEvent>	operationShape(OperationShape shape)
List<ValidationEvent>	resourceShape(ResourceShape shape)
List<ValidationEvent>	serviceShape(ServiceShape shape)
void	setEventId(String eventId)	Changes the event ID emitted for events created by this validator.
void	setEventShapeId(ShapeId eventShapeId)	Changes the shape ID that emitted events are associated with.
void	setStartingContext(String startingContext)	Changes the starting context of the messages emitted by events.
void	setValue(Node value)	Changes the Node value the visitor will evaluate.
List<ValidationEvent>	shortShape(ShortShape shape)
List<ValidationEvent>	stringShape(StringShape shape)
List<ValidationEvent>	structureShape(StructureShape shape)
List<ValidationEvent>	timestampShape(TimestampShape shape)
List<ValidationEvent>	unionShape(UnionShape shape)

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.model.shapes.ShapeVisitor

enumShape, intEnumShape, setShape

Method Details

builder

public static NodeValidationVisitor.Builder builder()

setValue

public void setValue(Node value)

Changes the Node value the visitor will evaluate.

Parameters:

value - Value to set.

setEventShapeId

public void setEventShapeId(ShapeId eventShapeId)

Changes the shape ID that emitted events are associated with.

Parameters:

eventShapeId - Shape ID to set.

setStartingContext

public void setStartingContext(String startingContext)

Changes the starting context of the messages emitted by events.

Parameters:

startingContext - Starting context message to set.

setEventId

public void setEventId(String eventId)

Changes the event ID emitted for events created by this validator.

Parameters:

eventId - Event ID to set.

blobShape

public List<ValidationEvent> blobShape(BlobShape shape)

Specified by:

blobShape in interface ShapeVisitor<List<ValidationEvent>>

booleanShape

public List<ValidationEvent> booleanShape(BooleanShape shape)

Specified by:

booleanShape in interface ShapeVisitor<List<ValidationEvent>>

byteShape

public List<ValidationEvent> byteShape(ByteShape shape)

Specified by:

byteShape in interface ShapeVisitor<List<ValidationEvent>>

shortShape

public List<ValidationEvent> shortShape(ShortShape shape)

Specified by:

shortShape in interface ShapeVisitor<List<ValidationEvent>>

integerShape

public List<ValidationEvent> integerShape(IntegerShape shape)

Specified by:

integerShape in interface ShapeVisitor<List<ValidationEvent>>

longShape

public List<ValidationEvent> longShape(LongShape shape)

Specified by:

longShape in interface ShapeVisitor<List<ValidationEvent>>

bigIntegerShape

public List<ValidationEvent> bigIntegerShape(BigIntegerShape shape)

Specified by:

bigIntegerShape in interface ShapeVisitor<List<ValidationEvent>>

floatShape

public List<ValidationEvent> floatShape(FloatShape shape)

Specified by:

floatShape in interface ShapeVisitor<List<ValidationEvent>>

documentShape

public List<ValidationEvent> documentShape(DocumentShape shape)

Specified by:

documentShape in interface ShapeVisitor<List<ValidationEvent>>

doubleShape

public List<ValidationEvent> doubleShape(DoubleShape shape)

Specified by:

doubleShape in interface ShapeVisitor<List<ValidationEvent>>

bigDecimalShape

public List<ValidationEvent> bigDecimalShape(BigDecimalShape shape)

Specified by:

bigDecimalShape in interface ShapeVisitor<List<ValidationEvent>>

stringShape

public List<ValidationEvent> stringShape(StringShape shape)

Specified by:

stringShape in interface ShapeVisitor<List<ValidationEvent>>

timestampShape

public List<ValidationEvent> timestampShape(TimestampShape shape)

Specified by:

timestampShape in interface ShapeVisitor<List<ValidationEvent>>

listShape

public List<ValidationEvent> listShape(ListShape shape)

Specified by:

listShape in interface ShapeVisitor<List<ValidationEvent>>

mapShape

public List<ValidationEvent> mapShape(MapShape shape)

Specified by:

mapShape in interface ShapeVisitor<List<ValidationEvent>>

structureShape

public List<ValidationEvent> structureShape(StructureShape shape)

Specified by:

structureShape in interface ShapeVisitor<List<ValidationEvent>>

unionShape

public List<ValidationEvent> unionShape(UnionShape shape)

Specified by:

unionShape in interface ShapeVisitor<List<ValidationEvent>>

memberShape

public List<ValidationEvent> memberShape(MemberShape shape)

Specified by:

memberShape in interface ShapeVisitor<List<ValidationEvent>>

operationShape

public List<ValidationEvent> operationShape(OperationShape shape)

Specified by:

operationShape in interface ShapeVisitor<List<ValidationEvent>>

resourceShape

public List<ValidationEvent> resourceShape(ResourceShape shape)

Specified by:

resourceShape in interface ShapeVisitor<List<ValidationEvent>>

serviceShape

public List<ValidationEvent> serviceShape(ServiceShape shape)

Specified by:

serviceShape in interface ShapeVisitor<List<ValidationEvent>>