net.sf.cuf.model.converter

Class AbstractNumberStringConverter<T extends Number>

java.lang.Object

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

net.sf.cuf.model.converter.AbstractTypeConverter<String,T>

net.sf.cuf.model.converter.AbstractNumberStringConverter<T>

Type Parameters:

T - the number type we support as our subjects type

All Implemented Interfaces:

EventListener, ChangeListener, TypeConverter<String,T>, DelegateAccess, ExternalUpdate, ValueModel<String>

Direct Known Subclasses:

DoubleStringConverter, IntegerStringConverter, LongStringConverter

public abstract class AbstractNumberStringConverter<T extends Number>
extends AbstractTypeConverter<String,T>
implements TypeConverter<String,T>

A base class for converters that take a Number as it's subject value and converting it to an String as its own value.

Derived classes must only implement convertToNumber(String) and my override convertToString(Number) if the default behaviour is not desired.

Constructor Summary

Constructors

Constructor and Description
AbstractNumberStringConverter(ValueModel<T> pSubject) Create a new Number-to-String converter where null is a valid value.
AbstractNumberStringConverter(ValueModel<T> pSubject, boolean pNullIsValid) Create a new Number-to-String converter.

Method Summary

Methods

Modifier and Type	Method and Description
T	convertOwnToSubjectValue(String pOwnValue) Converts from a String to an Number.
String	convertSubjectToOwnValue(T pSubjectValue) Converts from a Number to a String.
protected abstract T	convertToNumber(String pOwnValue) convert the own string value to the number.
protected String	convertToString(Number pSubjectValue) Converts from a Number to the String by calling toString.
boolean	getNullIsValid()
void	setNullIsValid(boolean pNullIsValid) Sets the flag if we should use null as an alternative value if the conversion fails
void	setNullSubstitute(Number pNullSubstitute) Method to set the Integer null substitute.

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

AbstractNumberStringConverter

public AbstractNumberStringConverter(ValueModel<T> pSubject)

Create a new Number-to-String converter where null is a valid value.

Parameters:

pSubject - the ValueModel holding the original value

AbstractNumberStringConverter

public AbstractNumberStringConverter(ValueModel<T> pSubject,
                             boolean pNullIsValid)

Create a new Number-to-String converter.

Parameters:

pSubject - the ValueModel holding the original value

pNullIsValid - true if we should use null as an alternative value if the conversion fails

Method Detail

setNullIsValid

public void setNullIsValid(boolean pNullIsValid)

Sets the flag if we should use null as an alternative value if the conversion fails

Parameters:

pNullIsValid - true if we should use null as an alternative value if the conversion fails

getNullIsValid

public boolean getNullIsValid()

Returns:

true if we should use null as an alternative value if the conversion fails

setNullSubstitute

public void setNullSubstitute(Number pNullSubstitute)

Method to set the Integer null substitute.

Parameters:

pNullSubstitute - null or any integer

Throws:

IllegalStateException - if null is not valid

convertSubjectToOwnValue

public String convertSubjectToOwnValue(T pSubjectValue)
                                throws ConversionException

Converts from a Number to a String.

Specified by:

convertSubjectToOwnValue in interface TypeConverter<String,T extends Number>

Parameters:

pSubjectValue - value in the subject's type (Number)

Returns:

value in this value model's type (String)

Throws:

ConversionException - if we detected an error during the conversion

convertToString

protected String convertToString(Number pSubjectValue)

Converts from a Number to the String by calling toString. Override to provide different behaviour.

Parameters:

pSubjectValue - the value in the source type (Number), never null

Returns:

value in this value model's type (String)

convertOwnToSubjectValue

public T convertOwnToSubjectValue(String pOwnValue)
                                          throws ConversionException

Converts from a String to an Number.

Specified by:

convertOwnToSubjectValue in interface TypeConverter<String,T extends Number>

Parameters:

pOwnValue - value in this value model's type (String)

Returns:

value in the subject's type (at least a Number)

Throws:

ConversionException - if we detected an error during the conversion

convertToNumber

protected abstract T convertToNumber(String pOwnValue)
                                             throws NumberFormatException

convert the own string value to the number. Implement this method to create your number instance, e.g. like return new Integer( ownValue); . If the conversion is not possible, you can throw a NumberFormatException which will be converted into a ConversionException with the correct substitute values.

Parameters:

pOwnValue - the value as a string

Returns:

the parsed number in its desired class

Throws:

NumberFormatException - if the string value is not parsable into a number