org.jowidgets.tools.converter

Class MapConverter<OBJECT_TYPE>

java.lang.Object

org.jowidgets.tools.converter.MapConverter<OBJECT_TYPE>

All Implemented Interfaces:

IConverter<OBJECT_TYPE>, IObjectStringConverter<OBJECT_TYPE>, IStringObjectConverter<OBJECT_TYPE>

public final class MapConverter<OBJECT_TYPE>
extends java.lang.Object
implements IConverter<OBJECT_TYPE>

Constructor Summary

Constructors

Constructor and Description
MapConverter(java.util.Map<? extends OBJECT_TYPE,java.lang.String> objectToString, java.util.Map<java.lang.String,? extends OBJECT_TYPE> stringToObject, java.lang.String hint)

Method Summary

Methods

Modifier and Type	Method and Description
OBJECT_TYPE	convertToObject(java.lang.String string) Converts an string input to an object.
java.lang.String	convertToString(OBJECT_TYPE value) Converts the value to an string representation
java.lang.String	getAcceptingRegExp() Gets the regular expression that describes the valid inputs.
java.lang.String	getDescription(OBJECT_TYPE value) Gets an description for an value
IInputVerifier	getInputVerifier() Gets an input verifier that verifies the input.
ITextMask	getMask() Gets a mask if the input should be masked.
IValidator<java.lang.String>	getStringValidator() Gets a validator that will be used to validate the string input.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MapConverter

public MapConverter(java.util.Map<? extends OBJECT_TYPE,java.lang.String> objectToString,
            java.util.Map<java.lang.String,? extends OBJECT_TYPE> stringToObject,
            java.lang.String hint)

Method Detail

convertToString

public java.lang.String convertToString(OBJECT_TYPE value)

Description copied from interface: IObjectStringConverter

Converts the value to an string representation

Specified by:

convertToString in interface IObjectStringConverter<OBJECT_TYPE>

Parameters:

value - The value to convert

Returns:

the string representation

convertToObject

public OBJECT_TYPE convertToObject(java.lang.String string)

Description copied from interface: IStringObjectConverter

Converts an string input to an object.

Specified by:

convertToObject in interface IStringObjectConverter<OBJECT_TYPE>

Parameters:

string - The string to convert.

Returns:

The object that is represented by the string or null if: 1. The string input is not convertible to the OBJECT_TYPE 2. The string represents null

getDescription

public java.lang.String getDescription(OBJECT_TYPE value)

Description copied from interface: IObjectStringConverter

Gets an description for an value

Specified by:

getDescription in interface IObjectStringConverter<OBJECT_TYPE>

Parameters:

value - the value to get the description for

Returns:

the description or null if there is no description

getStringValidator

public IValidator<java.lang.String> getStringValidator()

Description copied from interface: IStringObjectConverter

Gets a validator that will be used to validate the string input.

Specified by:

getStringValidator in interface IStringObjectConverter<OBJECT_TYPE>

Returns:

A validator or null

getInputVerifier

public IInputVerifier getInputVerifier()

Description copied from interface: IStringObjectConverter

Gets an input verifier that verifies the input. REMARK: Implementors must not assume that the verifier will be used on all platforms, so the validator implementation must consider inputs that won't be verified REMARK: Implementors should prefer to use regular expressions instead of IInputVerifier's if possible because SPI implementations that use 'AJAX' can implement client side verification easier.

Specified by:

getInputVerifier in interface IStringObjectConverter<OBJECT_TYPE>

Returns:

A verifier or null

getAcceptingRegExp

public java.lang.String getAcceptingRegExp()

Description copied from interface: IStringObjectConverter

Gets the regular expression that describes the valid inputs. REMARK: Implementors should prefer to use regular expressions instead of IInputVerifier's if possible because SPI implementations that uses e.g 'AJAX' can implement client side verification easier. REMARK: Implementors must not assume that the regular expression will be used on all platforms

Specified by:

getAcceptingRegExp in interface IStringObjectConverter<OBJECT_TYPE>

Returns:

A regular expression or null

getMask

public ITextMask getMask()

Description copied from interface: IStringObjectConverter

Gets a mask if the input should be masked.

Specified by:

getMask in interface IStringObjectConverter<OBJECT_TYPE>

Returns:

A text mask or null if the input is not masked

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object