Class IntegerParameter

java.lang.Object
uk.ac.starlink.task.Parameter<Integer>
uk.ac.starlink.task.IntegerParameter

public class IntegerParameter extends Parameter<Integer>
Parameter representing an integer value.
  • Constructor Details

    • IntegerParameter

      public IntegerParameter(String name)
  • Method Details

    • stringToObject

      public Integer stringToObject(Environment env, String stringval) throws ParameterValueException
      Description copied from class: Parameter
      Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter. This method also performs validation, so if the string value is unacceptable in any way, a ParameterValueException should be thrown.

      It is an error to supply a null or empty string value.

      If this method fails (throws a ParameterValueException) and if allowClassnameValue is set, then a subsequent attempt will be made to interpret the stringVal as the classname of a suitable class with a no-arg constructor.

      Specified by:
      stringToObject in class Parameter<Integer>
      Parameters:
      env - execution environment; in most cases this is not required but for some purposes environment-specific characteristics may influence the result
      stringval - non-null, non-empty string value
      Returns:
      typed value
      Throws:
      ParameterValueException
    • intValue

      public int intValue(Environment env) throws TaskException
      Returns the value of this parameter as an int primitive.
      Returns:
      int value
      Throws:
      NullPointerException - if parameter value is null (only possible if isNullPermitted true)
      TaskException
    • setIntDefault

      public void setIntDefault(int dflt)
      Sets the default value as an integer.
      Parameters:
      dflt - new default value
    • setEven

      public void setEven()
      Mandates that any value of this parameter must be even.
    • setOdd

      public void setOdd()
      Mandates that any value of this parameter must be odd.
    • setMinimum

      public void setMinimum(int min)
      Mandates a minimum value for this parameter.
      Parameters:
      min - the smallest value this parameter may take
    • setMaximum

      public void setMaximum(int max)
      Mandates a maximum value for this parameter.
      Parameters:
      max - the largest value this parameter may take.