Package ffx.utilities

Class FFXCommand

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    String[]
    args
    The array of args passed into the Script.
    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(FFXContext ffxContext)
    Default constructor for an FFX Script.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Class<? extends FFXCommand>
    getCommand(String name)
    Use the System ClassLoader to find the requested command.
    FFXContext
    getFfxContext()
    Obtain the Context for this command.
    String
    helpString()
    Default help information.
    boolean
    init()
    Initialize this Script based on the specified command line arguments.
    static void
    listCommands(boolean logCommands, boolean logTestCommands)
    List the embedded FFX Groovy Scripts.
    FFXCommand
    run()
    Execute the 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.

  • Constructor Details

    • FFXCommand

      public FFXCommand(FFXContext ffxContext)
      Default constructor for an FFX Script.
      Parameters:
      ffxContext - a FFXContext object

  • Method Details

    • getFfxContext

      public FFXContext getFfxContext()
      Obtain the Context for this command.
      Returns:
      The FFXContext.

    • getCommand

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

    • listCommands

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

    • helpString

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

    • init

      public boolean init()
      Initialize this Script 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 the command.
      Returns:
      a FFXCommand object