Package net.sf.basedb.core

Class IntegerParameterType

java.lang.Object

net.sf.basedb.core.ParameterType<Integer>

net.sf.basedb.core.IntegerParameterType

public class IntegerParameterType
extends ParameterType<Integer>

This class represent a parameter type that is an integer. 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: 2012-09-14 09:28:35 +0200 (fr, 14 sep 2012) $

Field Summary

Fields

Modifier and Type	Field	Description
private final Integer	lowerLimit	The lower limit of the parameter.
private final Integer	upperLimit	The upper limit of the parameter.

Constructor Summary

Constructors

Constructor	Description
IntegerParameterType()	Create a new integer parameter type, without any limits and allowing null values.
IntegerParameterType(Integer lowerLimit, Integer upperLimit, Integer defaultValue, boolean notNull)	Create a new integer parameter type.
IntegerParameterType(Integer lowerLimit, Integer upperLimit, Integer defaultValue, boolean notNull, int multiplicity, int width, int height, List<Integer> items)

Method Summary

Modifier and Type	Method	Description
Integer	getLowerLimit()	Get the lowest valid value of the parameter.
Integer	getUpperLimit()	Get the highest valid value of the parameter.
(package private) IntegerParameterValueData	newParameterValueData()	Create a new IntegerParameterValueData object.
String	toString()
(package private) void	validateValue(String name, Integer 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

lowerLimit

private final Integer lowerLimit

The lower limit of the parameter.

upperLimit

private final Integer upperLimit

The upper limit of the parameter.

Constructor Details

IntegerParameterType

public IntegerParameterType()

Create a new integer parameter type, without any limits and allowing null values.

IntegerParameterType

public IntegerParameterType(Integer lowerLimit,
 Integer upperLimit,
 Integer defaultValue,
 boolean notNull)

Create a new integer 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 - The default value for this parameter

notNull - FALSE if nulls values are allowed, TRUE otherwise

IntegerParameterType

public IntegerParameterType(Integer lowerLimit,
 Integer upperLimit,
 Integer defaultValue,
 boolean notNull,
 int multiplicity,
 int width,
 int height,
 List<Integer> items)

Method Details

toString

public String toString()

Overrides:

toString in class Object

validateValue

void validateValue(String name,
 Integer 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<Integer>

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

IntegerParameterValueData newParameterValueData()

Create a new IntegerParameterValueData object.

Specified by:

newParameterValueData in class ParameterType<Integer>

getLowerLimit

public Integer getLowerLimit()

Get the lowest valid value of the parameter.

Returns:

Lowest valid value or null if none is set.

getUpperLimit

public Integer getUpperLimit()

Get the highest valid value of the parameter.

Returns:

Highest valid value or null if none is set.