net.sf.cuf.model.converter

Class FormatConverter<OwnT,SubjectT>

java.lang.Object

net.sf.cuf.model.AbstractValueModel<OwnT>

net.sf.cuf.model.converter.AbstractTypeConverter<OwnT,SubjectT>

net.sf.cuf.model.converter.FormatConverter<OwnT,SubjectT>

Type Parameters:

OwnT - the type of the own value

SubjectT - the type of the subject value

All Implemented Interfaces:

EventListener, ChangeListener, TypeConverter<OwnT,SubjectT>, DelegateAccess, ExternalUpdate, ValueModel<OwnT>

public class FormatConverter<OwnT,SubjectT>
extends AbstractTypeConverter<OwnT,SubjectT>
implements TypeConverter<OwnT,SubjectT>

A FormatConverter uses the java.text.Format framework for doing the type conversion. In convertSubjectToOwnValue() the Format.format() method is used, in convertOwnToSubjectValue() the Format.parseObject() method is used.

Constructor Summary

Constructors

Constructor and Description
FormatConverter(ValueModel<SubjectT> pSubject, Format pFormat) Create a new converter with the handed subject.
FormatConverter(ValueModel<SubjectT> pSubject, Format pFormat, boolean pInvert) Create a new converter with the handed subject.

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 of the subject value model.
OwnT	convertSubjectToOwnValue(SubjectT pSubjectValue) Converts from the type that the subject value model provides to the type this value model offers

Methods inherited from class net.sf.cuf.model.converter.AbstractTypeConverter

dispose, getPropagateFailedConversions, getSubject, getSubjectValue, getSyncKey, getSyncMessage, getSyncState, getValue, getValue, isEditable, setPropagateFailedConversions, setSyncKey, setSyncMessage, setValue, stateChanged

Methods inherited from class net.sf.cuf.model.AbstractValueModel

addChangeListener, booleanValue, checkDisposed, doubleValue, fireStateChanged, floatValue, getDependents, getName, intValue, isDisposed, isInSetValue, isSetForced, longValue, onChangeSend, removeChangeListener, retractInterestsFor, setInSetValue, setName, setObjectValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueForced, signalExternalUpdate, stringValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.cuf.model.converter.TypeConverter

getSyncKey, getSyncMessage, getSyncState, setSyncKey, setSyncMessage

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

Constructor Detail

FormatConverter

public FormatConverter(ValueModel<SubjectT> pSubject,
               Format pFormat,
               boolean pInvert)

Create a new converter with the handed subject.

Parameters:

pSubject - the ValueModel holding the original value, must not be null

pFormat - the format we should use for formatting/parsing

pInvert - if this is true, we invert the conversion

Throws:

IllegalArgumentException - if pSubject or pFormat is null

FormatConverter

public FormatConverter(ValueModel<SubjectT> pSubject,
               Format pFormat)

Create a new converter with the handed subject.

Parameters:

pSubject - the ValueModel holding the original value, must not be null

pFormat - the format we should use for formatting/parsing

Throws:

IllegalArgumentException - if pSubject or pFormat is null

Method Detail

convertSubjectToOwnValue

public OwnT convertSubjectToOwnValue(SubjectT pSubjectValue)
                              throws ConversionException

Converts from the type that the subject value model provides to the type this value model offers

Specified by:

convertSubjectToOwnValue in interface TypeConverter<OwnT,SubjectT>

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

public SubjectT convertOwnToSubjectValue(OwnT pOwnValue)
                                  throws ConversionException

Converts from the type that this value model offers to the type of the subject value model.

Specified by:

convertOwnToSubjectValue in interface TypeConverter<OwnT,SubjectT>

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