randoop.main

Class CommandHandler

java.lang.Object

randoop.main.CommandHandler

Direct Known Subclasses:

GenInputsAbstract, Help, Minimize

public abstract class CommandHandler
extends java.lang.Object

A command is the first argument given to Randoop. A command handler handles one command. It also takes care of printing the command's documentation.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	fcommand
java.lang.String	fcommandGrammar
java.lang.String	fexample
java.lang.String	finput
java.util.List<java.lang.String>	fnotes
org.plumelib.options.Options	foptions
java.lang.String	foutput
java.lang.String	fpitch
java.lang.String	fsummary
java.lang.String	fwhere

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandHandler(java.lang.String command, java.lang.String pitch, java.lang.String commandGrammar, java.lang.String where, java.lang.String summary, java.util.List<java.lang.String> notes, java.lang.String input, java.lang.String output, java.lang.String example, org.plumelib.options.Options options) No arguments should be null.

Method Summary

Modifier and Type	Method and Description
abstract boolean	handle(java.lang.String[] args)
boolean	handles(java.lang.String command) Returns true if this CommandHandler handles the given command.
void	printHTML(java.io.PrintStream out) Prints out formatted text in (google code) Wiki format.
void	usageMessage(java.io.PrintStream out)

Methods inherited from class java.lang.Object

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

Field Detail

fcommand

public java.lang.String fcommand

fpitch

public java.lang.String fpitch

fcommandGrammar

public java.lang.String fcommandGrammar

fwhere

public java.lang.String fwhere

fsummary

public java.lang.String fsummary

fnotes

public java.util.List<java.lang.String> fnotes

finput

public java.lang.String finput

foutput

public java.lang.String foutput

fexample

public java.lang.String fexample

foptions

public org.plumelib.options.Options foptions

Constructor Detail

CommandHandler

protected CommandHandler(java.lang.String command,
                         java.lang.String pitch,
                         java.lang.String commandGrammar,
                         java.lang.String where,
                         java.lang.String summary,
                         java.util.List<java.lang.String> notes,
                         java.lang.String input,
                         java.lang.String output,
                         java.lang.String example,
                         org.plumelib.options.Options options)

No arguments should be null.

Parameters:

command - the name of the command

pitch - the description of the command

commandGrammar - the usage of the command

where - the where

summary - the summary of the command

notes - the notes for the command

input - the input

output - the output

example - the usage example

options - the command line arguments

Method Detail

handles

public final boolean handles(java.lang.String command)

Returns true if this CommandHandler handles the given command.

Parameters:

command - a command

Returns:

true if this CommandHandler handles the given command

handle

public abstract boolean handle(java.lang.String[] args)

printHTML

public final void printHTML(java.io.PrintStream out)

Prints out formatted text in (google code) Wiki format.

Parameters:

out - the output stream for printing html formatted usage

usageMessage

public final void usageMessage(java.io.PrintStream out)