org.jboss.forge.addon.gradle.projects

Interface GradleFacet

All Superinterfaces:

org.jboss.forge.addon.facets.Facet<org.jboss.forge.addon.projects.Project>, org.jboss.forge.addon.projects.ProjectFacet, org.jboss.forge.addon.projects.ProvidedProjectFacet

public interface GradleFacet
extends org.jboss.forge.addon.projects.ProvidedProjectFacet

Main Gradle project facet. Responsible for loading and saving of the project model.

Example of usage (adding a dependency):

 GradleModelBuilder builder = GradleModelBuilder.create(gradleFacet.getModel());
 builder.addDependency(GradleDependencyBuilder.create("compile", "org.x:y:1.0"));
 gradleFacet.setModel(builder);
 

Author:

Adam Wyłuda

See Also:

GradleModel, GradleModelBuilder

Method Summary

Methods

Modifier and Type	Method and Description
boolean	executeTask(String task) Executes Gradle build with specified task.
boolean	executeTask(String task, String profile, String... arguments) Runs Gradle applying given profile.
org.jboss.forge.addon.resource.FileResource<?>	getBuildScriptResource() Returns file resource pointing to the build.gradle script of the project.
GradleModel	getModel() Returns evaluated Gradle project model.
org.jboss.forge.addon.resource.FileResource<?>	getSettingsScriptResource() Returns file resource pointing to the build.gradle script of the root project.
void	installForgeLibrary() Installs Forge library in project directory.
boolean	isForgeLibraryInstalled() Returns true if there is Forge library installed into project directory.
void	setModel(GradleModel model) Merges all changes with the old model and persists them to the build script.

Methods inherited from interface org.jboss.forge.addon.facets.Facet

getFaceted, install, isInstalled, uninstall

Method Detail

executeTask

boolean executeTask(String task)

Executes Gradle build with specified task.

executeTask

boolean executeTask(String task,
                  String profile,
                  String... arguments)

Runs Gradle applying given profile.

See Also:

GradleProfile

getModel

GradleModel getModel()

Returns evaluated Gradle project model.

setModel

void setModel(GradleModel model)

Merges all changes with the old model and persists them to the build script.

getBuildScriptResource

org.jboss.forge.addon.resource.FileResource<?> getBuildScriptResource()

Returns file resource pointing to the build.gradle script of the project.

getSettingsScriptResource

org.jboss.forge.addon.resource.FileResource<?> getSettingsScriptResource()

Returns file resource pointing to the build.gradle script of the root project.

installForgeLibrary

void installForgeLibrary()

Installs Forge library in project directory.

isForgeLibraryInstalled

boolean isForgeLibraryInstalled()

Returns true if there is Forge library installed into project directory.