Package software.amazon.smithy.model.loader

Interface TraitContainer

All Known Implementing Classes:

TraitContainer.TraitHashMap, TraitContainer.VersionAwareTraitContainer

public interface TraitContainer

Aggregates, merges, and creates traits.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	TraitContainer.TraitHashMap	The actual, mutable implementation used to aggregate traits.
static final class	TraitContainer.VersionAwareTraitContainer	Performs version-specific validation on traits as they are added.

Field Summary

Fields

Modifier and Type	Field	Description
static final TraitContainer	EMPTY	Shared empty, immutable instance.

Method Summary

Modifier and Type	Method	Description
void	clearTraitsForShape(ShapeId shape)	Clears the traits applied to a shape.
Map<ShapeId,Map<ShapeId,Trait>>	getTraitsAppliedToPrelude()	Gets all traits applied to the prelude.
Map<ShapeId,Trait>	getTraitsForShape(ShapeId shape)	Gets the traits applied to a shape.
void	onTrait(ShapeId target, ShapeId traitId, Node value)	Create and add a trait.
void	onTrait(ShapeId target, Trait value)	Add a trait.
Map<ShapeId,Map<ShapeId,Trait>>	traits()

Field Details

EMPTY

static final TraitContainer EMPTY

Shared empty, immutable instance.

Method Details

traits

Map<ShapeId,Map<ShapeId,Trait>> traits()

Returns:

Gets all traits in the value map.

getTraitsForShape

Map<ShapeId,Trait> getTraitsForShape(ShapeId shape)

Gets the traits applied to a shape.

Parameters:

shape - Shape to get the traits of.

Returns:

Returns the traits of the shape.

clearTraitsForShape

void clearTraitsForShape(ShapeId shape)

Clears the traits applied to a shape.

This is useful in the event of errors that occur while attempting to create a shape so that validation events about traits applied to shapes that couldn't be created are not emitted.

Parameters:

shape - Shape to clear the traits for.

getTraitsAppliedToPrelude

Map<ShapeId,Map<ShapeId,Trait>> getTraitsAppliedToPrelude()

Gets all traits applied to the prelude.

Returns:

Returns the traits applied to prelude shapes.

onTrait

void onTrait(ShapeId target,
 Trait value)

Add a trait.

Parameters:

target - Shape to add the trait to.

value - Trait to add.

onTrait

void onTrait(ShapeId target,
 ShapeId traitId,
 Node value)

Create and add a trait.

Parameters:

target - Shape to add the trait to.

traitId - Trait shape ID to create.

value - The value to assign to the trait.