Class FloatParameterType


public class FloatParameterType
extends ParameterType<Float>
This class represent a parameter type that is a float. This type defines a lower limit and an upper limit for the range of allowed values.
Samuel, Nicklas
Last modified
$Date: 2012-09-14 09:28:35 +0200 (fr, 14 sep 2012) $
  • Field Details

    • lowerLimit

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

      private final Float upperLimit
      The upper limit of the parameter.
  • Constructor Details

    • FloatParameterType

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

      public FloatParameterType​(Float lowerLimit, Float upperLimit, Float defaultValue, boolean notNull)
      Create a new float parameter type.
      lowerLimit - The lowest allowed value, or null to have no limit
      upperLimit - The highest allowed value, or null to have no limit
      defaultValue - A value to use by default with the parameter.
      notNull - FALSE if nulls values are allowed, TRUE otherwise
    • FloatParameterType

      public FloatParameterType​(Float lowerLimit, Float upperLimit, Float defaultValue, boolean notNull, int multiplicity, int width, int height, List<Float> items)
  • Method Details

    • toString

      public String toString()
      toString in class Object
    • validateValue

      void validateValue​(String name, Float 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<Float>
      value - The value to test
      name - The name of the parameter, use the name if there is need to throw an exception
      InvalidDataException - If the value is outside the range of allowed values
    • newParameterValueData

      FloatParameterValueData newParameterValueData()
      Create a new FloatParameterValueData object.
      Specified by:
      newParameterValueData in class ParameterType<Float>
    • getLowerLimit

      public Float getLowerLimit()
      Get the lowst valid value of the parameter.
      Lowst valid value or null if none is set.
    • getUpperLimit

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