Package software.amazon.smithy.build

Class ProjectionResult

java.lang.Object

software.amazon.smithy.build.ProjectionResult

public final class ProjectionResult
extends java.lang.Object

The result of applying a projection to a model.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProjectionResult.Builder	Builds up a ProjectionResult.

Method Summary

Modifier and Type	Method	Description
static ProjectionResult.Builder	builder()	Creates a ProjectionResult builder.
java.util.List<ValidationEvent>	getEvents()	Gets the validation events encountered after projecting the model.
Model	getModel()	Gets the result of projecting the model.
java.util.Optional<FileManifest>	getPluginManifest(java.lang.String artifactName)	Gets the result of a specific plugin by plugin artifact name.
java.util.Map<java.lang.String,FileManifest>	getPluginManifests()	Gets the results of each plugin.
java.lang.String	getProjectionName()	Gets the name of the projection that was executed.
boolean	isBroken()	Returns true if the projection contains error or danger events.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ProjectionResult.Builder builder()

Creates a ProjectionResult builder.

Returns:

Returns the created builder.

getProjectionName

public java.lang.String getProjectionName()

Gets the name of the projection that was executed.

Returns:

Returns the projection name.

getModel

public Model getModel()

Gets the result of projecting the model.

Returns:

Returns the projected model.

isBroken

public boolean isBroken()

Returns true if the projection contains error or danger events.

Returns:

Returns true if the projected model is broken.

getEvents

public java.util.List<ValidationEvent> getEvents()

Gets the validation events encountered after projecting the model.

Returns:

Returns the encountered validation events.

getPluginManifests

public java.util.Map<java.lang.String,FileManifest> getPluginManifests()

Gets the results of each plugin.

Returns:

Returns a map of plugin names to their file manifests.

getPluginManifest

public java.util.Optional<FileManifest> getPluginManifest(java.lang.String artifactName)

Gets the result of a specific plugin by plugin artifact name.

If no artifact name is configured for a plugin in smithy-build.json (e.g., "plugin::artifact"), the artifact name defaults to the plugin name.

Parameters:

artifactName - Name of the plugin artifact to retrieve.

Returns:

Returns files created by the given plugin or an empty list.