Package io.quarkus.deployment
Interface ApplicationArchive
-
- All Known Implementing Classes:
ApplicationArchiveImpl
public interface ApplicationArchive
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
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description void
accept(Consumer<io.quarkus.paths.OpenPathTree> func)
Accepts a consumer for the content tree of the archive.<T> T
apply(Function<io.quarkus.paths.OpenPathTree,T> func)
Applies a function to the content tree of the archive.Path
getArchiveLocation()
Deprecated.in favor ofgetResolvedPaths()
io.quarkus.bootstrap.model.AppArtifactKey
getArtifactKey()
Deprecated.in favor ofgetKey()
default Path
getChildPath(String path)
Convenience method, returns the child path if it exists, otherwise null.org.jboss.jandex.IndexView
getIndex()
io.quarkus.maven.dependency.ArtifactKey
getKey()
io.quarkus.bootstrap.model.PathsCollection
getPaths()
Deprecated.in favor ofgetResolvedPaths()
io.quarkus.paths.PathCollection
getResolvedPaths()
io.quarkus.paths.PathCollection
getRootDirectories()
Returns paths representing the archive root directories.io.quarkus.bootstrap.model.PathsCollection
getRootDirs()
Deprecated.in favor ofgetRootDirectories()
Returns paths representing the archive root directories.
-
-
-
Method Detail
-
getIndex
org.jboss.jandex.IndexView getIndex()
- Returns:
- The index of this application Archive
-
getArchiveLocation
@Deprecated Path getArchiveLocation()
Deprecated.in favor ofgetResolvedPaths()
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.
-
getRootDirs
@Deprecated io.quarkus.bootstrap.model.PathsCollection getRootDirs()
Deprecated.in favor ofgetRootDirectories()
Returns paths representing the archive root directories. Note that every path in this collection is guaranteed to be a directory. If the actual application archive appears to be a JAR, this collection will include a path to the root of the mountedFileSystem
created from the JAR.- Returns:
- The archive root directories.
-
getRootDirectories
io.quarkus.paths.PathCollection getRootDirectories()
Returns paths representing the archive root directories. Note that every path in this collection is guaranteed to be a directory. If the actual application archive appears to be a JAR, this collection will include a path to the root of the mountedFileSystem
created from the JAR.- Returns:
- The archive root directories.
-
getPaths
@Deprecated io.quarkus.bootstrap.model.PathsCollection getPaths()
Deprecated.in favor ofgetResolvedPaths()
- Returns:
- The paths representing the application root paths.
-
getResolvedPaths
io.quarkus.paths.PathCollection getResolvedPaths()
- Returns:
- The paths representing the application root paths.
-
getArtifactKey
io.quarkus.bootstrap.model.AppArtifactKey getArtifactKey()
Deprecated.in favor ofgetKey()
- Returns:
- the artifact key or null if not available
-
getKey
io.quarkus.maven.dependency.ArtifactKey getKey()
- Returns:
- the artifact key or null if not available
-
apply
<T> T apply(Function<io.quarkus.paths.OpenPathTree,T> func)
Applies a function to the content tree of the archive.- Type Parameters:
T
- result type of the function- Parameters:
func
- function to apply- Returns:
- the result of the function
-
accept
void accept(Consumer<io.quarkus.paths.OpenPathTree> func)
Accepts a consumer for the content tree of the archive.- Parameters:
func
- consumer
-
-