Package io.quarkus.deployment.builditem

Class ArchiveRootBuildItem

java.lang.Object
io.quarkus.builder.item.BuildItem
io.quarkus.builder.item.SimpleBuildItem
io.quarkus.deployment.builditem.ArchiveRootBuildItem
public final class ArchiveRootBuildItem extends io.quarkus.builder.item.SimpleBuildItem
Represents a build item for an archive root, typically used in Quarkus build steps to reference application classes directories or archives (like JARs) for indexing and processing.

This class contains the paths of directories or archives to be used as archive roots, as well as paths that should be excluded from indexing.

  • Constructor Details

    • ArchiveRootBuildItem

      public ArchiveRootBuildItem(Path appClassesDir)
      Constructs an ArchiveRootBuildItem with a single application classes directory.
      Parameters:
      appClassesDir - the path to the application classes directory

  • Method Details

    • builder

      public static ArchiveRootBuildItem.Builder builder()
      Creates a new ArchiveRootBuildItem.Builder instance for building an ArchiveRootBuildItem.
      Returns:
      a new ArchiveRootBuildItem.Builder instance

    • getRootDirectories

      public io.quarkus.paths.PathCollection getRootDirectories()
      Collection of paths representing the archive's root directories. If there is a JAR among the paths (returned by getResolvedPaths()) this method will return the path to the root of the mounted
      invalid reference 
      java.nio.file.ZipFileSystem
      instead.
      Returns:
      Collection of paths representing the archive's root directories

    • getResolvedPaths

      public io.quarkus.paths.PathCollection getResolvedPaths()
      Collection of paths that collectively constitute the application archive's content.
      Returns:
      collection of paths that collectively constitute the application archive content

    • isExcludedFromIndexing

      public boolean isExcludedFromIndexing(Path p)