org.bladerunnerjs.api.plugin

Interface CommandPlugin

All Superinterfaces:

Plugin

All Known Implementing Classes:

AbstractCommandPlugin, JSAPArgsParsingCommandPlugin

public interface CommandPlugin
extends Plugin

Command plug-ins allow new commands to be made available to users of BladeRunnerJS.

The main advantage to creating a command plug-in rather than providing an external command or script is that command plug-ins get access to the BladeRunnerJS model. Commands can be invoked by users using the 'brjs' command, or can be invoked programmatically using the BRJS.runCommand(java.lang.String...) method. A JSAPArgsParsingCommandPlugin class is available for developers that would like help parsing the command parameters for their command.

The following methods are identifier-methods, and may be invoked before Plugin.setBRJS() has been invoked:

• getCommandName()

Method Summary

Modifier and Type	Method and Description
int	doCommand(java.lang.String... args) Runs the command using the provided user arguments.
java.lang.String	getCommandDescription() Returns a description message that helps users to determine whether a command may be of interest to them or not.
java.lang.String	getCommandHelp() Returns a detailed help message that describes the various parameters the command provides, and how they are used.
java.lang.String	getCommandName() Returns the name of the command.
java.lang.String	getCommandUsage() Returns a usage message that shows the user an example of how the command parameters are used.

Methods inherited from interface org.bladerunnerjs.api.plugin.Plugin

castTo, close, getPluginClass, instanceOf, setBRJS

Method Detail

getCommandName

java.lang.String getCommandName()

Returns the name of the command.

Note: Developers should not rely on any class initialization performed within Plugin.setBRJS() as this method is an identifier-method which may be invoked before Plugin.setBRJS() has itself been invoked.

Returns:

The name of the command

getCommandDescription

java.lang.String getCommandDescription()

Returns a description message that helps users to determine whether a command may be of interest to them or not.

Returns:

The command description

getCommandUsage

java.lang.String getCommandUsage()

Returns a usage message that shows the user an example of how the command parameters are used.

Note: This method doesn't need to be implemented if you've chosen to extend JSAPArgsParsingCommandPlugin.

Returns:

A string detailing the usage of the command

getCommandHelp

java.lang.String getCommandHelp()

Returns a detailed help message that describes the various parameters the command provides, and how they are used.

Note: This method doesn't need to be implemented if you've chosen to extend JSAPArgsParsingCommandPlugin.

Returns:

A help message to be displayed if the command is used incorrectly

doCommand

int doCommand(java.lang.String... args)
       throws CommandArgumentsException,
              CommandOperationException

Runs the command using the provided user arguments.

Parameters:

args - The list of arguments provided by the user.

Returns:

The exit code. 0 on success, non 0 otherwise. Typically commands will return 1 on failure unless they have multiple exit paths. The exit code is not a replacement for exceptions, exceptions should still be thrown if arguments are invalid or an unexpected exception occurs during the execution of the command.

Throws:

CommandArgumentsException - if any invalid arguments were provided.

CommandOperationException - if a problem was encountered while running the command.