ch.agent.crnickl.impl

Class ValueTypeImpl.TextScanner

java.lang.Object

ch.agent.crnickl.impl.ValueTypeImpl.TextScanner

All Implemented Interfaces:

ValueScanner<String>

Enclosing class:

ValueTypeImpl<T>

public static class ValueTypeImpl.TextScanner
extends Object
implements ValueScanner<String>

A value scanner for textual data. After considering the alternatives, the design committee has decided to implement textual data with String.

Constructor Summary

Constructors

Constructor and Description
TextScanner()

Method Summary

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

TextScanner

public TextScanner()

Method Detail

getType

public Class<String> getType()

Description copied from interface: ValueScanner

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

Specified by:

getType in interface ValueScanner<String>

Returns:

a class

check

public void check(String 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<String>

Parameters:

value - a value

scan

public String scan(String value)

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<String>

Parameters:

value - a string

Returns:

the value converted to the underlying data type

toString

public String toString(String 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<String>

Parameters:

value - a value

Returns:

a string or null