org.jboss.forge.shell.command
Interface PluginRegistry

public interface PluginRegistry

Contains the collection of all installed and available plugins.

Author:

Lincoln Baxter, III

Method Summary

void	addPlugin(PluginMetadata plugin) Add a plugin to the registry.
List<PluginMetadata>	getPluginMetadata(String plugin) Get the PluginMetadata for the given plugin name.
PluginMetadata	getPluginMetadataForScopeAndConstraints(String name, Shell shell) Resolves a single PluginMetadata instance representing the singular type that is in scope, and satisfied by the current project constraints such as RequiresProject or RequiresFacet
Map<String,List<PluginMetadata>>	getPlugins() Get a map of all known plugin names and metadata.
Plugin	instanceOf(PluginMetadata meta) Get the Plugin instance defined by the given PluginMetadata

Method Detail

addPlugin

void addPlugin(PluginMetadata plugin)

Add a plugin to the registry. Typically this will only be used by Forge itself.

getPluginMetadata

List<PluginMetadata> getPluginMetadata(String plugin)

Get the PluginMetadata for the given plugin name. Returns an empty list if no plugins exist for the given name.

getPluginMetadataForScopeAndConstraints

PluginMetadata getPluginMetadataForScopeAndConstraints(String name,
                                                       Shell shell)

Resolves a single PluginMetadata instance representing the singular type that is in scope, and satisfied by the current project constraints such as RequiresProject or RequiresFacet

getPlugins

Map<String,List<PluginMetadata>> getPlugins()

Get a map of all known plugin names and metadata.

instanceOf

Plugin instanceOf(PluginMetadata meta)

Get the Plugin instance defined by the given PluginMetadata