Package ubic.gemma.apps

Class CompleteCli

java.lang.Object

ubic.gemma.cli.util.AbstractCLI

ubic.gemma.cli.util.AbstractAuthenticatedCLI

ubic.gemma.apps.CompleteCli

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.EnvironmentAware, CLI

public class CompleteCli
extends AbstractAuthenticatedCLI

This CLI provide various runtime completions that can be re-used by other CLIs.

Author:

poirigui

See Also:

EnumeratedByCommandConverter

Nested Class Summary

Nested classes/interfaces inherited from interface ubic.gemma.cli.util.CLI

CLI.CommandGroup

Field Summary

Fields inherited from class ubic.gemma.cli.util.AbstractCLI

ABORTED, FAILURE, FAILURE_FROM_ERROR_OBJECTS, log, SUCCESS

Constructor Summary

Constructors

Constructor	Description
CompleteCli()

Method Summary

Modifier and Type	Method	Description
protected void	doAuthenticatedWork()
String	getCommandName()	A short memorable name for the command that can be used to locate this class.
protected String	getUsage()	Describe the intended usage for the command.
protected void	processOptions(org.apache.commons.cli.CommandLine commandLine)	Process command line options.

Methods inherited from class ubic.gemma.cli.util.AbstractAuthenticatedCLI

afterPropertiesSet, createBatchTaskExecutorService, doWork, setEnvironment, setRequireLogin

Methods inherited from class ubic.gemma.cli.util.AbstractCLI

abort, addBatchOption, addErrorObject, addErrorObject, addErrorObject, addSuccessObject, addSuccessObject, addThreadsOption, addWarningObject, addWarningObject, allowPositionalArguments, awaitBatchExecutorService, buildOptions, executeCommand, getApplicationContext, getBatchTaskExecutor, getCliContext, getCommandAliases, getCommandGroup, getHelpFooter, getNumThreads, getOptions, getShortDesc, promptConfirmationOrAbort, setAllowPositionalArguments, setApplicationContext, setEstimatedMaxTasks, setReportFrequencyMillis

Methods inherited from class java.lang.Object

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

Constructor Detail

CompleteCli

public CompleteCli()

Method Detail

processOptions

protected void processOptions(org.apache.commons.cli.CommandLine commandLine)
                       throws org.apache.commons.cli.ParseException

Description copied from class: AbstractCLI

Process command line options.

Implement this to provide processing of options. It is called after AbstractCLI.buildOptions(Options) and right before AbstractCLI.doWork().

Overrides:

processOptions in class AbstractCLI

Throws:

org.apache.commons.cli.ParseException - in case of unrecoverable failure (i.e. missing option or invalid value), an exception can be raised and will result in an exit code of AbstractCLI.FAILURE.

getCommandName

public String getCommandName()

Description copied from interface: CLI

A short memorable name for the command that can be used to locate this class.

Specified by:

getCommandName in interface CLI

Overrides:

getCommandName in class AbstractCLI

Returns:

name; if null or blank, this will not be available as a shortcut command.

getUsage

protected String getUsage()

Description copied from class: AbstractCLI

Describe the intended usage for the command.

This will be included in the 'Usage: ...' error message when the CLI is misused.

Overrides:

getUsage in class AbstractCLI

doAuthenticatedWork

protected void doAuthenticatedWork()
                            throws Exception

Specified by:

doAuthenticatedWork in class AbstractAuthenticatedCLI

Throws:

Exception