Model (Smithy API 1.21.0)

java.lang.Object
- software.amazon.smithy.model.Model

All Implemented Interfaces:

ToSmithyBuilder<Model>
```
public final class Model
extends java.lang.Object
implements ToSmithyBuilder<Model>
```
A Smithy model that contains shapes, traits, metadata, and various computed information used to interpret the model.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Model.Builder
Builder used to create a Model.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Model.Builder` Builder used to create a Model.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String MODEL_VERSION
Specifies the highest supported version of the IDL.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`MODEL_VERSION` Specifies the highest supported version of the IDL.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static ModelAssembler`	`assembler()` Assembles and validates a Smithy model from files, nodes, and other disparate sources.
`static ModelAssembler`	`assembler(java.lang.ClassLoader classLoader)` Creates a `ModelAssembler` that is configured to discover traits, validators, and built-in validators using the given `ClassLoader`.
`static Model.Builder`	`builder()` Builds an explicitly configured Smithy model.
`boolean`	`equals(java.lang.Object other)`
`Shape`	`expectShape(ShapeId id)` Attempts to retrieve a `Shape` by `ShapeId` and throws if not found.
`<T extends Shape> T`	`expectShape(ShapeId id, java.lang.Class<T> type)` Attempts to retrieve a `Shape` by `ShapeId` and throws if not found or if the shape is not of the expected type.
`java.util.Set<ShapeId>`	`getAppliedTraits()` Gets a set of every trait shape ID that is used in the model.
`java.util.Set<BigDecimalShape>`	`getBigDecimalShapes()` Gets an immutable set of all bigDecimals in the Model.
`java.util.Set<BigDecimalShape>`	`getBigDecimalShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all bigDecimals in the Model that have a specific trait.
`java.util.Set<BigIntegerShape>`	`getBigIntegerShapes()` Gets an immutable set of all bigIntegers in the Model.
`java.util.Set<BigIntegerShape>`	`getBigIntegerShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all bigIntegers in the Model that have a specific trait.
`java.util.Set<BlobShape>`	`getBlobShapes()` Gets an immutable set of all blobs in the Model.
`java.util.Set<BlobShape>`	`getBlobShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all blobs in the Model that have a specific trait.
`java.util.Set<BooleanShape>`	`getBooleanShapes()` Gets an immutable set of all booleans in the Model.
`java.util.Set<BooleanShape>`	`getBooleanShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all booleans in the Model that have a specific trait.
`java.util.Set<ByteShape>`	`getByteShapes()` Gets an immutable set of all bytes in the Model.
`java.util.Set<ByteShape>`	`getByteShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all bytes in the Model that have a specific trait.
`java.util.Set<DocumentShape>`	`getDocumentShapes()` Gets an immutable set of all documents in the Model.
`java.util.Set<DocumentShape>`	`getDocumentShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all documents in the Model that have a specific trait.
`java.util.Set<DoubleShape>`	`getDoubleShapes()` Gets an immutable set of all doubles in the Model.
`java.util.Set<DoubleShape>`	`getDoubleShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all doubles in the Model that have a specific trait.
`java.util.Set<FloatShape>`	`getFloatShapes()` Gets an immutable set of all floats in the Model.
`java.util.Set<FloatShape>`	`getFloatShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all floats in the Model that have a specific trait.
`java.util.Set<IntegerShape>`	`getIntegerShapes()` Gets an immutable set of all integers in the Model.
`java.util.Set<IntegerShape>`	`getIntegerShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all integers in the Model that have a specific trait.
`<T extends KnowledgeIndex> T`	`getKnowledge(java.lang.Class<T> type)` Deprecated.
`<T extends KnowledgeIndex> T`	`getKnowledge(java.lang.Class<T> type, java.util.function.Function<Model,T> constructor)` Gets a computed "knowledge index" of a specific type for the model and caches it for subsequent retrieval.
`java.util.Set<ListShape>`	`getListShapes()` Gets an immutable set of all lists in the Model.
`java.util.Set<ListShape>`	`getListShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all lists in the Model that have a specific trait.
`java.util.Set<LongShape>`	`getLongShapes()` Gets an immutable set of all longs in the Model.
`java.util.Set<LongShape>`	`getLongShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all longs in the Model that have a specific trait.
`java.util.Set<MapShape>`	`getMapShapes()` Gets an immutable set of all maps in the Model.
`java.util.Set<MapShape>`	`getMapShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all maps in the Model that have a specific trait.
`java.util.Set<MemberShape>`	`getMemberShapes()` Gets an immutable set of all members in the Model.
`java.util.Set<MemberShape>`	`getMemberShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all members in the Model that have a specific trait.
`java.util.Map<java.lang.String,Node>`	`getMetadata()`
`java.util.Optional<Node>`	`getMetadataProperty(java.lang.String name)` Gets a metadata property by namespace and name.
`java.util.Set<OperationShape>`	`getOperationShapes()` Gets an immutable set of all operations in the Model.
`java.util.Set<OperationShape>`	`getOperationShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all operations in the Model that have a specific trait.
`java.util.Set<ResourceShape>`	`getResourceShapes()` Gets an immutable set of all resources in the Model.
`java.util.Set<ResourceShape>`	`getResourceShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all resources in the Model that have a specific trait.
`java.util.Set<ServiceShape>`	`getServiceShapes()` Gets an immutable set of all services in the Model.
`java.util.Set<ServiceShape>`	`getServiceShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all services in the Model that have a specific trait.
`java.util.Set<SetShape>`	`getSetShapes()` Gets an immutable set of all sets in the Model.
`java.util.Set<SetShape>`	`getSetShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all sets in the Model that have a specific trait.
`java.util.Optional<Shape>`	`getShape(ShapeId id)` Attempts to retrieve a `Shape` by `ShapeId`.
`java.util.Set<ShapeId>`	`getShapeIds()` Gets the immutable set of `ShapeId` in the model.
`java.util.Set<Shape>`	`getShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets a set of shapes in the model marked with a specific trait.
`java.util.Set<Shape>`	`getShapesWithTrait(ToShapeId trait)` Gets a set of shapes in the model marked with a specific trait.
`java.util.Set<ShortShape>`	`getShortShapes()` Gets an immutable set of all shorts in the Model.
`java.util.Set<ShortShape>`	`getShortShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all shorts in the Model that have a specific trait.
`java.util.Set<StringShape>`	`getStringShapes()` Gets an immutable set of all strings in the Model.
`java.util.Set<StringShape>`	`getStringShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all strings in the Model that have a specific trait.
`java.util.Set<StructureShape>`	`getStructureShapes()` Gets an immutable set of all structures in the Model.
`java.util.Set<StructureShape>`	`getStructureShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all structures in the Model that have a specific trait.
`java.util.Set<TimestampShape>`	`getTimestampShapes()` Gets an immutable set of all timestamps in the Model.
`java.util.Set<TimestampShape>`	`getTimestampShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all timestamps in the Model that have a specific trait.
`java.util.Optional<TraitDefinition>`	`getTraitDefinition(ToShapeId traitId)` Gets the trait definition of a specific trait shape ID.
`java.util.Set<UnionShape>`	`getUnionShapes()` Gets an immutable set of all unions in the Model.
`java.util.Set<UnionShape>`	`getUnionShapesWithTrait(java.lang.Class<? extends Trait> trait)` Gets an immutable set of all unions in the Model that have a specific trait.
`int`	`hashCode()`
`boolean`	`isTraitApplied(java.lang.Class<? extends Trait> trait)` Returns true if the given trait shape ID was used in the model.
`java.util.stream.Stream<Shape>`	`shapes()` Gets a stream of `Shape`s in the index.
`<T extends Shape> java.util.stream.Stream<T>`	`shapes(java.lang.Class<T> shapeType)` Gets a stream of shapes in the index of a specific type `T`.
`Model.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`java.util.Set<Shape>`	`toSet()` Converts the model to an immutable Set of shapes.
`<T extends Shape> java.util.Set<T>`	`toSet(java.lang.Class<T> shapeType)` Gets an immutable Set of shapes of a specific type.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MODEL_VERSION
```
public static final java.lang.String MODEL_VERSION
```
    Specifies the highest supported version of the IDL.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - builder
```
public static Model.Builder builder()
```
    Builds an explicitly configured Smithy model.
    Note that the builder does not validate the correctness of the model. Use the assembler() method to build and validate a model.
    
    Returns:
    
    Returns a model builder.
    
    See Also:
    
    assembler()
  - assembler
```
public static ModelAssembler assembler()
```
    Assembles and validates a Smithy model from files, nodes, and other disparate sources.
    
    Returns:
    
    Returns a model assembler.
  - assembler
```
public static ModelAssembler assembler(java.lang.ClassLoader classLoader)
```
    Creates a ModelAssembler that is configured to discover traits, validators, and built-in validators using the given ClassLoader.
    
    Parameters:
    
    classLoader - Class loader used to discover services.
    
    Returns:
    
    Returns a model assembler.
  - getMetadataProperty
```
public java.util.Optional<Node> getMetadataProperty(java.lang.String name)
```
    Gets a metadata property by namespace and name.
    
    Parameters:
    
    name - Name of the property to retrieve.
    
    Returns:
    
    Returns the optional property.
  - getMetadata
```
public java.util.Map<java.lang.String,Node> getMetadata()
```
    Returns:
    
    Gets the unmodifiable metadata of the model across all namespaces.
  - getTraitDefinition
```
public java.util.Optional<TraitDefinition> getTraitDefinition(ToShapeId traitId)
```
    Gets the trait definition of a specific trait shape ID.
    
    Parameters:
    
    traitId - ID of the shape to get the trait definition of.
    
    Returns:
    
    Returns the optionally found trait definition.
  - getShapesWithTrait
```
public java.util.Set<Shape> getShapesWithTrait(ToShapeId trait)
```
    Gets a set of shapes in the model marked with a specific trait.
    
    Parameters:
    
    trait - Trait shape ID to look for on shapes.
    
    Returns:
    
    Returns the immutable set of matching shapes.
  - getShapeIds
```
public java.util.Set<ShapeId> getShapeIds()
```
    Gets the immutable set of ShapeId in the model.
    
    Returns:
    
    Returns the shape IDs.
  - getShapesWithTrait
```
public java.util.Set<Shape> getShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets a set of shapes in the model marked with a specific trait.
    The result is an exact match on trait classes and does not utilize any kind of polymorphic instance of checks.
    
    Parameters:
    
    trait - Trait class to look for on shapes.
    
    Returns:
    
    Returns the immutable set of matching shapes.
  - getBigDecimalShapes
```
public java.util.Set<BigDecimalShape> getBigDecimalShapes()
```
    Gets an immutable set of all bigDecimals in the Model.
    
    Returns:
    
    Returns the Set of bigDecimalss.
  - getBigDecimalShapesWithTrait
```
public java.util.Set<BigDecimalShape> getBigDecimalShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all bigDecimals in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of bigdecimals that have a specific trait.
  - getBigIntegerShapes
```
public java.util.Set<BigIntegerShape> getBigIntegerShapes()
```
    Gets an immutable set of all bigIntegers in the Model.
    
    Returns:
    
    Returns the Set of bigIntegerss.
  - getBigIntegerShapesWithTrait
```
public java.util.Set<BigIntegerShape> getBigIntegerShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all bigIntegers in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of bigIntegerss that have a specific trait.
  - getBlobShapes
```
public java.util.Set<BlobShape> getBlobShapes()
```
    Gets an immutable set of all blobs in the Model.
    
    Returns:
    
    Returns the Set of blobs.
  - getBlobShapesWithTrait
```
public java.util.Set<BlobShape> getBlobShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all blobs in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of blobs that have a specific trait.
  - getBooleanShapes
```
public java.util.Set<BooleanShape> getBooleanShapes()
```
    Gets an immutable set of all booleans in the Model.
    
    Returns:
    
    Returns the Set of booleans.
  - getBooleanShapesWithTrait
```
public java.util.Set<BooleanShape> getBooleanShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all booleans in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of booleans that have a specific trait.
  - getByteShapes
```
public java.util.Set<ByteShape> getByteShapes()
```
    Gets an immutable set of all bytes in the Model.
    
    Returns:
    
    Returns the Set of bytes.
  - getByteShapesWithTrait
```
public java.util.Set<ByteShape> getByteShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all bytes in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of bytes that have a specific trait.
  - getDocumentShapes
```
public java.util.Set<DocumentShape> getDocumentShapes()
```
    Gets an immutable set of all documents in the Model.
    
    Returns:
    
    Returns the Set of documents.
  - getDocumentShapesWithTrait
```
public java.util.Set<DocumentShape> getDocumentShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all documents in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of documents that have a specific trait.
  - getDoubleShapes
```
public java.util.Set<DoubleShape> getDoubleShapes()
```
    Gets an immutable set of all doubles in the Model.
    
    Returns:
    
    Returns the Set of doubles.
  - getDoubleShapesWithTrait
```
public java.util.Set<DoubleShape> getDoubleShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all doubles in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of doubles that have a specific trait.
  - getFloatShapes
```
public java.util.Set<FloatShape> getFloatShapes()
```
    Gets an immutable set of all floats in the Model.
    
    Returns:
    
    Returns the Set of floats.
  - getFloatShapesWithTrait
```
public java.util.Set<FloatShape> getFloatShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all floats in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of floats that have a specific trait.
  - getIntegerShapes
```
public java.util.Set<IntegerShape> getIntegerShapes()
```
    Gets an immutable set of all integers in the Model.
    
    Returns:
    
    Returns the Set of integers.
  - getIntegerShapesWithTrait
```
public java.util.Set<IntegerShape> getIntegerShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all integers in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of integers that have a specific trait.
  - getListShapes
```
public java.util.Set<ListShape> getListShapes()
```
    Gets an immutable set of all lists in the Model.
    
    Returns:
    
    Returns the Set of lists.
  - getListShapesWithTrait
```
public java.util.Set<ListShape> getListShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all lists in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of lists that have a specific trait.
  - getLongShapes
```
public java.util.Set<LongShape> getLongShapes()
```
    Gets an immutable set of all longs in the Model.
    
    Returns:
    
    Returns the Set of longs.
  - getLongShapesWithTrait
```
public java.util.Set<LongShape> getLongShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all longs in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of longs that have a specific trait.
  - getMapShapes
```
public java.util.Set<MapShape> getMapShapes()
```
    Gets an immutable set of all maps in the Model.
    
    Returns:
    
    Returns the Set of maps.
  - getMapShapesWithTrait
```
public java.util.Set<MapShape> getMapShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all maps in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of maps that have a specific trait.
  - getMemberShapes
```
public java.util.Set<MemberShape> getMemberShapes()
```
    Gets an immutable set of all members in the Model.
    
    Returns:
    
    Returns the Set of members.
  - getMemberShapesWithTrait
```
public java.util.Set<MemberShape> getMemberShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all members in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of members that have a specific trait.
  - getOperationShapes
```
public java.util.Set<OperationShape> getOperationShapes()
```
    Gets an immutable set of all operations in the Model.
    
    Returns:
    
    Returns the Set of operations.
  - getOperationShapesWithTrait
```
public java.util.Set<OperationShape> getOperationShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all operations in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of operations that have a specific trait.
  - getResourceShapes
```
public java.util.Set<ResourceShape> getResourceShapes()
```
    Gets an immutable set of all resources in the Model.
    
    Returns:
    
    Returns the Set of resources.
  - getResourceShapesWithTrait
```
public java.util.Set<ResourceShape> getResourceShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all resources in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of resources that have a specific trait.
  - getServiceShapes
```
public java.util.Set<ServiceShape> getServiceShapes()
```
    Gets an immutable set of all services in the Model.
    
    Returns:
    
    Returns the Set of services.
  - getServiceShapesWithTrait
```
public java.util.Set<ServiceShape> getServiceShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all services in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of services that have a specific trait.
  - getSetShapes
```
public java.util.Set<SetShape> getSetShapes()
```
    Gets an immutable set of all sets in the Model.
    
    Returns:
    
    Returns the Set of sets.
  - getSetShapesWithTrait
```
public java.util.Set<SetShape> getSetShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all sets in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of sets that have a specific trait.
  - getShortShapes
```
public java.util.Set<ShortShape> getShortShapes()
```
    Gets an immutable set of all shorts in the Model.
    
    Returns:
    
    Returns the Set of shorts.
  - getShortShapesWithTrait
```
public java.util.Set<ShortShape> getShortShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all shorts in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of shorts that have a specific trait.
  - getStringShapes
```
public java.util.Set<StringShape> getStringShapes()
```
    Gets an immutable set of all strings in the Model.
    
    Returns:
    
    Returns the Set of strings.
  - getStringShapesWithTrait
```
public java.util.Set<StringShape> getStringShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all strings in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of strings that have a specific trait.
  - getStructureShapes
```
public java.util.Set<StructureShape> getStructureShapes()
```
    Gets an immutable set of all structures in the Model.
    
    Returns:
    
    Returns the Set of structures.
  - getStructureShapesWithTrait
```
public java.util.Set<StructureShape> getStructureShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all structures in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of structures that have a specific trait.
  - getTimestampShapes
```
public java.util.Set<TimestampShape> getTimestampShapes()
```
    Gets an immutable set of all timestamps in the Model.
    
    Returns:
    
    Returns the Set of timestamps.
  - getTimestampShapesWithTrait
```
public java.util.Set<TimestampShape> getTimestampShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all timestamps in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of timestamps that have a specific trait.
  - getUnionShapes
```
public java.util.Set<UnionShape> getUnionShapes()
```
    Gets an immutable set of all unions in the Model.
    
    Returns:
    
    Returns the Set of unions.
  - getUnionShapesWithTrait
```
public java.util.Set<UnionShape> getUnionShapesWithTrait(java.lang.Class<? extends Trait> trait)
```
    Gets an immutable set of all unions in the Model that have a specific trait.
    
    Parameters:
    
    trait - The exact trait class to look for on shapes.
    
    Returns:
    
    Returns the set of unions that have a specific trait.
  - getAppliedTraits
```
public java.util.Set<ShapeId> getAppliedTraits()
```
    Gets a set of every trait shape ID that is used in the model.
    
    Returns:
    
    Returns the shape IDs of traits used in the model.
  - isTraitApplied
```
public boolean isTraitApplied(java.lang.Class<? extends Trait> trait)
```
    Returns true if the given trait shape ID was used in the model.
    
    Parameters:
    
    trait - The trait class to check.
    
    Returns:
    
    Returns true if the trait was used in the model.
  - getShape
```
public java.util.Optional<Shape> getShape(ShapeId id)
```
    Attempts to retrieve a Shape by ShapeId.
    
    Parameters:
    
    id - Shape to retrieve by ID.
    
    Returns:
    
    Returns the optional shape.
  - expectShape
```
public Shape expectShape(ShapeId id)
```
    Attempts to retrieve a Shape by ShapeId and throws if not found.
    
    Parameters:
    
    id - Shape to retrieve by ID.
    
    Returns:
    
    Returns the shape.
    
    Throws:
    
    ExpectationNotMetException - if the shape is not found.
  - expectShape
```
public <T extends Shape> T expectShape(ShapeId id,
                                       java.lang.Class<T> type)
```
    Attempts to retrieve a Shape by ShapeId and throws if not found or if the shape is not of the expected type.
    
    Type Parameters:
    
    T - Expected shape type.
    
    Parameters:
    
    id - Shape to retrieve by ID.
    
    type - Shape type to expect and convert to.
    
    Returns:
    
    Returns the shape.
    
    Throws:
    
    ExpectationNotMetException - if the shape is not found or is not the expected type.
  - shapes
```
public java.util.stream.Stream<Shape> shapes()
```
    Gets a stream of Shapes in the index.
    
    Returns:
    
    Returns a stream of shapes.
  - shapes
```
public <T extends Shape> java.util.stream.Stream<T> shapes(java.lang.Class<T> shapeType)
```
    Gets a stream of shapes in the index of a specific type T.
    The provided shapeType class must exactly match the class of a shape in the model in order to be returned from this method; that is, the provided class must be a concrete subclass of Shape and not an abstract class like NumberShape.
    
    Type Parameters:
    
    T - Shape type to stream from the index.
    
    Parameters:
    
    shapeType - Shape type T to retrieve.
    
    Returns:
    
    A stream of shapes of T matching shapeType.
  - toSet
```
public <T extends Shape> java.util.Set<T> toSet(java.lang.Class<T> shapeType)
```
    Gets an immutable Set of shapes of a specific type.
    
    Type Parameters:
    
    T - Shape type to get from the index.
    
    Parameters:
    
    shapeType - Type of shape to get a set of.
    
    Returns:
    
    Returns an unmodifiable set of shapes.
  - toSet
```
public java.util.Set<Shape> toSet()
```
    Converts the model to an immutable Set of shapes.
    
    Returns:
    
    Returns an unmodifiable set of shapes.
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toBuilder
```
public Model.Builder toBuilder()
```
    Description copied from interface: ToSmithyBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToSmithyBuilder<Model>
    
    Returns:
    
    a builder for type T
  - getKnowledge
```
@Deprecated
public <T extends KnowledgeIndex> T getKnowledge(java.lang.Class<T> type)
```
    Deprecated.
    
    This method is deprecated. Use the of method of the KnowledgeIndex you wish to create instead.
    
    Type Parameters:
    
    T - The type of knowledge index to retrieve.
    
    Parameters:
    
    type - Type of knowledge index to retrieve.
    
    Returns:
    
    Returns the computed knowledge index.
  - getKnowledge
```
public <T extends KnowledgeIndex> T getKnowledge(java.lang.Class<T> type,
                                                 java.util.function.Function<Model,T> constructor)
```
    Gets a computed "knowledge index" of a specific type for the model and caches it for subsequent retrieval.
    This method should not typically be called directly because KnowledgeIndex classes should all provide a public static of method that accepts a Model and returns an instance of the index by invoking getKnowledge.
    If a KnowledgeIndex of the given type has not yet been computed, one will be created using the provided constructor function that accepts a Model. Computed knowledge indexes are cached and returned on subsequent retrievals.
    
    Type Parameters:
    
    T - The type of knowledge index to retrieve.
    
    Parameters:
    
    type - Type of knowledge index to retrieve.
    
    constructor - The method used to create type.
    
    Returns:
    
    Returns the computed knowledge index.

Class Model

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MODEL_VERSION

Method Detail

builder

assembler

assembler

getMetadataProperty

getMetadata

getTraitDefinition

getShapesWithTrait

getShapeIds

getShapesWithTrait

getBigDecimalShapes

getBigDecimalShapesWithTrait

getBigIntegerShapes

getBigIntegerShapesWithTrait

getBlobShapes

getBlobShapesWithTrait

getBooleanShapes

getBooleanShapesWithTrait

getByteShapes

getByteShapesWithTrait

getDocumentShapes

getDocumentShapesWithTrait

getDoubleShapes

getDoubleShapesWithTrait

getFloatShapes

getFloatShapesWithTrait

getIntegerShapes

getIntegerShapesWithTrait

getListShapes

getListShapesWithTrait

getLongShapes

getLongShapesWithTrait

getMapShapes

getMapShapesWithTrait

getMemberShapes

getMemberShapesWithTrait

getOperationShapes

getOperationShapesWithTrait

getResourceShapes

getResourceShapesWithTrait

getServiceShapes

getServiceShapesWithTrait

getSetShapes

getSetShapesWithTrait

getShortShapes

getShortShapesWithTrait

getStringShapes

getStringShapesWithTrait

getStructureShapes

getStructureShapesWithTrait

getTimestampShapes

getTimestampShapesWithTrait

getUnionShapes

getUnionShapesWithTrait

getAppliedTraits

isTraitApplied

getShape

expectShape

expectShape

shapes

shapes

toSet

toSet

equals

hashCode

toBuilder

getKnowledge

getKnowledge