io.quarkus.deployment

Interface ApplicationArchive

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ApplicationArchiveImpl

public interface ApplicationArchive
extends Closeable

Represents an archive that is part of application code.

An application archive is an archive that provides components to the application. As a result it will be indexed via jandex, and any deployment descriptors will be made available to the application.

Method Summary

Modifier and Type	Method and Description
Path	getArchiveLocation() 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.
Path	getArchiveRoot() Returns a path representing the archive root.
default Path	getChildPath(String path) Convenience method, returns the child path if it exists, otherwise null.
org.jboss.jandex.IndexView	getIndex()
boolean	isJarArchive()

Methods inherited from interface java.io.Closeable

close

Method Detail

getIndex

org.jboss.jandex.IndexView getIndex()

Returns:

The index of this application Archive

getArchiveRoot

Path getArchiveRoot()

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 com.sun.nio.zipfs.ZipFileSystem

Returns:

The archive root.

isJarArchive

boolean isJarArchive()

Returns:

true if this archive is a jar

getArchiveLocation

Path getArchiveLocation()

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.

getChildPath

default Path getChildPath(String path)

Convenience method, returns the child path if it exists, otherwise null.

Parameters:

path - The child path

Returns:

The child path, or null if it does not exist.