Package software.amazon.smithy.build
Class ProjectionResult
java.lang.Object
software.amazon.smithy.build.ProjectionResult
The result of applying a projection to a model.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ProjectionResult.Builder
builder()
Creates aProjectionResult
builder.List<software.amazon.smithy.model.validation.ValidationEvent>
Gets the validation events encountered after projecting the model.software.amazon.smithy.model.Model
getModel()
Gets the result of projecting the model.getPluginManifest
(String artifactName) Gets the result of a specific plugin by plugin artifact name.Gets the results of each plugin.Gets the name of the projection that was executed.boolean
isBroken()
Returns true if the projection contains error or danger events.
-
Method Details
-
builder
Creates aProjectionResult
builder.- Returns:
- Returns the created builder.
-
getProjectionName
Gets the name of the projection that was executed.- Returns:
- Returns the projection name.
-
getModel
public software.amazon.smithy.model.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
Gets the validation events encountered after projecting the model.- Returns:
- Returns the encountered validation events.
-
getPluginManifests
Gets the results of each plugin.- Returns:
- Returns a map of plugin names to their file manifests.
-
getPluginManifest
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.
-