software.amazon.smithy.model.shapes

Class ModelSerializer.Builder

java.lang.Object

software.amazon.smithy.model.shapes.ModelSerializer.Builder

All Implemented Interfaces:

software.amazon.smithy.utils.SmithyBuilder<ModelSerializer>

Enclosing class:

ModelSerializer

public static final class ModelSerializer.Builder
extends java.lang.Object
implements software.amazon.smithy.utils.SmithyBuilder<ModelSerializer>

Builder used to create ModelSerializer.

Method Summary

Modifier and Type	Method and Description
ModelSerializer	build()
ModelSerializer.Builder	includePrelude(boolean includePrelude) Enables or disables including the prelude in the serialized model.
ModelSerializer.Builder	metadataFilter(java.util.function.Predicate<java.lang.String> metadataFilter) Predicate that determines if a metadata is serialized.
ModelSerializer.Builder	shapeFilter(java.util.function.Predicate<Shape> shapeFilter) Predicate that determines if a shape and its traits are serialized.
ModelSerializer.Builder	traitFilter(java.util.function.Predicate<Trait> traitFilter) Sets a predicate that can be used to filter trait values from appearing in the serialized model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.utils.SmithyBuilder

requiredState

Method Detail

metadataFilter

public ModelSerializer.Builder metadataFilter(java.util.function.Predicate<java.lang.String> metadataFilter)

Predicate that determines if a metadata is serialized.

Parameters:

metadataFilter - Predicate that accepts a metadata key.

Returns:

Returns the builder.

shapeFilter

public ModelSerializer.Builder shapeFilter(java.util.function.Predicate<Shape> shapeFilter)

Predicate that determines if a shape and its traits are serialized.

Parameters:

shapeFilter - Predicate that accepts a shape.

Returns:

Returns the builder.

includePrelude

public ModelSerializer.Builder includePrelude(boolean includePrelude)

Enables or disables including the prelude in the serialized model.

By default, the prelude is not included.

This should nearly always be left at default, as per the spec the prelude is inherently part of every model, and so any Smithy implementation must build in an understanding of the prelude. Disabling this filter can be useful for those implementations to allow them to build their understanding of it from a JSON version of the prelude.

Parameters:

includePrelude - boolean indicating whether the prelude should be included or not.

Returns:

Returns the builder.

traitFilter

public ModelSerializer.Builder traitFilter(java.util.function.Predicate<Trait> traitFilter)

Sets a predicate that can be used to filter trait values from appearing in the serialized model.

Note that this does not filter out trait definitions. It only filters out instances of traits from being serialized on shapes.

Parameters:

traitFilter - Predicate that filters out trait definitions.

Returns:

Returns the builder.

build

public ModelSerializer build()

Specified by:

build in interface software.amazon.smithy.utils.SmithyBuilder<ModelSerializer>