org.bladerunnerjs.api.plugin

Class JSAPArgsParsingCommandPlugin

java.lang.Object

org.bladerunnerjs.api.plugin.base.AbstractPlugin

org.bladerunnerjs.api.plugin.base.AbstractCommandPlugin

org.bladerunnerjs.api.plugin.JSAPArgsParsingCommandPlugin

All Implemented Interfaces:

CommandPlugin, Plugin

public abstract class JSAPArgsParsingCommandPlugin
extends AbstractCommandPlugin
implements CommandPlugin

An abstract implementation of CommandPlugin which uses JSAP to parse command arguments and provide helpful error messages. The parser can be configured when @{link configureArgsParser(JSAP) is called. JSAP has a 'fluid' API where methods are chained together to configure a specific parameter. To register a parameter:

 
 argsParser.registerParameter(new UnflaggedOption("my-option").setRequired(true).setHelp("a helpful message about this arg"));
 
 

To set a 'port' flag which is used via the command arguments as either '-port XYZ' or '-p XYZ' use:

  
  argsParser.registerParameter(new FlaggedOption("port").setShortFlag('p').setLongFlag("port").setRequired(false).setHelp("the port number"));
 
 

Command arguments will be automatically parsed and provided when doCommand(JSAPResult) is called. Argument values are accessed by name, for example:

 
 parsedArgs.getString("some-arg");
 parsedArgs.getBoolean("some-arg");
 
 

See Also:

JSAP Manual, JSAP API docs

Constructor Summary

Constructors

Constructor and Description
JSAPArgsParsingCommandPlugin()

Method Summary

Modifier and Type	Method and Description
protected abstract void	configureArgsParser(com.martiansoftware.jsap.JSAP argsParser)
protected abstract int	doCommand(com.martiansoftware.jsap.JSAPResult parsedArgs)
int	doCommand(java.lang.String... args) Runs the command using the provided user arguments.
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	getCommandUsage() Returns a usage message that shows the user an example of how the command parameters are used.

Methods inherited from class org.bladerunnerjs.api.plugin.base.AbstractPlugin

castTo, close, equals, getPluginClass, instanceOf

Methods inherited from class java.lang.Object

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

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

getCommandDescription, getCommandName

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

castTo, close, getPluginClass, instanceOf, setBRJS

Constructor Detail

JSAPArgsParsingCommandPlugin

public JSAPArgsParsingCommandPlugin()

Method Detail

configureArgsParser

protected abstract void configureArgsParser(com.martiansoftware.jsap.JSAP argsParser)
                                     throws com.martiansoftware.jsap.JSAPException

Throws:

com.martiansoftware.jsap.JSAPException

doCommand

protected abstract int doCommand(com.martiansoftware.jsap.JSAPResult parsedArgs)
                          throws CommandArgumentsException,
                                 CommandOperationException

Throws:

CommandArgumentsException

CommandOperationException

getCommandUsage

public final java.lang.String getCommandUsage()

Description copied from interface: CommandPlugin

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.

Specified by:

getCommandUsage in interface CommandPlugin

Returns:

A string detailing the usage of the command

getCommandHelp

public java.lang.String getCommandHelp()

Description copied from interface: CommandPlugin

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.

Specified by:

getCommandHelp in interface CommandPlugin

Returns:

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

doCommand

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

Description copied from interface: CommandPlugin

Runs the command using the provided user arguments.

Specified by:

doCommand in interface CommandPlugin

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.