Package io.quarkus.devtools.project.buildfile

Class KotlinGradleBuildFile

java.lang.Object

io.quarkus.devtools.project.buildfile.KotlinGradleBuildFile

All Implemented Interfaces:

ExtensionManager

public class KotlinGradleBuildFile
extends Object

Nested Class Summary

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

ExtensionManager.InstallResult, ExtensionManager.UninstallResult

Constructor Summary

Constructors

Constructor	Description
KotlinGradleBuildFile()

Method Summary

Modifier and Type	Method	Description
BuildTool	getBuildTool()
Collection<io.quarkus.maven.dependency.ArtifactCoords>	getInstalled()	Read the build file(s) to get the list of installed extensions in this Quarkus project.
Collection<io.quarkus.maven.dependency.ArtifactCoords>	getInstalledPlatforms()	Returns the list of the imported platforms in the current project.
ExtensionManager.InstallResult	install(ExtensionInstallPlan request)	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).
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).

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

isInstalled

Constructor Detail

KotlinGradleBuildFile

public KotlinGradleBuildFile()

Method Detail

getBuildTool

public BuildTool getBuildTool()

Returns:

the BuildTool of this extension manager

getInstalled

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

getInstalledPlatforms

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

Description copied from interface: ExtensionManager

Returns the list of the imported platforms in the current project.

Specified by:

getInstalledPlatforms in interface ExtensionManager

Returns:

current list of imported platforms

Throws:

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

install

public 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 request)
                                       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:

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

uninstall

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