Class ParameterShort


  • public class ParameterShort
    extends Parameter
    A singed short parameter used in either the recording or execution of a script action.
    • Field Detail

      • value

        private short value
        The parameter's value.
    • Constructor Detail

      • ParameterShort

        public ParameterShort​(java.lang.String paramLabel)
                       throws ParserException
        Creates a new ParameterShort object without any value.
        Parameters:
        paramLabel - The label/name to give to this parameter.
        Throws:
        ParserException - If there is a problem creating the parameter.
      • ParameterShort

        public ParameterShort​(java.lang.String paramLabel,
                              short paramValue)
                       throws ParserException
        Creates a new ParameterShort with a new value.
        Parameters:
        paramLabel - The label/name to give to this parameter.
        paramValue - The new parameter value.
        Throws:
        ParserException - If there is a problem creating the parameter.
      • ParameterShort

        public ParameterShort​(java.lang.String paramLabel,
                              java.lang.String paramTypeString,
                              short paramValue)
                       throws ParserException
        Creates a new ParameterShort object.
        Parameters:
        paramLabel - The label/name to give to this parameter.
        paramTypeString - The type of this parameter, in string form.
        paramValue - The new parameter value.
        Throws:
        ParserException - If there is a problem creating the parameter.
      • ParameterShort

        public ParameterShort​(java.lang.String paramLabel,
                              java.lang.String paramTypeString,
                              java.lang.String paramValueString)
                       throws ParserException
        Creates a new ParameterShort object.
        Parameters:
        paramLabel - The label/name to give to this parameter.
        paramTypeString - The type of this parameter, in string form.
        paramValueString - The new parameter value in string form.
        Throws:
        ParserException - If there is a problem creating the parameter.
      • ParameterShort

        public ParameterShort​(java.lang.String paramLabel,
                              int paramType,
                              short paramValue)
                       throws ParserException
        Creates a new ParameterShort object.
        Parameters:
        paramLabel - The label/name to give to this parameter.
        paramType - The type of this parameter (should be PARAM_SHORT).
        paramValue - The new parameter value.
        Throws:
        ParserException - If there is a problem creating the parameter.
      • ParameterShort

        public ParameterShort​(java.lang.String paramLabel,
                              int paramType,
                              java.lang.String paramValueString)
                       throws ParserException
        Creates a new ParameterShort object.
        Parameters:
        paramLabel - The label/name to give to this parameter.
        paramType - The type of this parameter (should be PARAM_SHORT).
        paramValueString - The new parameter value in string form.
        Throws:
        ParserException - If there is a problem creating the parameter.
    • Method Detail

      • getValue

        public short getValue()
        Returns the parameter value.
        Returns:
        The parameter value.
      • getValueString

        public java.lang.String getValueString()
        Returns the parameter value as a string.
        Specified by:
        getValueString in class Parameter
        Returns:
        The parameter value in string form.
      • setValue

        public void setValue​(java.lang.String paramValueString)
                      throws ParserException
        Changes the parameter's current value.
        Specified by:
        setValue in class Parameter
        Parameters:
        paramValueString - The new parameter value in String form.
        Throws:
        ParserException - If there is a problem changing the parameter value.
      • setValue

        public void setValue​(short paramValue)
                      throws ParserException
        Changes the parameter's current value.
        Parameters:
        paramValue - The new parameter value.
        Throws:
        ParserException - If there is a problem changing the parameter value.