Class LongParameterType


  • public class LongParameterType
    extends ParameterType<Long>
    This class represent a parameter type that is a long. This type defines a lower limit and an upper limit for the range of allowed values.
    Version:
    2.0
    Author:
    Nicklas
    Last modified
    $Date: 2012-09-14 09:28:35 +0200 (fr, 14 sep 2012) $
    • Field Detail

      • lowerLimit

        private final Long lowerLimit
        The lower limit of the parameter.
      • upperLimit

        private final Long upperLimit
        The upper limit of the parameter.
    • Constructor Detail

      • LongParameterType

        public LongParameterType()
        Create a new long parameter type, without any limits and allowing null values.
      • LongParameterType

        public LongParameterType​(Long lowerLimit,
                                 Long upperLimit,
                                 Long defaultValue,
                                 boolean notNull)
        Create a new long parameter type.
        Parameters:
        lowerLimit - The lowest allowed value, or null to have no limit
        upperLimit - The highest allowed value, or null to have no limit
        defaultValue - Default value for the parameter.
        notNull - FALSE if nulls values are allowed, TRUE otherwise
      • LongParameterType

        public LongParameterType​(Long lowerLimit,
                                 Long upperLimit,
                                 Long defaultValue,
                                 boolean notNull,
                                 int multiplicity,
                                 int width,
                                 int height,
                                 List<Long> items)
    • Method Detail

      • validateValue

        void validateValue​(String name,
                           Long value)
                    throws InvalidDataException
        Checks if the value is within the range given by the upper and lower limits if those are given.
        Specified by:
        validateValue in class ParameterType<Long>
        Parameters:
        value - The value to test
        name - The name of the parameter, use the name if there is need to throw an exception
        Throws:
        InvalidDataException - If the value is outside the range of allowed values
      • getLowerLimit

        public Long getLowerLimit()
        Get the lowest valid value of the parameter.
        Returns:
        Lowest valid value or null if none is set.
      • getUpperLimit

        public Long getUpperLimit()
        Get the highest valid value of the parameter.
        Returns:
        Highest valid value or null if none is set.