Class LongParameter


  • public class LongParameter
    extends Parameter<java.lang.Long>
    Parameter representing a long integer value.
    • Constructor Detail

      • LongParameter

        public LongParameter​(java.lang.String name)
        Constructor.
        Parameters:
        name - parameter name
    • Method Detail

      • stringToObject

        public java.lang.Long stringToObject​(Environment env,
                                             java.lang.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<java.lang.Long>
        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
      • longValue

        public long longValue​(Environment env)
                       throws TaskException
        Returns the value of this parameter as long primitive.
        Returns:
        long value
        Throws:
        java.lang.NullPointerException - if parameter value is null (only possible if isNullPermitted true)
        TaskException
      • setMinimum

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

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