ch.agent.crnickl.impl

Class ValueTypeImpl.TimeDomainScanner

java.lang.Object

ch.agent.crnickl.impl.ValueTypeImpl.TimeDomainScanner

All Implemented Interfaces:

ValueScanner<ch.agent.t2.time.TimeDomain>

Enclosing class:

ValueTypeImpl<T>

public static class ValueTypeImpl.TimeDomainScanner
extends Object
implements ValueScanner<ch.agent.t2.time.TimeDomain>

A value scanner for data representing TimeDomains.

Constructor Summary

Constructors

Constructor and Description
TimeDomainScanner(ch.agent.t2.time.TimeDomainCatalog catalog) Constructor

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeDomainScanner

public TimeDomainScanner(ch.agent.t2.time.TimeDomainCatalog catalog)

Constructor

Parameters:

catalog - the time domain catalog to use

Method Detail

getType

public Class<ch.agent.t2.time.TimeDomain> getType()

Description copied from interface: ValueScanner

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

Specified by:

getType in interface ValueScanner<ch.agent.t2.time.TimeDomain>

Returns:

a class

check

public void check(ch.agent.t2.time.TimeDomain value)

Description copied from interface: ValueScanner

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.

Specified by:

check in interface ValueScanner<ch.agent.t2.time.TimeDomain>

Parameters:

value - a value

scan

public ch.agent.t2.time.TimeDomain scan(String value)
                                 throws T2DBException

Description copied from interface: ValueScanner

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 ValueScanner.check(Object).

Specified by:

scan in interface ValueScanner<ch.agent.t2.time.TimeDomain>

Parameters:

value - a string

Returns:

the value converted to the underlying data type

Throws:

T2DBException

toString

public String toString(ch.agent.t2.time.TimeDomain value)

Description copied from interface: ValueScanner

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

Specified by:

toString in interface ValueScanner<ch.agent.t2.time.TimeDomain>

Parameters:

value - a value

Returns:

a string or null