Package software.amazon.smithy.build.transforms

Class IncludeMetadata

java.lang.Object

software.amazon.smithy.build.transforms.ConfigurableProjectionTransformer<IncludeMetadata.Config>

software.amazon.smithy.build.transforms.IncludeMetadata

All Implemented Interfaces:

ProjectionTransformer

public final class IncludeMetadata
extends ConfigurableProjectionTransformer<IncludeMetadata.Config>

includeMetadata keeps only metadata keys specifically defined in the provided keys setting.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IncludeMetadata.Config	includeMetadata configuration settings.

Constructor Summary

Constructors

Constructor	Description
IncludeMetadata()

Method Summary

Modifier and Type	Method	Description
List<String>	getAdditionalProjections(TransformContext context)	Allows the composition of projections by returning additional projections to run after the current one.
Class<IncludeMetadata.Config>	getConfigType()	Gets the configuration class type.
String	getName()	Gets the name of the transformer.
software.amazon.smithy.model.Model	transform(TransformContext context)	Transforms the given model using the provided TransformContext.
protected software.amazon.smithy.model.Model	transformWithConfig(TransformContext context, IncludeMetadata.Config config)	Executes the transform using the deserialized configuration object.

Methods inherited from class software.amazon.smithy.build.transforms.ConfigurableProjectionTransformer

getAdditionalProjectionsFunction

Methods inherited from class java.lang.Object

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

Constructor Details

IncludeMetadata

public IncludeMetadata()

Method Details

getConfigType

public Class<IncludeMetadata.Config> getConfigType()

Description copied from class: ConfigurableProjectionTransformer

Gets the configuration class type.

The referenced configType class must be a public POJO with a public, zero-arg constructor, getters, and setters. If the POJO has a public static fromNode method, it will be invoked and is expected to deserialize the Node. If the POJO has a public static builder method, it will be invoked, setters will be called on the builder POJO, and finally the result of calling the build method is used as the configuration type. Finally, the deserializer will attempt to create the type and call setters on the instantiated object that correspond to property names (either named "set" + property name, or just property name).

Specified by:

getConfigType in class ConfigurableProjectionTransformer<IncludeMetadata.Config>

Returns:

Returns the configuration class (a POJO with setters/getters).

getName

public String getName()

Description copied from interface: ProjectionTransformer

Gets the name of the transformer.

Returns:

Returns the name (e.g., "traits").

transformWithConfig

protected software.amazon.smithy.model.Model transformWithConfig(TransformContext context,
 IncludeMetadata.Config config)

Description copied from class: ConfigurableProjectionTransformer

Executes the transform using the deserialized configuration object.

Specified by:

transformWithConfig in class ConfigurableProjectionTransformer<IncludeMetadata.Config>

Parameters:

context - Transform context.

config - Deserialized configuration object.

Returns:

Returns the transformed model.

transform

public software.amazon.smithy.model.Model transform(TransformContext context)

Description copied from interface: ProjectionTransformer

Transforms the given model using the provided TransformContext.

Specified by:

transform in interface ProjectionTransformer

Overrides:

transform in class ConfigurableProjectionTransformer<T>

Parameters:

context - Transformation context.

Returns:

Returns the created transformer.

getAdditionalProjections

public List<String> getAdditionalProjections(TransformContext context)

Description copied from interface: ProjectionTransformer

Allows the composition of projections by returning additional projections to run after the current one.

Specified by:

getAdditionalProjections in interface ProjectionTransformer

Overrides:

getAdditionalProjections in class ConfigurableProjectionTransformer<T>

Parameters:

context - Transformation context.

Returns:

a collection of named projections to run.