Package software.amazon.smithy.model.transform.plugins

Class CleanStructureAndUnionMembers

java.lang.Object

software.amazon.smithy.model.transform.plugins.CleanStructureAndUnionMembers

All Implemented Interfaces:

ModelTransformerPlugin

public final class CleanStructureAndUnionMembers
extends java.lang.Object
implements ModelTransformerPlugin

Cleans up structure, union, enum, and intEnum shapes after shapes are removed.

• Ensures that structure and union shapes are updated to no longer reference any removed members.
• Ensures that structure/union members that reference shapes that have been removed are also removed.

Constructor Summary

Constructors

Constructor	Description
CleanStructureAndUnionMembers()

Method Summary

Modifier and Type	Method	Description
Model	onRemove(ModelTransformer transformer, java.util.Collection<Shape> removed, Model model)	The method that is invoked each time shapes are removed from a model.

Methods inherited from class java.lang.Object

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

Constructor Detail

CleanStructureAndUnionMembers

public CleanStructureAndUnionMembers()

Method Detail

onRemove

public Model onRemove(ModelTransformer transformer,
                      java.util.Collection<Shape> removed,
                      Model model)

Description copied from interface: ModelTransformerPlugin

The method that is invoked each time shapes are removed from a model.

Specified by:

onRemove in interface ModelTransformerPlugin

Parameters:

transformer - Transformer used to replace/remove shapes from the model.

removed - The of shapes that were removed from the model.

model - Model that has been altered to remove removed.

Returns:

Returns a transformed version of the passed in model.