Package software.amazon.smithy.model.jmespath.node

Class ModelJmespathUtils

java.lang.Object

software.amazon.smithy.model.jmespath.node.ModelJmespathUtils

public final class ModelJmespathUtils
extends Object

Provides utilities for working with JMESPath expressions in the context of a Smithy model.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JMES_PATH_DANGER	Constant for "JmespathEventDanger", a default validation event ID segment.
static final String	JMES_PATH_PROBLEM	Constant for "JmespathProblem", a default validation event ID segment.
static final String	JMES_PATH_WARNING	Constant for "JmespathEventWarning", a default validation event ID segment.

Constructor Summary

Constructors

Constructor	Description
ModelJmespathUtils()

Method Summary

Modifier and Type	Method	Description
static LinterResult	lint(Model model, Shape shape, JmespathExpression expression)	Lint the expression using static analysis.
static LiteralExpression	sampleShapeValue(Model model, Shape shape)	Creates a sample LiteralExpression value that is a valid value of the given shape, or LiteralExpression.ANY if the shape is null.

Methods inherited from class java.lang.Object

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

Field Details

JMES_PATH_PROBLEM

public static final String JMES_PATH_PROBLEM

Constant for "JmespathProblem", a default validation event ID segment.

See Also:

• Constant Field Values

JMES_PATH_DANGER

public static final String JMES_PATH_DANGER

Constant for "JmespathEventDanger", a default validation event ID segment.

See Also:

• Constant Field Values

JMES_PATH_WARNING

public static final String JMES_PATH_WARNING

Constant for "JmespathEventWarning", a default validation event ID segment.

See Also:

• Constant Field Values

Constructor Details

ModelJmespathUtils

public ModelJmespathUtils()

Method Details

lint

public static LinterResult lint(Model model,
 Shape shape,
 JmespathExpression expression)

Lint the expression using static analysis.

Parameters:

shape - The shape the current node will be a value of.

Returns:

Returns the problems that were detected.

sampleShapeValue

public static LiteralExpression sampleShapeValue(Model model,
 Shape shape)

Creates a sample LiteralExpression value that is a valid value of the given shape, or LiteralExpression.ANY if the shape is null.