Package software.amazon.smithy.build

Class SmithyBuildResult

  • public final class SmithyBuildResult
extends java.lang.Object
    Encapsulates the result of running SmithyBuild.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SmithyBuildResult.Builder
      Creates a SmithyBuildResult.

    • Method Summary

      Modifier and Type Method Description
      java.util.stream.Stream<java.nio.file.Path> allArtifacts()
      Gets all of the artifacts written during the build.
      java.util.stream.Stream<FileManifest> allManifests()
      Gets all of the manifests that were used in the build.
      boolean anyBroken()
      Returns true if any projected models contain error or danger events.
      static SmithyBuildResult.Builder builder()
      Creates a builder used to build SmithyBuildResult.
      java.util.Optional<ProjectionResult> getProjectionResult​(java.lang.String projectionName)
      Gets a projection result by name.
      java.util.List<ProjectionResult> getProjectionResults()
      Gets all of the projection results as an unmodifiable list.
      java.util.Map<java.lang.String,​ProjectionResult> getProjectionResultsMap()
      Gets all of the projection results as a map of projection name to ProjectionResult.
      boolean isEmpty()
      Checks if the results is empty.
      int size()
      Gets the number of projection results in the map.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • builder

        public static SmithyBuildResult.Builder builder()
        Creates a builder used to build SmithyBuildResult.
        Returns:
        Returns the builder.

      • anyBroken

        public boolean anyBroken()
        Returns true if any projected models contain error or danger events.
        Returns:
        Returns true if any are broken.

      • allArtifacts

        public java.util.stream.Stream<java.nio.file.Path> allArtifacts()
        Gets all of the artifacts written during the build.
        Returns:
        Returns a stream of paths to artifacts.

      • allManifests

        public java.util.stream.Stream<FileManifest> allManifests()
        Gets all of the manifests that were used in the build.
        Returns:
        Returns a stream of the manifests.

      • getProjectionResult

        public java.util.Optional<ProjectionResult> getProjectionResult​(java.lang.String projectionName)
        Gets a projection result by name.
        Parameters:
        projectionName - ProjectionConfig name to get.
        Returns:
        Returns the optionally found result.

      • getProjectionResults

        public java.util.List<ProjectionResult> getProjectionResults()
        Gets all of the projection results as an unmodifiable list.
        Returns:
        Returns the projection results.

      • getProjectionResultsMap

        public java.util.Map<java.lang.String,​ProjectionResult> getProjectionResultsMap()
        Gets all of the projection results as a map of projection name to ProjectionResult.
        Returns:
        Returns the projection results as a map.

      • size

        public int size()
        Gets the number of projection results in the map.
        Returns:
        Returns the number of results.

      • isEmpty

        public boolean isEmpty()
        Checks if the results is empty.
        Returns:
        Returns true if there are no results.