Package net.sf.basedb.core
Class LongParameterType
- java.lang.Object
-
- net.sf.basedb.core.ParameterType<Long>
-
- net.sf.basedb.core.LongParameterType
-
public class LongParameterType extends ParameterType<Long>
This class represent a parameter type that is a long. This type defines alower limit
and anupper 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 Summary
Fields Modifier and Type Field Description private Long
lowerLimit
The lower limit of the parameter.private Long
upperLimit
The upper limit of the parameter.
-
Constructor Summary
Constructors Constructor Description LongParameterType()
Create a new long parameter type, without any limits and allowing null values.LongParameterType(Long lowerLimit, Long upperLimit, Long defaultValue, boolean notNull)
Create a new long parameter type.LongParameterType(Long lowerLimit, Long upperLimit, Long defaultValue, boolean notNull, int multiplicity, int width, int height, List<Long> items)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Long
getLowerLimit()
Get the lowest valid value of the parameter.Long
getUpperLimit()
Get the highest valid value of the parameter.(package private) LongParameterValueData
newParameterValueData()
Create a newLongParameterValueData
object.String
toString()
(package private) void
validateValue(String name, Long 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, isMasked, validate, validate
-
-
-
-
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 limitupperLimit
- The highest allowed value, or null to have no limitdefaultValue
- Default value for the parameter.notNull
- FALSE if nulls values are allowed, TRUE otherwise
-
-
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 classParameterType<Long>
- Parameters:
value
- The value to testname
- 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
LongParameterValueData newParameterValueData()
Create a newLongParameterValueData
object.- Specified by:
newParameterValueData
in classParameterType<Long>
-
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.
-
-