Package software.amazon.smithy.model.validation.node

Class MapLengthPlugin

java.lang.Object

software.amazon.smithy.model.validation.node.MapLengthPlugin

All Implemented Interfaces:

NodeValidatorPlugin

public final class MapLengthPlugin
extends java.lang.Object

Validates the length trait on map shapes or members that target them.

Constructor Summary

Constructors

Constructor	Description
MapLengthPlugin()

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	apply(Shape shape, Node value, ShapeIndex index)	Applies the plugin to the given shape, node value, and shape index.
protected java.util.List<java.lang.String>	check(Shape shape, LengthTrait trait, ObjectNode node, ShapeIndex index)

Methods inherited from class java.lang.Object

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

Constructor Detail

MapLengthPlugin

public MapLengthPlugin()

Method Detail

check

protected java.util.List<java.lang.String> check(Shape shape,
                                                 LengthTrait trait,
                                                 ObjectNode node,
                                                 ShapeIndex index)

apply

public final java.util.List<java.lang.String> apply(Shape shape,
                                                    Node value,
                                                    ShapeIndex index)

Description copied from interface: NodeValidatorPlugin

Applies the plugin to the given shape, node value, and shape index.

Specified by:

apply in interface NodeValidatorPlugin

Parameters:

shape - Shape being checked.

value - Value being evaluated.

index - Shape index used to traverse the model.

Returns:

Returns any validation messages that were encountered.