Package org.phyloref.jphyloref.commands

Interface Command

All Known Implementing Classes:
ResolveCommand, TestCommand, WebserverCommand
public interface Command
Commands provide commands for jphyloref to run. These are usually in the form 'jphyloref command ...'
Author:
Gaurav Vaidya

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addCommandLineOptions​(org.apache.commons.cli.Options opts)
    A list of valid command line options.
    int
    execute​(org.apache.commons.cli.CommandLine cmdLine)
    Execute this command with the provided command line options, and provide an exit value to return to the operating system.
    String
    getDescription()
    A one-line description of this command.
    String
    getName()
    The name of this command.

  • Method Details

    • getName

      String getName()
      The name of this command. The command is usually invoked as "jphyloref command ...".
      Returns:
      The name of this command.

    • getDescription

      String getDescription()
      A one-line description of this command.
      Returns:
      A one-line description of this command as a String.

    • addCommandLineOptions

      void addCommandLineOptions​(org.apache.commons.cli.Options opts)
      A list of valid command line options. These should be added to the provided Options object.

    • execute

      int execute​(org.apache.commons.cli.CommandLine cmdLine)
      Execute this command with the provided command line options, and provide an exit value to return to the operating system.
      Parameters:
      cmdLine - The CommandLine to be executed.