org.jboss.forge.addon.maven.projects

Interface MavenPluginFacet

All Superinterfaces:

Facet<Project>, ProjectFacet, ProvidedProjectFacet

public interface MavenPluginFacet
extends ProvidedProjectFacet

Author:

Paul Bakker

Method Summary

Modifier and Type	Method and Description
void	addManagedPlugin(MavenPlugin plugin) Add the given managed MavenPlugin to this Project's immediate list of managed plugins.
void	addManagedPlugin(MavenPlugin plugin, Profile profile) Add the given managed MavenPlugin to this Project's list of managed plugins under the specified profile.
void	addPlugin(MavenPlugin plugin) Add the given MavenPlugin to this Project's immediate list of plugins.
void	addPlugin(MavenPlugin plugin, Profile profile) Add the given MavenPlugin to this Project's list of plugins under the specified profile.
void	addPluginRepository(String name, String url) Add a repository to the project build system.
void	addPluginRepository(String name, String url, Profile profile) Add a repository to the project build system.
MavenPlugin	getEffectiveManagedPlugin(Coordinate coordinate) Searches Project and returns a managed plugin matching the given Coordinate at any level of the project hierarchy; return null otherwise.
MavenPlugin	getEffectiveManagedPlugin(Coordinate coordinate, Profile profile) Searches Project and returns a managed plugin matching the given Coordinate at any level of the project hierarchy; return null otherwise.
MavenPlugin	getEffectivePlugin(Coordinate coordinate) Attempt to locate a plugin given it's Coordinate, if it exists anywhere in the Project plugin hierarchy, and return it.
MavenPlugin	getEffectivePlugin(Coordinate coordinate, Profile profile) Attempt to locate a plugin given it's Coordinate, if it exists anywhere in the Project plugin hierarchy, and return it.
MavenPlugin	getManagedPlugin(Coordinate coordinate) Attempt to locate a managed a plugin given it's Coordinate, if it exists in the Project, and return it.
MavenPlugin	getManagedPlugin(Coordinate coordinate, Profile profile) Attempt to locate a managed a plugin given it's Coordinate, if it exists in the Project, and return it.
MavenPlugin	getPlugin(Coordinate coordinate) Attempt to locate a plugin given it's Coordinate, if it exists in the Project direct dependency list, and return it.
MavenPlugin	getPlugin(Coordinate coordinate, Profile profile) Attempt to locate a plugin given it's Coordinate, if it exists in the Project direct dependency list, and return it.
List<DependencyRepository>	getPluginRepositories() Get the list of plugin repositories for which this project is currently configured to use in dependency resolution.
List<DependencyRepository>	getPluginRepositories(Profile profile) Get the list of plugin repositories for which this project is currently configured to use in dependency resolution.
boolean	hasEffectiveManagedPlugin(Coordinate coordinate) Return true if this Project contains a managed plugin matching the given Coordinate at any level of the project hierarchy; return false otherwise.
boolean	hasEffectiveManagedPlugin(Coordinate coordinate, Profile profile) Return true if this Project contains a managed plugin matching the given Coordinate at any level of the project hierarchy; return false otherwise.
boolean	hasEffectivePlugin(Coordinate coordinate) Return true if the given Coordinate exists anywhere in the project dependency hierarchy.
boolean	hasEffectivePlugin(Coordinate coordinate, Profile profile) Return true if the given Coordinate exists anywhere in the project dependency hierarchy.
boolean	hasManagedPlugin(Coordinate coordinate) Return true if this Project contains a managed plugin matching the given Coordinate; return false otherwise.
boolean	hasManagedPlugin(Coordinate coordinate, Profile profile) Return true if this Project contains a managed plugin matching the given Coordinate; return false otherwise.
boolean	hasPlugin(Coordinate coordinate) Return true if this Project contains a plugin matching the given Coordinate; return false otherwise.
boolean	hasPlugin(Coordinate coordinate, Profile profile) Return true if this Project contains a plugin matching the given Coordinate; return false otherwise.
boolean	hasPluginRepository(String url) Return true if the given repository URL is already registered in this project's build system.
boolean	hasPluginRepository(String url, Profile profile) Return true if the given repository URL is already registered in this project's build system.
List<MavenPlugin>	listConfiguredEffectiveManagedPlugins() Return an immutable list of all managed MavenPlugin contained within this project, including the hierarchy.
List<MavenPlugin>	listConfiguredEffectiveManagedPlugins(Profile profile) Return an immutable list of all managed MavenPlugin contained within this project, including the hierarchy.
List<MavenPlugin>	listConfiguredEffectivePlugins() Return an immutable list of all MavenPlugin contained within this project, including the hierarchy (i.e.: all plugins for which hasEffectivePlugin(Coordinate) returns true;
List<MavenPlugin>	listConfiguredEffectivePlugins(Profile profile) Return an immutable list of all MavenPlugin contained within this project, including the hierarchy (i.e.: all plugins for which hasEffectivePlugin(Coordinate) returns true;
List<MavenPlugin>	listConfiguredManagedPlugins() Return an immutable list of all direct managed MavenPlugin contained within this project.
List<MavenPlugin>	listConfiguredManagedPlugins(Profile profile) Return an immutable list of all direct managed MavenPlugin contained within this project.
List<MavenPlugin>	listConfiguredPlugins() Return an immutable list of all direct MavenPlugin contained within this project.
List<MavenPlugin>	listConfiguredPlugins(Profile profile) Return an immutable list of all direct MavenPlugin contained within this project.
MavenPlugin	merge(MavenPlugin dominant, MavenPlugin recessive) Merge two plugins, with one having dominance in the case of collision.
void	removeManagedPlugin(Coordinate coordinate) Remove the given managed plugin given it's Coordinate from this Project.
void	removeManagedPlugin(Coordinate coordinate, Profile profile) Remove the given managed plugin given it's Coordinate from this Project.
void	removePlugin(Coordinate coordinate) Remove the plugin given it's Coordinate from this Project.
void	removePlugin(Coordinate coordinate, Profile profile) Remove the plugin given it's Coordinate from this Project.
DependencyRepository	removePluginRepository(String url) Remove the given org.jboss.forge.project.dependencies.DependencyRepository from the current project.
DependencyRepository	removePluginRepository(String url, Profile profile) Remove the given org.jboss.forge.project.dependencies.DependencyRepository from the current project.
void	updateManagedPlugin(MavenPlugin plugin) Update the given managed MavenPlugin to this Project's immediate list of managed plugins.
void	updateManagedPlugin(MavenPlugin plugin, Profile profile) Update the given managed MavenPlugin to this Project's immediate list of managed plugins.
void	updatePlugin(MavenPlugin plugin) Update the given MavenPlugin to this Project's immediate list of plugins.
void	updatePlugin(MavenPlugin plugin, Profile profile) Update the given MavenPlugin to this Project's immediate list of plugins.

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

getFaceted, install, isInstalled, uninstall

Method Detail

addPlugin

void addPlugin(MavenPlugin plugin)

Add the given MavenPlugin to this Project's immediate list of plugins. This method does not check for existence of plugins in the hierarchy, instead, directly adds or replaces a direct plugin.

See also: MavenPluginBuilder.

addPlugin

void addPlugin(MavenPlugin plugin,
               Profile profile)

Add the given MavenPlugin to this Project's list of plugins under the specified profile. This method does not check for existence of plugins in the hierarchy, instead, directly adds or replaces a direct plugin.

If the profileId doesn't exist, a new will be created, otherwise it will be reused.

See also: MavenPluginBuilder.

addManagedPlugin

void addManagedPlugin(MavenPlugin plugin)

Add the given managed MavenPlugin to this Project's immediate list of managed plugins. This method does not check for existence of managed plugins in the hierarchy, instead, directly adds or replaces a direct managed plugin.

See also: MavenPluginBuilder.

addManagedPlugin

void addManagedPlugin(MavenPlugin plugin,
                      Profile profile)

Add the given managed MavenPlugin to this Project's list of managed plugins under the specified profile. This method does not check for existence of managed plugins in the hierarchy, instead, directly adds or replaces a direct managed plugin.

See also: MavenPluginBuilder.

getPlugin

MavenPlugin getPlugin(Coordinate coordinate)

Attempt to locate a plugin given it's Coordinate, if it exists in the Project direct dependency list, and return it.

See also: MavenPluginBuilder. See also: #hasPlugin(Plugin).

Notice: This method checks only the immediate project plugins, meaning that if a dependency is declared somewhere else in the hierarchy, it will not be detected by this method.

getPlugin

MavenPlugin getPlugin(Coordinate coordinate,
                      Profile profile)

Attempt to locate a plugin given it's Coordinate, if it exists in the Project direct dependency list, and return it.

See also: MavenPluginBuilder. See also: #hasPlugin(Plugin).

Notice: This method checks only the immediate project plugins, meaning that if a dependency is declared somewhere else in the hierarchy, it will not be detected by this method.

getEffectivePlugin

MavenPlugin getEffectivePlugin(Coordinate coordinate)

Attempt to locate a plugin given it's Coordinate, if it exists anywhere in the Project plugin hierarchy, and return it.

See also: MavenPluginBuilder. See also: hasEffectivePlugin(Coordinate).

Returns:

getEffectivePlugin

MavenPlugin getEffectivePlugin(Coordinate coordinate,
                               Profile profile)

Attempt to locate a plugin given it's Coordinate, if it exists anywhere in the Project plugin hierarchy, and return it.

See also: MavenPluginBuilder. See also: hasEffectivePlugin(Coordinate).

Returns:

getManagedPlugin

MavenPlugin getManagedPlugin(Coordinate coordinate)

Attempt to locate a managed a plugin given it's Coordinate, if it exists in the Project, and return it.

See also: MavenPluginBuilder. See also: hasManagedPlugin(Coordinate).

Returns:

getManagedPlugin

MavenPlugin getManagedPlugin(Coordinate coordinate,
                             Profile profile)

Attempt to locate a managed a plugin given it's Coordinate, if it exists in the Project, and return it.

See also: MavenPluginBuilder. See also: hasManagedPlugin(Coordinate).

Returns:

getEffectiveManagedPlugin

MavenPlugin getEffectiveManagedPlugin(Coordinate coordinate)

Searches Project and returns a managed plugin matching the given Coordinate at any level of the project hierarchy; return null otherwise.

See also: MavenPluginBuilder.

getEffectiveManagedPlugin

MavenPlugin getEffectiveManagedPlugin(Coordinate coordinate,
                                      Profile profile)

Searches Project and returns a managed plugin matching the given Coordinate at any level of the project hierarchy; return null otherwise.

See also: MavenPluginBuilder.

listConfiguredPlugins

List<MavenPlugin> listConfiguredPlugins()

Return an immutable list of all direct MavenPlugin contained within this project. (i.e.: all plugins for which hasPlugin(Coordinate) returns true;

listConfiguredPlugins

List<MavenPlugin> listConfiguredPlugins(Profile profile)

Return an immutable list of all direct MavenPlugin contained within this project. (i.e.: all plugins for which hasPlugin(Coordinate) returns true;

listConfiguredEffectivePlugins

List<MavenPlugin> listConfiguredEffectivePlugins()

Return an immutable list of all MavenPlugin contained within this project, including the hierarchy (i.e.: all plugins for which hasEffectivePlugin(Coordinate) returns true;

listConfiguredEffectivePlugins

List<MavenPlugin> listConfiguredEffectivePlugins(Profile profile)

Return an immutable list of all MavenPlugin contained within this project, including the hierarchy (i.e.: all plugins for which hasEffectivePlugin(Coordinate) returns true;

listConfiguredManagedPlugins

List<MavenPlugin> listConfiguredManagedPlugins()

Return an immutable list of all direct managed MavenPlugin contained within this project. (i.e.: all managed plugins for which hasManagedPlugin(Coordinate) returns true;

listConfiguredManagedPlugins

List<MavenPlugin> listConfiguredManagedPlugins(Profile profile)

Return an immutable list of all direct managed MavenPlugin contained within this project. (i.e.: all managed plugins for which hasManagedPlugin(Coordinate) returns true;

listConfiguredEffectiveManagedPlugins

List<MavenPlugin> listConfiguredEffectiveManagedPlugins()

Return an immutable list of all managed MavenPlugin contained within this project, including the hierarchy. (i.e.: all managed plugins for which hasEffectiveManagedPlugin(Coordinate) returns true;

listConfiguredEffectiveManagedPlugins

List<MavenPlugin> listConfiguredEffectiveManagedPlugins(Profile profile)

Return an immutable list of all managed MavenPlugin contained within this project, including the hierarchy. (i.e.: all managed plugins for which hasEffectiveManagedPlugin(Coordinate) returns true;

hasPlugin

boolean hasPlugin(Coordinate coordinate)

Return true if this Project contains a plugin matching the given Coordinate; return false otherwise.

See also: MavenPluginBuilder.

Notice: This method checks only the immediate project plugins, meaning that if a plugin is declared somewhere else in the hierarchy, it will not be detected by this method, even though hasEffectivePlugin(Coordinate) may return true.

hasPlugin

boolean hasPlugin(Coordinate coordinate,
                  Profile profile)

Return true if this Project contains a plugin matching the given Coordinate; return false otherwise.

See also: MavenPluginBuilder.

Notice: This method checks only the immediate project plugins, meaning that if a plugin is declared somewhere else in the hierarchy, it will not be detected by this method, even though hasEffectivePlugin(Coordinate) may return true.

hasEffectivePlugin

boolean hasEffectivePlugin(Coordinate coordinate)

Return true if the given Coordinate exists anywhere in the project dependency hierarchy. See also: MavenPluginBuilder. See also: getEffectivePlugin(Coordinate).

hasEffectivePlugin

boolean hasEffectivePlugin(Coordinate coordinate,
                           Profile profile)

Return true if the given Coordinate exists anywhere in the project dependency hierarchy. See also: MavenPluginBuilder. See also: getEffectivePlugin(Coordinate).

hasManagedPlugin

boolean hasManagedPlugin(Coordinate coordinate)

Return true if this Project contains a managed plugin matching the given Coordinate; return false otherwise.

See also: MavenPluginBuilder.

Notice: This method checks only the immediate project managed plugins, meaning that if a managed plugin is declared somewhere else in the hierarchy, it will not be detected by this method, even though hasEffectiveManagedPlugin(Coordinate) may return true.

hasManagedPlugin

boolean hasManagedPlugin(Coordinate coordinate,
                         Profile profile)

Return true if this Project contains a managed plugin matching the given Coordinate; return false otherwise.

See also: MavenPluginBuilder.

Notice: This method checks only the immediate project managed plugins, meaning that if a managed plugin is declared somewhere else in the hierarchy, it will not be detected by this method, even though hasEffectiveManagedPlugin(Coordinate) may return true.

hasEffectiveManagedPlugin

boolean hasEffectiveManagedPlugin(Coordinate coordinate)

Return true if this Project contains a managed plugin matching the given Coordinate at any level of the project hierarchy; return false otherwise.

See also: MavenPluginBuilder.

hasEffectiveManagedPlugin

boolean hasEffectiveManagedPlugin(Coordinate coordinate,
                                  Profile profile)

Return true if this Project contains a managed plugin matching the given Coordinate at any level of the project hierarchy; return false otherwise.

See also: MavenPluginBuilder.

removePlugin

void removePlugin(Coordinate coordinate)

Remove the plugin given it's Coordinate from this Project.

See also: MavenPluginBuilder.

Notice: This method operates only the immediate project dependencies, meaning that if a plugin is declared somewhere else in the hierarchy, it will not be removable by this method. You should call hasPlugin(Coordinate) first in order to check if the plugin exists in this projects immediate plugins list.

removePlugin

void removePlugin(Coordinate coordinate,
                  Profile profile)

Remove the plugin given it's Coordinate from this Project.

See also: MavenPluginBuilder.

Notice: This method operates only the immediate project dependencies, meaning that if a plugin is declared somewhere else in the hierarchy, it will not be removable by this method. You should call hasPlugin(Coordinate) first in order to check if the plugin exists in this projects immediate plugins list.

removeManagedPlugin

void removeManagedPlugin(Coordinate coordinate)

Remove the given managed plugin given it's Coordinate from this Project.

See also: MavenPluginBuilder.

Notice: This method operates only the immediate project managed plugins, meaning that if a managed plugin is declared somewhere else in the hierarchy, it will not be removable by this method. You should call hasManagedPlugin(Coordinate) first in order to check if the managed plugin exists in this projects immediate managed plugins.

removeManagedPlugin

void removeManagedPlugin(Coordinate coordinate,
                         Profile profile)

Remove the given managed plugin given it's Coordinate from this Project.

See also: MavenPluginBuilder.

Notice: This method operates only the immediate project managed plugins, meaning that if a managed plugin is declared somewhere else in the hierarchy, it will not be removable by this method. You should call hasManagedPlugin(Coordinate) first in order to check if the managed plugin exists in this projects immediate managed plugins.

updatePlugin

void updatePlugin(MavenPlugin plugin)

Update the given MavenPlugin to this Project's immediate list of plugins. This method does not check for existence of plugins in the hierarchy, instead, directly updates a direct plugin.

See also: MavenPluginBuilder.

updatePlugin

void updatePlugin(MavenPlugin plugin,
                  Profile profile)

Update the given MavenPlugin to this Project's immediate list of plugins. This method does not check for existence of plugins in the hierarchy, instead, directly updates a direct plugin.

See also: MavenPluginBuilder.

updateManagedPlugin

void updateManagedPlugin(MavenPlugin plugin)

Update the given managed MavenPlugin to this Project's immediate list of managed plugins. This method first calls #hasEffectiveManagedPlugin(MavenPlugin) before making changes to the managed plugin list.

See also: MavenPluginBuilder.

updateManagedPlugin

void updateManagedPlugin(MavenPlugin plugin,
                         Profile profile)

Update the given managed MavenPlugin to this Project's immediate list of managed plugins. This method first calls #hasEffectiveManagedPlugin(MavenPlugin) before making changes to the managed plugin list.

See also: MavenPluginBuilder.

addPluginRepository

void addPluginRepository(String name,
                         String url)

Add a repository to the project build system. This is where dependencies can be found, downloaded, and installed to the project build script.

hasPluginRepository

boolean hasPluginRepository(String url)

Return true if the given repository URL is already registered in this project's build system.

removePluginRepository

DependencyRepository removePluginRepository(String url)

Remove the given org.jboss.forge.project.dependencies.DependencyRepository from the current project. Return true if the repository was removed; return false otherwise. Return the removed repository, or null if no repository was removed.

getPluginRepositories

List<DependencyRepository> getPluginRepositories()

Get the list of plugin repositories for which this project is currently configured to use in dependency resolution.

addPluginRepository

void addPluginRepository(String name,
                         String url,
                         Profile profile)

Add a repository to the project build system. This is where dependencies can be found, downloaded, and installed to the project build script.

hasPluginRepository

boolean hasPluginRepository(String url,
                            Profile profile)

Return true if the given repository URL is already registered in this project's build system.

removePluginRepository

DependencyRepository removePluginRepository(String url,
                                            Profile profile)

Remove the given org.jboss.forge.project.dependencies.DependencyRepository from the current project. Return true if the repository was removed; return false otherwise. Return the removed repository, or null if no repository was removed.

getPluginRepositories

List<DependencyRepository> getPluginRepositories(Profile profile)

Get the list of plugin repositories for which this project is currently configured to use in dependency resolution.

merge

MavenPlugin merge(MavenPlugin dominant,
                  MavenPlugin recessive)

Merge two plugins, with one having dominance in the case of collision.

Notice: To be merged, the two plugins dependencies must be equivalent (see Dependencies.areEquivalent(Coordinate, Coordinate))