Package org.dellroad.jct.core.simple.command

Class HelpCommand

java.lang.Object

org.dellroad.jct.core.simple.AbstractSimpleCommand

org.dellroad.jct.core.simple.command.HelpCommand

All Implemented Interfaces:

SimpleCommand

public class HelpCommand
extends AbstractSimpleCommand

A simple "help" command that can be used with a console component extending SimpleCommandSupport.

Constructor Summary

Constructors

Constructor	Description
HelpCommand()

Method Summary

Modifier and Type	Method	Description
int	execute(ConsoleSession<?,?> session, String name, List<String> args)	Execute this command in the current thread and return success or failure.
static void	listCommands(PrintStream out, Collection<? extends CommandBundle> bundles)	Pretty-print command names and descriptions.

Methods inherited from class org.dellroad.jct.core.simple.AbstractSimpleCommand

getHelpDetail, getHelpSummary, getUsage, printUsage

Methods inherited from class java.lang.Object

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

Constructor Details

HelpCommand

public HelpCommand()

Method Details

listCommands

public static void listCommands(PrintStream out,
 Collection<? extends CommandBundle> bundles)

Pretty-print command names and descriptions.

Parameters:

out - where to print

bundles - command bundles

Throws:

IllegalArgumentException - if any parameter is null

execute

public int execute(ConsoleSession<?,?> session,
 String name,
 List<String> args)
            throws InterruptedException

Description copied from interface: SimpleCommand

Execute this command in the current thread and return success or failure.

In the failure case, some error information should be written to standard error.

Parameters:

session - associated session

name - the name under which this command was invoked

args - zero or more command arguments (does not include command name)

Returns:

zero if successful, non-zero error code if an error occurred

Throws:

InterruptedException - if execution is interrupted