de.tsl2.nano.action

Interface IConstraint<T>

public interface IConstraint<T>

Version:

$Revision$

Author:

Tom

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNDEFINED usable for int definitions that are not bitfields
static int	UNSET usable for all int definitions like bitfiels type and style

Method Summary

Modifier and Type	Method and Description
void	check(String name, T value) checks, if the given value is valid - throws an exception
IStatus	checkStatus(String name, T value) checks, if the given value is valid - should not throw an exception
static Object	fromString(Class<?> type, String def)
Collection<T>	getAllowedValues() returns the allowed values or null
T	getDefault() default value for this attribute
Format	getFormat() format-constraint for the attributes value
int	getLength() maximum length - useful on strings
Comparable<T>	getMaximum() returns the maximum value or null
Comparable<T>	getMinimum() returns the minimum value or null
int	getPrecision() precision - useful for numbers of type BigDecimal
int	getScale() scale - useful for numbers of type BigDecimal
Class<T>	getType() value type
boolean	isNullable() should return true, if attribute-value may be null
<C extends IConstraint<T>> C	setBasicDef(int length, boolean nullable, Format format, T defaultValue) define some basic attribute definitions
<C extends IConstraint<T>> C	setDefault(T defaultValue)
<C extends IConstraint<T>> C	setFormat(Format format) define constraining text format. use RegularExpressionFormat to define a regexp pattern
<C extends IConstraint<T>> C	setLength(int length) define maximum length
<C extends IConstraint<T>> C	setNullable(boolean nullable) define nullable
<C extends IConstraint<T>> C	setNumberDef(int scale, int precision) define number definitions - if the attribute is a number
<C extends IConstraint<T>> C	setPrecision(int precision) define precision
<C extends IConstraint<T>> C	setRange(Collection<T> allowedValues) defines all allowed values - if you call setRange(Comparable, Comparable), you shouldn't call this method
<C extends IConstraint<T>> C	setRange(Comparable<T> min, Comparable<T> max) defines a min/max range constraint. use ValueCompare to compare on changing values
<C extends IConstraint<T>> C	setScale(int scale) define scale
<C extends IConstraint<T>> C	setType(Class<T> type) define type

Field Detail

UNDEFINED

static final int UNDEFINED

usable for int definitions that are not bitfields

See Also:

Constant Field Values

UNSET

static final int UNSET

usable for all int definitions like bitfiels type and style

See Also:

Constant Field Values

Method Detail

getFormat

Format getFormat()

format-constraint for the attributes value

getType

Class<T> getType()

value type

checkStatus

IStatus checkStatus(String name,
                    T value)

checks, if the given value is valid - should not throw an exception

check

void check(String name,
           T value)

checks, if the given value is valid - throws an exception

getDefault

T getDefault()

default value for this attribute

getMinimum

Comparable<T> getMinimum()

returns the minimum value or null

getMaximum

Comparable<T> getMaximum()

returns the maximum value or null

getAllowedValues

Collection<T> getAllowedValues()

returns the allowed values or null

getLength

int getLength()

maximum length - useful on strings

getScale

int getScale()

scale - useful for numbers of type BigDecimal

getPrecision

int getPrecision()

precision - useful for numbers of type BigDecimal

isNullable

boolean isNullable()

should return true, if attribute-value may be null

setBasicDef

<C extends IConstraint<T>> C setBasicDef(int length,
                                         boolean nullable,
                                         Format format,
                                         T defaultValue)

define some basic attribute definitions

setNumberDef

<C extends IConstraint<T>> C setNumberDef(int scale,
                                          int precision)

define number definitions - if the attribute is a number

setRange

<C extends IConstraint<T>> C setRange(Comparable<T> min,
                                      Comparable<T> max)

defines a min/max range constraint. use ValueCompare to compare on changing values

setRange

<C extends IConstraint<T>> C setRange(Collection<T> allowedValues)

defines all allowed values - if you call setRange(Comparable, Comparable), you shouldn't call this method

setFormat

<C extends IConstraint<T>> C setFormat(Format format)

define constraining text format. use RegularExpressionFormat to define a regexp pattern

setType

<C extends IConstraint<T>> C setType(Class<T> type)

define type

setLength

<C extends IConstraint<T>> C setLength(int length)

define maximum length

setScale

<C extends IConstraint<T>> C setScale(int scale)

define scale

setPrecision

<C extends IConstraint<T>> C setPrecision(int precision)

define precision

setNullable

<C extends IConstraint<T>> C setNullable(boolean nullable)

define nullable

setDefault

<C extends IConstraint<T>> C setDefault(T defaultValue)

fromString

static Object fromString(Class<?> type,
                         String def)