net.sf.cuf.model.converter

Class RegExpConverter

java.lang.Object

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

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

net.sf.cuf.model.converter.RegExpConverter

All Implemented Interfaces:

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

public class RegExpConverter
extends AbstractTypeConverter<String,String>
implements TypeConverter<String,String>

A RegExpConverter uses a regular expression for a string-to-string conversion. The main use of a RegExpConverter is obviously not to convert something, but to provide a convenient way of validating input.

Note that by default the RegExpConverter blocks values that don't match its pattern and doesn't pass them through (both directions).

Constructor Summary

Constructors

Constructor and Description
RegExpConverter(ValueModel<String> pSubject, String pRegExp) Create a new converter with the handed subject.
RegExpConverter(ValueModel<String> pSubject, String pRegExp, boolean pBlockValue) Create a new converter with the handed subject.

Method Summary

Methods

Modifier and Type	Method and Description
String	convertOwnToSubjectValue(String pOwnValue) Converts from the type that this value model offers to the type of the subject value model.
String	convertSubjectToOwnValue(String pSubjectValue) Converts from the type that the subject value model provides to the type this value model offers
boolean	getBlockValue()
void	setBlockValue(boolean pBlockValue) sets the block behavious

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

RegExpConverter

public RegExpConverter(ValueModel<String> pSubject,
               String pRegExp)

Create a new converter with the handed subject.

Parameters:

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

pRegExp - the regular expression we should use for formatting/parsing

Throws:

IllegalArgumentException - if pSubject or pRegExp is null or pRegExp is not valid

RegExpConverter

public RegExpConverter(ValueModel<String> pSubject,
               String pRegExp,
               boolean pBlockValue)

Create a new converter with the handed subject.

Parameters:

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

pRegExp - the regular expression we should use for formatting/parsing

pBlockValue - if true, values are blocked if they don't match the regexp, if false, they are propagated

Throws:

IllegalArgumentException - if pSubject or pRegExp is null or pRegExp is not valid

Method Detail

getBlockValue

public boolean getBlockValue()

Returns:

true if we should block values when the tests fail

setBlockValue

public void setBlockValue(boolean pBlockValue)

sets the block behavious

Parameters:

pBlockValue - if true, values are blocked if they don't match the regexp, if false, they are propagated

convertSubjectToOwnValue

public String convertSubjectToOwnValue(String 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<String,String>

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 String convertOwnToSubjectValue(String 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<String,String>

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