com.threecrickets.sincerity.plugin

Class ContainerPlugin

java.lang.Object

com.threecrickets.sincerity.plugin.ContainerPlugin

All Implemented Interfaces:

Plugin1

public class ContainerPlugin
extends Object
implements Plugin1

The container plugin supports the following commands:

• create: creates a new container. The first argument is required, and is the container root path. The second optional argument is the template to use. It defaults to "default". If the directory already exists, the command will fail, unless the --force switch is used, in which case the template will be force-copied into the directory (which may result in files being overriden). Note that this command will cause Sincerity to reboot if successful.
• use: switches to an existing container. The required argument is the container root path. Note that this command will cause Sincerity to reboot if successful.
• clone: similar to "create", except that the current container will be used as the template for the new container. The --force switch is also supported. Note that this command will cause Sincerity to reboot if successful.
• clean: uninstalls all dependencies and deletes this container's "/cache/" directory. Also see "dependencies:uninstall".

Additionally, this plugin adds a "Create" button to the GUI.

Author:

Tal Liron

See Also:

Container, CreateContainerButton

Constructor Summary

Constructors

Constructor and Description
ContainerPlugin()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContainerPlugin

public ContainerPlugin()

Method Detail

getInterfaceVersion

public int getInterfaceVersion()

Description copied from interface: Plugin1

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

Specified by:

getInterfaceVersion in interface Plugin1

Returns:

The interface version number

getName

public String getName()

Description copied from interface: Plugin1

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

Specified by:

getName in interface Plugin1

Returns:

The plugin name

getCommands

public String[] getCommands()

Description copied from interface: Plugin1

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.

Specified by:

getCommands in interface Plugin1

Returns:

An array of command names

run

public void run(Command command)
         throws SincerityException

Description copied from interface: Plugin1

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.

Specified by:

run in interface Plugin1

Parameters:

command - The command to run

Throws:

SincerityException - In case of an error

gui

public void gui(Command command)
         throws SincerityException

Description copied from interface: Plugin1

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.

Specified by:

gui in interface Plugin1

Parameters:

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

Throws:

SincerityException - In case of an error