Package org.terrier.applications

Class CLITool.HelpCLITool

java.lang.Object

org.terrier.applications.CLITool

org.terrier.applications.CLITool.CLIParsedCLITool

org.terrier.applications.CLITool.HelpCLITool

Enclosing class:

CLITool

public static class CLITool.HelpCLITool
extends CLITool.CLIParsedCLITool

Nested Class Summary

Nested classes/interfaces inherited from class org.terrier.applications.CLITool

CLITool.CLIParsedCLITool, CLITool.HelpAliasCLITool, CLITool.HelpCLITool

Field Summary

Fields inherited from class org.terrier.applications.CLITool

PLATFORM_MODULE, POPULAR_COMMANDS

Constructor Summary

Constructors

Constructor	Description
HelpCLITool()

Method Summary

Modifier and Type	Method	Description
java.lang.String	commandname()	What commandname should this command respond to
protected void	displayCommandSummaries(java.lang.Iterable<CLITool> commandIter)
java.lang.String	help()	Return a long message about how to use this command
java.lang.String	helpsummary()	Returns a short sentence about what this command is for
int	run(org.apache.commons.cli.CommandLine line)
java.lang.String	sourcepackage()

Methods inherited from class org.terrier.applications.CLITool.CLIParsedCLITool

getIndexRef, getOptions, run

Methods inherited from class org.terrier.applications.CLITool

commandaliases, main, run, run, setConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpCLITool

public HelpCLITool()

Method Detail

displayCommandSummaries

protected void displayCommandSummaries(java.lang.Iterable<CLITool> commandIter)

run

public int run(org.apache.commons.cli.CommandLine line)

Specified by:

run in class CLITool.CLIParsedCLITool

commandname

public java.lang.String commandname()

Description copied from class: CLITool

What commandname should this command respond to

Overrides:

commandname in class CLITool

help

public java.lang.String help()

Description copied from class: CLITool

Return a long message about how to use this command

Overrides:

help in class CLITool.CLIParsedCLITool

helpsummary

public java.lang.String helpsummary()

Description copied from class: CLITool

Returns a short sentence about what this command is for

Overrides:

helpsummary in class CLITool

sourcepackage

public java.lang.String sourcepackage()

Overrides:

sourcepackage in class CLITool