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

    • ArchiveRootBuildItem

      @Deprecated public ArchiveRootBuildItem(Path archiveLocation, Path archiveRoot)
      Deprecated.
      Use ArchiveRootBuildItem.Builder instead. Constructs an ArchiveRootBuildItem with a given archive location and root directory.
      Parameters:
      archiveLocation - the archive location (e.g., JAR file path)
      archiveRoot - the root directory of the archive

  • Method Details

    • builder

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

    • getArchiveLocation

      @Deprecated public Path getArchiveLocation()
      Deprecated.
      in favor of getResolvedPaths()
      If this archive is a jar file it will return the path to the jar file on the file system, otherwise it will return the directory that this corresponds to.

    • getArchiveRoot

      @Deprecated public Path getArchiveRoot()
      Deprecated.
      in favor of getRootDirectories()
      Returns a path representing the archive root. Note that if this is a jar archive this is not the path to the jar, but rather a path to the root of the mounted
      invalid reference 
      com.sun.nio.zipfs.ZipFileSystem
      .
      Returns:
      The archive root.

    • getRootDirs

      @Deprecated public io.quarkus.bootstrap.model.PathsCollection getRootDirs()
      Deprecated.
      in favor of 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

    • 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

    • getPaths

      @Deprecated public io.quarkus.bootstrap.model.PathsCollection getPaths()
      Deprecated.
      in favor of getResolvedPaths()
      Collection of paths that collectively constitute the application archive's content.
      Returns:
      collection of paths that collectively constitute the application archive content

    • 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)