|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CommandProvider
The provider of CVS commands. The implementation of this interface knows how to create a CVS command from an array of arguments.
Method Summary | |
---|---|
Command |
createCommand(java.lang.String[] args,
int index,
GlobalOptions gopt,
java.lang.String workDir)
Create the CVS command from an array of arguments. |
java.lang.String |
getName()
Get the name of this command. |
java.lang.String[] |
getSynonyms()
Get the list of synonyms of names of this command. |
java.lang.String |
getUsage()
Get a short string describibg the usage of the command. |
void |
printLongDescription(java.io.PrintStream out)
Print a long help description (multi-line with all supported switches and their description) of this command to the provided print stream. |
void |
printShortDescription(java.io.PrintStream out)
Print a short help description (one-line only) for this command to the provided print stream. |
Method Detail |
---|
java.lang.String getName()
java.lang.String[] getSynonyms()
Command createCommand(java.lang.String[] args, int index, GlobalOptions gopt, java.lang.String workDir)
args
- The array of arguments passed to the command.index
- The index in the array where the command's arguments start.workDir
- The working directory.
Command
class, which have set the passed arguments.java.lang.String getUsage()
void printShortDescription(java.io.PrintStream out)
out
- The print stream.void printLongDescription(java.io.PrintStream out)
out
- The print stream.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |