Package ffx.utilities

Class FFXCommand

java.lang.Object
ffx.utilities.FFXCommand
Direct Known Subclasses:
AlgorithmsCommand, PotentialCommand
public abstract class FFXCommand extends Object
Base FFX Command class.
Author:
Michael J. Schnieders

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    String[]
    args
    The array of args passed into the Script.
    FFXBinding
    binding
    The Binding that provides variables to this Command.
    final picocli.CommandLine.Help.Ansi
    color
    Unix shells are able to evaluate PicoCLI ANSI color codes, but right now the FFX GUI Shell does not.
    boolean
    help
    -h or --help Prints a help message.
    static final Logger
    logger
    The logger for this class.
    picocli.CommandLine.ParseResult
    parseResult
    Parse Result.
    boolean
    version
    -V or --version Prints the FFX version and exits.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FFXCommand()
    Default constructor for an FFX Command.
    FFXCommand(FFXBinding binding)
    Default constructor for an FFX Command.
    FFXCommand(String[] args)
    Create an FFX Command using the supplied command line arguments.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Class<? extends FFXCommand>
    getCommand(String name)
    Use the System ClassLoader to find the requested Command.
    String
    helpString()
    Default help information.
    boolean
    init()
    Initialize this Command based on the specified command line arguments.
    static void
    listCommands(boolean logCommands, boolean logTestCommands)
    List the embedded FFX Commands.
    FFXCommand
    run()
    Execute this Command.
    void
    setBinding(FFXBinding binding)
    Set the Binding that provides variables to this Command.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • logger

      public static final Logger logger
      The logger for this class.

    • color

      public final picocli.CommandLine.Help.Ansi color
      Unix shells are able to evaluate PicoCLI ANSI color codes, but right now the FFX GUI Shell does not.

      In a headless environment, color will be ON for command line help, but OFF for the GUI.

    • args

      public String[] args
      The array of args passed into the Script.

    • parseResult

      public picocli.CommandLine.ParseResult parseResult
      Parse Result.

    • version

      public boolean version
      -V or --version Prints the FFX version and exits.

    • help

      public boolean help
      -h or --help Prints a help message.

    • binding

      public FFXBinding binding
      The Binding that provides variables to this Command.

  • Constructor Details

    • FFXCommand

      public FFXCommand()
      Default constructor for an FFX Command.

    • FFXCommand

      public FFXCommand(String[] args)
      Create an FFX Command using the supplied command line arguments.
      Parameters:
      args - The command line arguments.

    • FFXCommand

      public FFXCommand(FFXBinding binding)
      Default constructor for an FFX Command.
      Parameters:
      binding - the Binding that provides variables to this Command.

  • Method Details

    • setBinding

      public void setBinding(FFXBinding binding)
      Set the Binding that provides variables to this Command.
      Parameters:
      binding - The Binding to use.

    • getCommand

      public static Class<? extends FFXCommand> getCommand(String name)
      Use the System ClassLoader to find the requested Command.
      Parameters:
      name - Name of the Command to load (e.g., Energy).
      Returns:
      The Command, if found, or null.

    • listCommands

      public static void listCommands(boolean logCommands, boolean logTestCommands)
      List the embedded FFX Commands.
      Parameters:
      logCommands - List Commands.
      logTestCommands - List Test Commands.

    • helpString

      public String helpString()
      Default help information.
      Returns:
      String describing how to use this command.

    • init

      public boolean init()
      Initialize this Command based on the specified command line arguments.
      Returns:
      boolean Returns true if the script should continue and false to exit.

    • run

      public FFXCommand run()
      Execute this Command.
      Returns:
      The current FFXCommand.