software.amazon.smithy.build.plugins

Class BuildInfoPlugin

java.lang.Object

software.amazon.smithy.build.plugins.BuildInfoPlugin

All Implemented Interfaces:

SmithyBuildPlugin

public final class BuildInfoPlugin
extends java.lang.Object
implements SmithyBuildPlugin

Writes a build info file for each projection. This file contains the projection name, the filters, mappers, and validation events encountered while building the model.

This plugin is invoked regardless of whether or not the model contains error or unsuppressed validation events.

This plugin is only invoked if the projection and original model are configured on the provided PluginContext.

Constructor Summary

Constructors

Constructor and Description
BuildInfoPlugin()

Method Summary

Modifier and Type	Method and Description
void	execute(PluginContext context) Executes the plugin, creating any number of artifacts.
java.lang.String	getName() Gets the name of the plugin.
boolean	requiresValidModel() Plugins can choose whether or not to create artifacts based on whether or not the projection encountered error or unsuppressed danger events.

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.build.SmithyBuildPlugin

createServiceFactory, createServiceFactory, createServiceFactory, isSerial

Constructor Detail

BuildInfoPlugin

public BuildInfoPlugin()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: SmithyBuildPlugin

Gets the name of the plugin.

Specified by:

getName in interface SmithyBuildPlugin

Returns:

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

requiresValidModel

public boolean requiresValidModel()

Description copied from interface: SmithyBuildPlugin

Plugins can choose whether or not to create artifacts based on whether or not the projection encountered error or unsuppressed danger events.

By default plugins require that there are no errors or danger events for a given projected model.

Specified by:

requiresValidModel in interface SmithyBuildPlugin

Returns:

Returns true if the plugin should only be called if there are no error or unsuppressed danger violations for the projection.

execute

public void execute(PluginContext context)

Description copied from interface: SmithyBuildPlugin

Executes the plugin, creating any number of artifacts.

Specified by:

execute in interface SmithyBuildPlugin

Parameters:

context - Plugin context for build execution.