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:

  • Constructor Details

    • CompleteCli

      public CompleteCli()

  • Method Details

    • 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.

    • getShortDesc

      public String getShortDesc()
      Description copied from interface: CLI
      Obtain a short description for this command explaining what it does.
      Specified by:
      getShortDesc in interface CLI
      Overrides:
      getShortDesc in class AbstractCLI

    • 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

    • 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.

    • doAuthenticatedWork

      protected void doAuthenticatedWork() throws Exception
      Specified by:
      doAuthenticatedWork in class AbstractAuthenticatedCLI
      Throws:
      Exception