ch.agent.crnickl.api

Interface ValueScanner<T>

Type Parameters:

T - the underlying data type of the values

All Known Implementing Classes:

ValueTypeImpl.BooleanScanner, ValueTypeImpl.DateScanner, ValueTypeImpl.DateTimeScanner, ValueTypeImpl.NameScanner, ValueTypeImpl.NumberScanner, ValueTypeImpl.TextScanner, ValueTypeImpl.TimeDomainScanner, ValueTypeImpl.TypeScanner

public interface ValueScanner<T>

A ValueScanner provides a standard textual interface to types. Implementations can provide a constructor taking a ValueType. If such a constructor is available it is used. Else value scanners are created using a parameterless constructor.

Author:

Jean-Paul Vetterli

Method Summary

Modifier and Type	Method and Description
void	check(T value) Throw an exception if the value does not conform to special restrictions enforced by the value scanner.
Class<T>	getType() Return the class of underlying data type of the value scanner.
T	scan(String value) Scan a string and convert it to an object of the scanner's actual type.
String	toString(T value) Check and convert the parameter to a string.

Method Detail

getType

Class<T> getType()

Return the class of underlying data type of the value scanner.

Returns:

a class

scan

T scan(String value)
throws T2DBException

Scan a string and convert it to an object of the scanner's actual type. Throw an exception when the conversion fails. Whether the input can be null depends on the actual implementation. The method also performs a check(Object).

Parameters:

value - a string

Returns:

the value converted to the underlying data type

Throws:

T2DBException

check

void check(T value)
    throws T2DBException

Throw an exception if the value does not conform to special restrictions enforced by the value scanner. For example, a value scanner for positive numbers would check that the value is greater than zero.

Parameters:

value - a value

Throws:

T2DBException

toString

String toString(T value)
         throws T2DBException

Check and convert the parameter to a string. Return null if the value is null.

Parameters:

value - a value

Returns:

a string or null

Throws:

T2DBException