net.sf.cuf.model.converter

Interface TypeConverter<OwnT,SubjectT>

Type Parameters:

OwnT - the type of the own value

SubjectT - the type of the subject value

All Superinterfaces:

ValueModel<OwnT>

All Known Implementing Classes:

AbstractNumberStringConverter, AbstractTypeConverter, BigDecimalStringConverter, Collection2ListConverter, DoubleStringConverter, FormatConverter, IntegerStringConverter, ListFilterConverter, LongStringConverter, RegExpConverter

public interface TypeConverter<OwnT,SubjectT>
extends ValueModel<OwnT>

A TypeConverter is a ValueModel modelled after the Adapter-Pattern: it monitors a value model (called the subject) and converts the type of the subject's value to its own value type.
A TypeConverter provides also a sync state to check if the subject's value and the value of our users are in sync.

Method Summary

Methods

Modifier and Type	Method and Description
SubjectT	convertOwnToSubjectValue(OwnT pOwnValue) Converts from the type that this value model offers to the type its subject value model.
OwnT	convertSubjectToOwnValue(SubjectT pSubjectValue) Converts from the type that the subject value model provides to the type this value model offers.
Object	getSyncKey() Get the sync key for the sync state.
String	getSyncMessage() Return a sync message, usefull when the conversation fails.
ValueModel<Boolean>	getSyncState() Return a ValueModel containing a Boolean that shows if the last conversion in setValue() or getValue() was sucessfull.
void	setSyncKey(Object pKey) Set the sync key for the sync state.
void	setSyncMessage(String pMessage) Set the sync message.

Methods inherited from interface net.sf.cuf.model.ValueModel

addChangeListener, booleanValue, dispose, doubleValue, floatValue, getDependents, getName, getValue, intValue, isDisposed, isEditable, isSetForced, longValue, onChangeSend, removeChangeListener, retractInterestsFor, setName, setObjectValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueForced, stringValue

Method Detail

getSyncState

ValueModel<Boolean> getSyncState()

Return a ValueModel containing a Boolean that shows if the last conversion in setValue() or getValue() was sucessfull.

Returns:

a ValueModel holding either Boolean.TRUE or Boolean.FALSE.

getSyncKey

Object getSyncKey()

Get the sync key for the sync state.

Returns:

an key, may be null

setSyncKey

void setSyncKey(Object pKey)

Set the sync key for the sync state.

Parameters:

pKey - a key, may be null

getSyncMessage

String getSyncMessage()

Return a sync message, usefull when the conversation fails. If no one was set, a default message is returned.

Returns:

a sync message, never null

setSyncMessage

void setSyncMessage(String pMessage)

Set the sync message.

Parameters:

pMessage - the sync message, must not be null

convertSubjectToOwnValue

OwnT convertSubjectToOwnValue(SubjectT pSubjectValue)
                              throws ConversionException

Converts from the type that the subject value model provides to the type this value model offers. This method is used internally during getValue().

Parameters:

pSubjectValue - value in the subject's type

Returns:

value in this value model's type

Throws:

ConversionException - if we detected an error during the conversion

convertOwnToSubjectValue

SubjectT convertOwnToSubjectValue(OwnT pOwnValue)
                                  throws ConversionException

Converts from the type that this value model offers to the type its subject value model. This method is used internally during setValue().

Parameters:

pOwnValue - value in this value model's type

Returns:

value in the subject's type

Throws:

ConversionException - if we detected an error during the conversion