org.terrier.applications

Class CLITool.HelpAliasCLITool

java.lang.Object

org.terrier.applications.CLITool

org.terrier.applications.CLITool.CLIParsedCLITool

org.terrier.applications.CLITool.HelpAliasCLITool

Enclosing class:

CLITool

public static class CLITool.HelpAliasCLITool
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 and Description
HelpAliasCLITool()

Method Summary

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

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

getIndexRef, getOptions, run

Methods inherited from class org.terrier.applications.CLITool

main, run, run, setConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpAliasCLITool

public HelpAliasCLITool()

Method Detail

run

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

Specified by:

run in class CLITool.CLIParsedCLITool

commandname

public String commandname()

Description copied from class: CLITool

What commandname should this command respond to

Overrides:

commandname in class CLITool

help

public 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 String helpsummary()

Description copied from class: CLITool

Returns a short sentence about what this command is for

Overrides:

helpsummary in class CLITool

sourcepackage

public String sourcepackage()

Overrides:

sourcepackage in class CLITool

commandaliases

public Set<String> commandaliases()

Description copied from class: CLITool

What short commands aliases should this command respond to

Overrides:

commandaliases in class CLITool

displayCommandAndAliases

protected void displayCommandAndAliases(Iterable<CLITool> commandIter)