Package software.amazon.smithy.build.transforms

Class RenameShapes

java.lang.Object

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

software.amazon.smithy.build.transforms.RenameShapes

All Implemented Interfaces:

ProjectionTransformer

public final class RenameShapes
extends ConfigurableProjectionTransformer<RenameShapes.Config>

renameShapes updates a model by renaming shapes. When configuring the transformer, a `renamed` property must be set as a map with the keys as the `from` shape ids that will be renamed `to` the shape id values. Any references to a renamed shape will also be updated.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RenameShapes.Config	renameShapes configuration settings.

Constructor Summary

Constructors

Constructor	Description
RenameShapes()

Method Summary

Modifier and Type	Method	Description
Class<RenameShapes.Config>	getConfigType()	Gets the configuration class type.
String	getName()	Gets the name of the transformer.
protected Model	transformWithConfig(TransformContext context, RenameShapes.Config config)	Executes the transform using the deserialized configuration object.

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

getAdditionalProjections, getAdditionalProjectionsFunction, transform

Methods inherited from class java.lang.Object

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

Constructor Details

RenameShapes

public RenameShapes()

Method Details

getConfigType

public Class<RenameShapes.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<RenameShapes.Config>

Returns:

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

transformWithConfig

protected Model transformWithConfig(TransformContext context,
 RenameShapes.Config config)

Description copied from class: ConfigurableProjectionTransformer

Executes the transform using the deserialized configuration object.

Specified by:

transformWithConfig in class ConfigurableProjectionTransformer<RenameShapes.Config>

Parameters:

context - Transform context.

config - Deserialized configuration object.

Returns:

Returns the transformed model.

getName

public String getName()

Description copied from interface: ProjectionTransformer

Gets the name of the transformer.

Returns:

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