Package software.amazon.smithy.contracts

Class ConditionsTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.contracts.ConditionsTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<ConditionsTrait>

public final class ConditionsTrait
extends AbstractTrait
implements ToSmithyBuilder<ConditionsTrait>

Restricts shape values to those that satisfy one or more JMESPath expressions. Each expression must produce 'true'.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ConditionsTrait.Builder	Builder for ConditionsTrait.
static final class	ConditionsTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID

Method Summary

Modifier and Type	Method	Description
static ConditionsTrait.Builder	builder()	Creates a builder used to build a ConditionsTrait.
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
static ConditionsTrait	fromNode(Node node)	Creates a ConditionsTrait from a Node.
Map<String,Condition>	getConditions()	Gets the map of condition names to Conditions.
SmithyBuilder<ConditionsTrait>	toBuilder()	Converts this trait to a builder used to build an equivalent ConditionsTrait.

Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait

equals, getSourceLocation, hashCode, setNodeCache, toNode, toShapeId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.smithy.model.traits.Trait

isSynthetic

Field Details

ID

public static final ShapeId ID

Method Details

createNode

protected Node createNode()

Description copied from class: AbstractTrait

The result of toNode is used for hashCodes and equality. Subclasses must implement createNode to turn the trait into a Node. This is then cached for subsequent retrievals.

Specified by:

createNode in class AbstractTrait

Returns:

Returns the trait as a node.

fromNode

public static ConditionsTrait fromNode(Node node)

Creates a ConditionsTrait from a Node.

Parameters:

node - Node to create the ConditionsTrait from.

Returns:

Returns the created ConditionsTrait.

Throws:

ExpectationNotMetException - if the given Node is invalid.

getConditions

public Map<String,Condition> getConditions()

Gets the map of condition names to Conditions.

Returns:

Returns the conditions map.

toBuilder

public SmithyBuilder<ConditionsTrait> toBuilder()

Converts this trait to a builder used to build an equivalent ConditionsTrait.

Specified by:

toBuilder in interface ToSmithyBuilder<ConditionsTrait>

Returns:

a builder for type T

builder

public static ConditionsTrait.Builder builder()

Creates a builder used to build a ConditionsTrait.