Package io.quarkus.devtools.project.buildfile

Class BuildFile

java.lang.Object

io.quarkus.devtools.project.buildfile.BuildFile

All Implemented Interfaces:

ExtensionManager

Direct Known Subclasses:

AbstractGroovyGradleBuildFile, MavenBuildFile, MavenProjectBuildFile

public abstract class BuildFile
extends Object
implements ExtensionManager

Nested Class Summary

Nested classes/interfaces inherited from interface io.quarkus.devtools.project.extensions.ExtensionManager

ExtensionManager.InstallResult, ExtensionManager.UninstallResult

Constructor Summary

Constructors

Constructor	Description
BuildFile(Path projectDirPath, ExtensionCatalog catalog)

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	addDependency(io.quarkus.maven.dependency.ArtifactCoords coords, boolean managed)
protected abstract List<io.quarkus.maven.dependency.ArtifactCoords>	getDependencies()
Collection<io.quarkus.maven.dependency.ArtifactCoords>	getInstalled()	Read the build file(s) to get the list of installed extensions in this Quarkus project.
protected Path	getProjectDirPath()
protected abstract String	getProperty(String propertyName)
protected boolean	hasProjectFile(String fileName)
protected abstract boolean	importBom(io.quarkus.maven.dependency.ArtifactCoords coords)
ExtensionManager.InstallResult	install(ExtensionInstallPlan plan)	This is going to install/add all the specified extensions to the project build file(s).
ExtensionManager.InstallResult	install(Collection<io.quarkus.maven.dependency.ArtifactCoords> coords)	This is going to install/add all the specified extensions to the project build file(s).
static boolean	isDefinedInRegistry(Collection<Extension> registry, io.quarkus.maven.dependency.ArtifactKey key)
protected byte[]	readProjectFile(String fileName)
protected abstract void	refreshData()
protected abstract void	removeDependency(io.quarkus.maven.dependency.ArtifactKey key)
ExtensionManager.UninstallResult	uninstall(Collection<io.quarkus.maven.dependency.ArtifactKey> keys)	This is going to uninstall/remove all the specified extensions from the project build file(s).
protected abstract void	writeToDisk()
protected void	writeToProjectFile(String fileName, byte[] content)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.quarkus.devtools.project.extensions.ExtensionManager

getBuildTool, getInstalledPlatforms, isInstalled

Constructor Detail

BuildFile

public BuildFile(Path projectDirPath,
                 ExtensionCatalog catalog)

Method Detail

install

public final ExtensionManager.InstallResult install(Collection<io.quarkus.maven.dependency.ArtifactCoords> coords)
                                             throws IOException

Description copied from interface: ExtensionManager

This is going to install/add all the specified extensions to the project build file(s).

   - Extensions which are already installed will ALWAYS be skipped whatever the specified version
   - The provided version will be used if it wasn't already installed
 

Specified by:

install in interface ExtensionManager

Parameters:

coords - the list of ArtifactCoords for the extensions to install

Returns:

the ExtensionManager.InstallResult

Throws:

IOException - if a problem occurs while reading/writing the project build file(s)

install

public ExtensionManager.InstallResult install(ExtensionInstallPlan plan)
                                       throws IOException

Description copied from interface: ExtensionManager

This is going to install/add all the specified extensions to the project build file(s).

   - If the project Quarkus platform bom is not defined, an IllegalStateException will be thrown
   - Extensions which are already installed will ALWAYS be skipped whatever the specified version
   - The provided version will be used if wasn't already installed
 

Specified by:

install in interface ExtensionManager

Parameters:

plan - the list of ArtifactCoords for the extensions to install

Returns:

the ExtensionManager.InstallResult

Throws:

IOException - if a problem occurs while reading/writing the project build file(s)

getInstalled

public final Collection<io.quarkus.maven.dependency.ArtifactCoords> getInstalled()
                                                                          throws IOException

Description copied from interface: ExtensionManager

Read the build file(s) to get the list of installed extensions in this Quarkus project.

Specified by:

getInstalled in interface ExtensionManager

Returns:

The list of ArtifactCoords installed in the project build file(s).

Throws:

IOException - if a problem occurs while reading the project build file(s)

uninstall

public final ExtensionManager.UninstallResult uninstall(Collection<io.quarkus.maven.dependency.ArtifactKey> keys)
                                                 throws IOException

Description copied from interface: ExtensionManager

This is going to uninstall/remove all the specified extensions from the project build file(s). This is ignoring the version

Specified by:

uninstall in interface ExtensionManager

Parameters:

keys - the set of ArtifactKey for the extensions to uninstall

Returns:

the ExtensionManager.InstallResult

Throws:

IOException - if a problem occurs while reading/writing the project build file(s)

importBom

protected abstract boolean importBom(io.quarkus.maven.dependency.ArtifactCoords coords)

addDependency

protected abstract boolean addDependency(io.quarkus.maven.dependency.ArtifactCoords coords,
                                         boolean managed)

removeDependency

protected abstract void removeDependency(io.quarkus.maven.dependency.ArtifactKey key)
                                  throws IOException

Throws:

IOException

getDependencies

protected abstract List<io.quarkus.maven.dependency.ArtifactCoords> getDependencies()
                                                                             throws IOException

Throws:

IOException

writeToDisk

protected abstract void writeToDisk()
                             throws IOException

Throws:

IOException

getProperty

protected abstract String getProperty(String propertyName)
                               throws IOException

Throws:

IOException

refreshData

protected abstract void refreshData()

getProjectDirPath

protected Path getProjectDirPath()

hasProjectFile

protected boolean hasProjectFile(String fileName)
                          throws IOException

Throws:

IOException

readProjectFile

protected byte[] readProjectFile(String fileName)
                          throws IOException

Throws:

IOException

writeToProjectFile

protected void writeToProjectFile(String fileName,
                                  byte[] content)
                           throws IOException

Throws:

IOException

isDefinedInRegistry

public static boolean isDefinedInRegistry(Collection<Extension> registry,
                                          io.quarkus.maven.dependency.ArtifactKey key)