Class CommandSpec

java.lang.Object
org.tasktide.core.manager.command.CommandSpec
public class CommandSpec extends Object
Standardize peripheral requirements for ManagerCommand

  • Constructor Details

    • CommandSpec

      public CommandSpec()
      Default constructor for building

    • CommandSpec

      public CommandSpec(String filePath, String queryString, Map<String,Object> options)
      Construct with all args
      Parameters:
      filePath -
      queryString -
      options -

  • Method Details

    • getFilePath

      public Optional<String> getFilePath()
      Get the configured file path for ManagerCommand
      Returns:
      Optional-String

    • setFilePath

      public void setFilePath(Optional<String> filePath)
      Sets file path for ManagerCommand
      Parameters:
      filePath -

    • filePathIsEmpty

      public boolean filePathIsEmpty()
      Returns whether file path is empty
      Returns:
      boolean

    • getQueryString

      public Optional<String> getQueryString()
      Gets query string for ManagerCommand
      Returns:
      Optional-String

    • setQueryString

      public void setQueryString(Optional<String> queryString)
      Sets query string for ManagerCommand
      Parameters:
      queryString -

    • queryStringIsEmpty

      public boolean queryStringIsEmpty()
      Returns whether file path is empty
      Returns:
      boolean

    • getOptions

      public Optional<Map<String,Object>> getOptions()
      Gets options map for ManagerCommand
      Returns:
      Optional-Map-String,Object

    • getOptionsKey

      public Optional<Object> getOptionsKey(String key)
      Fetch options key from options map as castable object
      Parameters:
      key -
      Returns:
      Optional-Object

    • hasOptionsKey

      public boolean hasOptionsKey(String key)
      Returns whether options key is present in map
      Parameters:
      key -
      Returns:
      boolean

    • setOptions

      public void setOptions(Optional<Map<String,Object>> options)
      Sets option map for ManagerCommand
      Parameters:
      options -

    • toJsonString

      public String toJsonString()
      Represent as JSON string
      Returns:
      String

    • toJsonDoc

      public String toJsonDoc()
      Represent as JSON document
      Returns:
      String

    • toString

      public String toString()
      Represent as string
      Overrides:
      toString in class Object
      Returns:
      String