SmithyIdlModelSerializer (Smithy API 1.47.0)

java.lang.Object
- software.amazon.smithy.model.shapes.SmithyIdlModelSerializer

public final class SmithyIdlModelSerializer
extends java.lang.Object

Serializes a Model into a set of Smithy IDL files.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SmithyIdlModelSerializer.Builder
Builder used to create SmithyIdlModelSerializer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SmithyIdlModelSerializer.Builder`	`builder()`
`static java.nio.file.Path`	`placeShapesByNamespace(Shape shape)`	Sorts shapes into files based on their namespace, where each file is named {namespace}.smithy.
`java.util.Map<java.nio.file.Path,java.lang.String>`	`serialize(Model model)`	Serializes a `Model` into a set of Smithy IDL files.

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

- Method Detail
  - serialize
```
public java.util.Map<java.nio.file.Path,java.lang.String> serialize(Model model)
```
    Serializes a Model into a set of Smithy IDL files.
    The output is a mapping
    By default the paths are relative paths where each namespace is given its own file in the form "namespace.smithy". This is configurable via the shape placer, which can place shapes into absolute paths.
    If the model contains no shapes, or all shapes are filtered out, then a single path "metadata.smithy" will be present. This will contain only any defined metadata.
    
    Parameters:
    
    model - The model to serialize.
    
    Returns:
    
    A map of (possibly relative) file paths to Smithy IDL strings.
  - builder
```
public static SmithyIdlModelSerializer.Builder builder()
```
    Returns:
    
    Returns a builder used to create a SmithyIdlModelSerializer
  - placeShapesByNamespace
```
public static java.nio.file.Path placeShapesByNamespace(Shape shape)
```
    Sorts shapes into files based on their namespace, where each file is named {namespace}.smithy.
    
    Parameters:
    
    shape - The shape to assign a file to.
    
    Returns:
    
    Returns the file the given shape should be placed in.