org.jboss.forge.shell.plugins
Interface Plugin

public interface Plugin

A custom Plugin must implement this interface in order to be detected and installed at framework boot-time. In order to create plugin shell-commands, one must create a method annotated with @Command. Any command method parameters to be provided as input through the shell must be individually annotated with the @Option annotation; other (non-annotated) command parameters are ignored.

In order to control the name of a custom plugin, the Alias annotation may be added to any Plugin type.

Plugin types may be annotated with any of the following constraints in order to ensure proper dependencies are satisfied at runtime: RequiresFacet, RequiresPackagingType, RequiresResource

Author:

Lincoln Baxter, III