Package io.quarkus.deployment.builditem

Class ArchiveRootBuildItem.Builder

java.lang.Object

io.quarkus.deployment.builditem.ArchiveRootBuildItem.Builder

Enclosing class:

ArchiveRootBuildItem

public static class ArchiveRootBuildItem.Builder
extends Object

Builder for constructing ArchiveRootBuildItem instances.

Method Summary

Modifier and Type	Method	Description
ArchiveRootBuildItem.Builder	addArchiveRoot(Path root)	Adds a single archive root path to the builder.
ArchiveRootBuildItem.Builder	addArchiveRoots(io.quarkus.paths.PathCollection paths)	Adds multiple archive root paths to the builder.
ArchiveRootBuildItem	build(QuarkusBuildCloseablesBuildItem buildCloseables)	Builds the ArchiveRootBuildItem using the configured properties.
ArchiveRootBuildItem.Builder	setArchiveLocation(Path archiveLocation)	Deprecated. Use addArchiveRoot(Path) instead to add archive roots.
ArchiveRootBuildItem.Builder	setExcludedFromIndexing(Collection<Path> excludedFromIndexing)	Sets the collection of paths to exclude from indexing.

Methods inherited from class java.lang.Object

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

Method Details

addArchiveRoot

public ArchiveRootBuildItem.Builder addArchiveRoot(Path root)

Adds a single archive root path to the builder.

Parameters:

root - the archive root path to add

Returns:

this builder instance

addArchiveRoots

public ArchiveRootBuildItem.Builder addArchiveRoots(io.quarkus.paths.PathCollection paths)

Adds multiple archive root paths to the builder.

Parameters:

paths - a PathCollection of archive root paths to add

Returns:

this builder instance

setExcludedFromIndexing

public ArchiveRootBuildItem.Builder setExcludedFromIndexing(Collection<Path> excludedFromIndexing)

Sets the collection of paths to exclude from indexing.

Parameters:

excludedFromIndexing - a collection of paths to be excluded

Returns:

this builder instance

setArchiveLocation

@Deprecated
public ArchiveRootBuildItem.Builder setArchiveLocation(Path archiveLocation)

Deprecated.

Use addArchiveRoot(Path) instead to add archive roots. This method clears previous archive roots before setting the new one.

Parameters:

archiveLocation - the archive location to set

Returns:

this builder instance

build

public ArchiveRootBuildItem build(QuarkusBuildCloseablesBuildItem buildCloseables)
                           throws IOException

Builds the ArchiveRootBuildItem using the configured properties.

Parameters:

buildCloseables - a QuarkusBuildCloseablesBuildItem to manage opened resources (e.g., zip file systems)

Returns:

a new ArchiveRootBuildItem instance

Throws:

IOException - if an I/O error occurs when accessing the archive roots