Package gda.commandqueue

Record Class JythonCommandCommandProvider

java.lang.Object
java.lang.Record
gda.commandqueue.JythonCommandCommandProvider
All Implemented Interfaces:
CommandProvider, Serializable
public record JythonCommandCommandProvider(String commandToRun, String description, String settingsPath) extends Record implements CommandProvider
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    JythonCommandCommandProvider(String commandToRun, String description, String settingsPath)
    Creates an instance of a JythonCommandCommandProvider record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    commandToRun()
    Returns the value of the commandToRun record component.
    String
    description()
    Returns the value of the description record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Command
    getCommand()
    If the command is of the form "run 'script'" then use JythonScriptFileCommandProvider.getCommand as this handles pauses whilst JythonCommandRunnerCommand does not
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    settingsPath()
    Returns the value of the settingsPath record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • JythonCommandCommandProvider

      public JythonCommandCommandProvider(String commandToRun, String description, String settingsPath)
      Creates an instance of a JythonCommandCommandProvider record class.
      Parameters:
      commandToRun - the value for the commandToRun record component
      description - the value for the description record component
      settingsPath - the value for the settingsPath record component

  • Method Details

    • getCommand

      public Command getCommand() throws IOException
      If the command is of the form "run 'script'" then use JythonScriptFileCommandProvider.getCommand as this handles pauses whilst JythonCommandRunnerCommand does not
      Specified by:
      getCommand in interface CommandProvider
      Throws:
      IOException

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • commandToRun

      public String commandToRun()
      Returns the value of the commandToRun record component.
      Returns:
      the value of the commandToRun record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • settingsPath

      public String settingsPath()
      Returns the value of the settingsPath record component.
      Returns:
      the value of the settingsPath record component