Package gov.nih.mipav.model.scripting

Class ParsedActionLine

  • public class ParsedActionLine
extends java.lang.Object
    This object holds data parsed from a single line in a script, including the action to be taken and the parameters to pass to that action.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String action
      The String representing the action which should be taken when this line is executed.
      private ParameterTable paramList
      A table of parameters which may/will be used when the action is performed.

    • Constructor Summary

      Constructors 
      Constructor Description
      ParsedActionLine​(java.lang.String newAction, ParameterTable newParamList)
      Creates a new ParsedActionLine object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String convertToString()
      Returns this parsed action and its parameters in String form.
      java.lang.String getAction()
      Returns the action which should be taken when this line is executed.
      int getParameterCount()
      Returns the number of parameters which will be passed to this action.
      ParameterTable getParameterTable()
      Returns the table of parameters which will be passed to this action when it is executed.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • action

        private java.lang.String action
        The String representing the action which should be taken when this line is executed.

      • paramList

        private ParameterTable paramList
        A table of parameters which may/will be used when the action is performed.

    • Constructor Detail

      • ParsedActionLine

        public ParsedActionLine​(java.lang.String newAction,
                        ParameterTable newParamList)
        Creates a new ParsedActionLine object.
        Parameters:
        newAction - The String representing the action to be taken
        newParamList - The table of parameters which may/will be used when the action is performed

    • Method Detail

      • convertToString

        public java.lang.String convertToString()
        Returns this parsed action and its parameters in String form. May be used to write out the action line to a script.
        Returns:
        this parsed action and its parameters in String form

      • getAction

        public java.lang.String getAction()
        Returns the action which should be taken when this line is executed.
        Returns:
        The String representing the action which should be taken when this line is executed.

      • getParameterCount

        public int getParameterCount()
        Returns the number of parameters which will be passed to this action.
        Returns:
        The number of parameters.

      • getParameterTable

        public ParameterTable getParameterTable()
        Returns the table of parameters which will be passed to this action when it is executed.
        Returns:
        The table of parameters to be used when this action is run.