com.threecrickets.sincerity

Interface Plugin1

All Known Implementing Classes:

ArtifactsPlugin, ContainerPlugin, DelegatedPlugin, DelegatePlugin, DependenciesPlugin, HelpPlugin, JavaPlugin, PackagesPlugin, RepositoriesPlugin, ShellPlugin, ShortcutsPlugin, TemplatesPlugin

public interface Plugin1

Sincerity plugins handle the running of Sincerity commands (see Command).

In order to allow for future upgrades to the plugin interface, while still allowing support for older plugin implementation, this interface has a version suffix.

This is version 1 of the plugin interface.

Note that although this is a Java language interface, a robust mechanism is in place to allow you to delegate the interface to non-Java languages running in the JVM, using the Scripturian library. See DelegatedPlugin for more information.

Author:

Tal Liron

See Also:

Plugins

Method Summary

Modifier and Type	Method and Description
String[]	getCommands() The command names supported by this plugin.
int	getInterfaceVersion() The version of the Sincerity plugin interface supported by this plugin.
String	getName() The name of this plugin.
void	gui(Command command) Called by the ShellPlugin to allow this plugin to activate its own extension to the GUI.
void	run(Command command) Runs a command.

Method Detail

getInterfaceVersion

int getInterfaceVersion()
                 throws SincerityException

The version of the Sincerity plugin interface supported by this plugin.

Returns:

The interface version number

Throws:

SincerityException - In case of an error

getName

String getName()
        throws SincerityException

The name of this plugin. Plugin names are expected to be unique per container.

Returns:

The plugin name

Throws:

SincerityException - In case of an error

getCommands

String[] getCommands()
              throws SincerityException

The command names supported by this plugin. Command names do not have to be unique per container, but unique names do make work easier for users.

Returns:

An array of command names

Throws:

SincerityException - In case of an error

run

void run(Command command)
  throws SincerityException

Runs a command.

If the command is not supported by this plugin, should throw a UnknownCommandException. If the command does not have the arguments it needs in order to run, should throw a BadArgumentsCommandException. Other command-specific failures should throw a CommandException.

Parameters:

command - The command to run

Throws:

SincerityException - In case of an error

gui

void gui(Command command)
  throws SincerityException

Called by the ShellPlugin to allow this plugin to activate its own extension to the GUI. This is an optional operation.

The Frame can be accessed at Sincerity.getFrame(). Note that when this hook is called, the frame is not yet made visible.

Parameters:

command - The command used to invoke the GUI (likely "shell:gui")

Throws:

SincerityException - In case of an error