2.17.2: 2011-06-17

net.sf.basedb.core
Class FloatParameterType

java.lang.Object
  extended by net.sf.basedb.core.ParameterType<Float>
      extended by net.sf.basedb.core.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.

Version:
2.0
Author:
Samuel, Nicklas
Last modified
$Date: 2010-10-01 13:51:57 +0200 (Fri, 01 Oct 2010) $

Field Summary
private  Float lowerLimit
          The lower limit of the parameter.
private  Float upperLimit
          The upper limit of the parameter.
 
Constructor Summary
FloatParameterType()
          Create a new float parameter type, without any limits and allowing null values.
FloatParameterType(Float lowerLimit, Float upperLimit, Float defaultValue, boolean notNull)
          Create a new float parameter type.
FloatParameterType(Float lowerLimit, Float upperLimit, Float defaultValue, boolean notNull, int multiplicity, int width, int height, List<Float> items)
           
 
Method Summary
 Float getLowerLimit()
          Get the lowst valid value of the parameter.
 Float getUpperLimit()
          Get the highest valid value of the parameter.
(package private)  FloatParameterValueData newParameterValueData()
          Create a new FloatParameterValueData object.
 String toString()
           
(package private)  void validateValue(String name, Float value)
          Checks if the value is within the range given by the upper and lower limits if those are given.
 
Methods inherited from class net.sf.basedb.core.ParameterType
getDefaultValue, getEnumeration, getHeight, getItems, getMultiplicity, getNotNull, getParameterClass, getValueType, getWidth, isEnumeration, validate, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

lowerLimit

private final Float lowerLimit
The lower limit of the parameter.


upperLimit

private final Float upperLimit
The upper limit of the parameter.

Constructor Detail

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.

Parameters:
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 Detail

toString

public String toString()
Overrides:
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>
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

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.

Returns:
Lowst valid value or null if none is set.

getUpperLimit

public Float getUpperLimit()
Get the highest valid value of the parameter.

Returns:
Highest valid value or null if none is set.

2.17.2: 2011-06-17