net.sf.cuf.model.converter

Class BigDecimalStringConverter

java.lang.Object

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

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

net.sf.cuf.model.converter.BigDecimalStringConverter

All Implemented Interfaces:

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

public class BigDecimalStringConverter
extends AbstractTypeConverter<String,BigDecimal>
implements TypeConverter<String,BigDecimal>

A BigDecimalStringConverter is taking a BigDecimal as it's subject value and converting it to an String as its own value.

Constructor Summary

Constructors

Constructor and Description
BigDecimalStringConverter(ValueModel<BigDecimal> pSubject) Create a new BigDecimal-to-String converter where null is a valid value.
BigDecimalStringConverter(ValueModel<BigDecimal> pSubject, boolean pNullIsValid) Create a new BigDecimal-to-String converter.
BigDecimalStringConverter(ValueModel<BigDecimal> pSubject, NumberFormat pFormat) Create a new BigDecimal-to-String converter where null is a valid value.
BigDecimalStringConverter(ValueModel<BigDecimal> pSubject, NumberFormat pFormat, boolean pNullIsValid) Create a new BigDecimal-to-String converter.

Method Summary

Methods

Modifier and Type	Method and Description
BigDecimal	convertOwnToSubjectValue(String pOwnValue) Converts from a String to an BigDecimal.
String	convertSubjectToOwnValue(BigDecimal pSubjectValue) Converts from a BigDecimal to a String.
void	setNullSubstitute(BigDecimal pNullSubstitute) Method to set the BigDecimal null subsitute.

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

BigDecimalStringConverter

public BigDecimalStringConverter(ValueModel<BigDecimal> pSubject)

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

Parameters:

pSubject - the ValueModel holding the original value

BigDecimalStringConverter

public BigDecimalStringConverter(ValueModel<BigDecimal> pSubject,
                         boolean pNullIsValid)

Create a new BigDecimal-to-String converter.

Parameters:

pSubject - the ValueModel holding the original value

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

BigDecimalStringConverter

public BigDecimalStringConverter(ValueModel<BigDecimal> pSubject,
                         NumberFormat pFormat)

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

Parameters:

pSubject - the ValueModel holding the original value

pFormat - the number formatter, may be null

BigDecimalStringConverter

public BigDecimalStringConverter(ValueModel<BigDecimal> pSubject,
                         NumberFormat pFormat,
                         boolean pNullIsValid)

Create a new BigDecimal-to-String converter.

Parameters:

pSubject - the ValueModel holding the original value

pFormat - the number formatter, may be null

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

Method Detail

setNullSubstitute

public void setNullSubstitute(BigDecimal pNullSubstitute)

Method to set the BigDecimal null subsitute.

Parameters:

pNullSubstitute - null or any BigDecimal

Throws:

IllegalStateException - if null is not valid

convertSubjectToOwnValue

public String convertSubjectToOwnValue(BigDecimal pSubjectValue)
                                throws ConversionException

Converts from a BigDecimal to a String.

Specified by:

convertSubjectToOwnValue in interface TypeConverter<String,BigDecimal>

Parameters:

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

Returns:

value in this value model's type (String)

Throws:

ConversionException - if we detected an error during the conversion

convertOwnToSubjectValue

public BigDecimal convertOwnToSubjectValue(String pOwnValue)
                                    throws ConversionException

Converts from a String to an BigDecimal.

Specified by:

convertOwnToSubjectValue in interface TypeConverter<String,BigDecimal>

Parameters:

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

Returns:

value in the subject's type (BigDecimal)

Throws:

ConversionException - if we detected an error during the conversion