net.sf.cuf.model

Class AbstractValueModel<T>

java.lang.Object

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

Type Parameters:

T - the type of the value we contain

All Implemented Interfaces:

ExternalUpdate, ValueModel<T>

Direct Known Subclasses:

AbstractTypeConverter, AspectAdapter, BufferedValueHolder, IndexedAdapter, LOVMapper, MultiSelectionInList, PropertiesAdapter, SelectionInList, StateValue, UnmodifiableValueHolder, ValueHolder

public abstract class AbstractValueModel<T>
extends Object
implements ValueModel<T>, ExternalUpdate

Abstract base class for a ValueModel, does the listener handling. The methods of this class are not threadsave, but in an UI environment that's o.k.. A derived class needs only to implement the methods

• void setValue(Object pValue, boolean pIsSetForced); and
• Object getValue();

Inside the derived class' setValue() method the code may check if the value changed at all if the pIsSetForced flag is false. If there was no change (and pIsSetForced is false), the method may return immediately.
If pIsSetForced if true, or the new and old value differ, the setValue() method should do the following tasks:

1. set the value
2. call the setInSetValue(true, pIsSetForced) method
3. call the fireStateChanged() method in a try/finally block
4. call the setInSetValue(false, pIsSetForced) method in the finally block

In the getValue() method, a derived class has not to do any special handling.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractValueModel() Creates internal listener lists.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener pDependent) Add an dependent listener to a ValueModel, "Java style".
boolean	booleanValue() Converts our value to a boolean.
protected void	checkDisposed() Helper method to throw a IllegalStateException if we are disposed.
void	dispose() Cleanup all resources: disconnect from any input sources (like other ValueModel's ...), and remove all listeners.
double	doubleValue() Converts our value to a double.
protected void	fireStateChanged() Helper method for our subclasses to fire ChangeEvents.
float	floatValue() Converts our value to a float.
List<Object>	getDependents() Return a immutable list of all direct dependents of the value model.
String	getName() Return the name of the state.
int	intValue() Converts our value to an int.
boolean	isDisposed() Check if the value model is disposed.
protected boolean	isInSetValue() Marker method that indicates if the object is just firing a state change due to a call of setValue().
boolean	isSetForced() Returns true if setValueForced() was called, only useful during a callback.
long	longValue() Converts our value to an long.
void	onChangeSend(Object pDependent, String pMethodName) Add an dependent listener to a ValueModel, "Smalltalk style".
void	removeChangeListener(ChangeListener pDependent) Remove a dependent listener, "Java style".
void	retractInterestsFor(Object pDependent) Remove a dependent listener, "Smalltalk style".
protected void	setInSetValue(boolean pInSetValue, boolean pIsSetForced) Pendant to isInSetValue() including the "forced" flag.
void	setName(String pName) Set the name of the state.
void	setObjectValue(Object pValue) Needed since we generified everything, if we have no type given.
void	setValue(boolean pValue) Converts the given boolean to an object and sets it as new value.
void	setValue(double pValue) Converts the given double to an object and sets it as new value.
void	setValue(float pValue) Converts the given float to an object and sets it as new value.
void	setValue(int pValue) Converts the given int to an object and sets it as new value.
void	setValue(long pValue) Converts the given long to an object and sets it as new value.
void	setValue(T pValue) Set a new value, this will call setValue(pValue, false) for the real work.
void	setValueForced(T pValue) Set a new value, this will call setValue(pValue, true) for the real work.
void	signalExternalUpdate() Signal this object that portions of its data changed.
String	stringValue() Converts our value to a String.

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.ValueModel

getValue, isEditable, setValue

Constructor Detail

AbstractValueModel

protected AbstractValueModel()

Creates internal listener lists.

Method Detail

onChangeSend

public void onChangeSend(Object pDependent,
                String pMethodName)

Add an dependent listener to a ValueModel, "Smalltalk style".

Specified by:

onChangeSend in interface ValueModel<T>

Parameters:

pDependent - the object to call

pMethodName - the method name to call back

Throws:

IllegalArgumentException - if pDependent or pMethod is null, or no method with the signature "public void pMethodName(ChangeEvent e)" is found for pDependent.

addChangeListener

public void addChangeListener(ChangeListener pDependent)

Add an dependent listener to a ValueModel, "Java style".

Specified by:

addChangeListener in interface ValueModel<T>

Parameters:

pDependent - the object to call

Throws:

IllegalArgumentException - if pDependent is null

retractInterestsFor

public void retractInterestsFor(Object pDependent)

Remove a dependent listener, "Smalltalk style". If pDependent is null or not known, nothing happens.

Specified by:

retractInterestsFor in interface ValueModel<T>

Parameters:

pDependent - object to de-register

removeChangeListener

public void removeChangeListener(ChangeListener pDependent)

Remove a dependent listener, "Java style". If pDependent is null or not known, nothing happens.

Specified by:

removeChangeListener in interface ValueModel<T>

Parameters:

pDependent - object to de-register

dispose

public void dispose()

Cleanup all resources: disconnect from any input sources (like other ValueModel's ...), and remove all listeners. If any method is called after the ValueModel was exposed, a IllegalStateException may be thrown.

Specified by:

dispose in interface ValueModel<T>

isDisposed

public boolean isDisposed()

Check if the value model is disposed.

Specified by:

isDisposed in interface ValueModel<T>

Returns:

true if the value model is disposed (= no longer valid)

checkDisposed

protected void checkDisposed()
                      throws IllegalStateException

Helper method to throw a IllegalStateException if we are disposed.

Throws:

IllegalStateException - if the value model is disposed

getDependents

public List<Object> getDependents()

Return a immutable list of all direct dependents of the value model.

Specified by:

getDependents in interface ValueModel<T>

Returns:

an immutablelList of all direct dependents

getName

public String getName()

Return the name of the state.

Specified by:

getName in interface ValueModel<T>

Returns:

the name of the state (never null)

setName

public void setName(String pName)

Set the name of the state.

Specified by:

setName in interface ValueModel<T>

Parameters:

pName - the name of the state (must not be null)

Throws:

IllegalArgumentException - if pState is null

setValue

public void setValue(T pValue)

Set a new value, this will call setValue(pValue, false) for the real work.

Specified by:

setValue in interface ValueModel<T>

Parameters:

pValue - the new value (null is o.k.)

Throws:

UnsupportedOperationException - if this ValueModel is not mutable

setObjectValue

public void setObjectValue(Object pValue)

Needed since we generified everything, if we have no type given.

Specified by:

setObjectValue in interface ValueModel<T>

Parameters:

pValue - the value to be casted and set as new value

setValueForced

public void setValueForced(T pValue)

Set a new value, this will call setValue(pValue, true) for the real work.

Specified by:

setValueForced in interface ValueModel<T>

Parameters:

pValue - the new value (null is o.k.)

Throws:

UnsupportedOperationException - if this ValueModel is not mutable

signalExternalUpdate

public void signalExternalUpdate()

Signal this object that portions of its data changed. If the ValueModel is currently firing a ChangeEvent to its listeners, the call is ignored.

Specified by:

signalExternalUpdate in interface ExternalUpdate

fireStateChanged

protected void fireStateChanged()

Helper method for our subclasses to fire ChangeEvents.

isInSetValue

protected boolean isInSetValue()

Marker method that indicates if the object is just firing a state change due to a call of setValue(). This is useful for objects that are listeners to the ValueModel and are not interested in state changes triggered by themselfs.

Returns:

true if we during a state change due to setValue(), false otherwise.

setInSetValue

protected void setInSetValue(boolean pInSetValue,
                 boolean pIsSetForced)

Pendant to isInSetValue() including the "forced" flag.

Parameters:

pInSetValue - true or false

pIsSetForced - true or false

isSetForced

public boolean isSetForced()

Returns true if setValueForced() was called, only useful during a callback.

Specified by:

isSetForced in interface ValueModel<T>

Returns:

false if we are not inside a callback or a "normal" setValue() was issued

booleanValue

public boolean booleanValue()

Converts our value to a boolean. If the value is not an Boolean, the result of the toString() method is parsed. If the value is null, false is returned.

Specified by:

booleanValue in interface ValueModel<T>

Returns:

the boolean version of our value

setValue

public void setValue(boolean pValue)

Converts the given boolean to an object and sets it as new value.

Specified by:

setValue in interface ValueModel<T>

Parameters:

pValue - the value to be converted and set as new value

intValue

public int intValue()

Converts our value to an int. If the value is not an Integer, the result of the toString() method is parsed. If the value is null, zero is returned.

Specified by:

intValue in interface ValueModel<T>

Returns:

the int version of our value

setValue

public void setValue(int pValue)

Converts the given int to an object and sets it as new value.

Specified by:

setValue in interface ValueModel<T>

Parameters:

pValue - the value to be converted and set as new value

longValue

public long longValue()

Converts our value to an long. If the value is not an Long, the result of the toString() method is parsed. If the value is null, zero is returned.

Specified by:

longValue in interface ValueModel<T>

Returns:

the long version of our value

setValue

public void setValue(long pValue)

Converts the given long to an object and sets it as new value.

Specified by:

setValue in interface ValueModel<T>

Parameters:

pValue - the value to be converted and set as new value

floatValue

public float floatValue()

Converts our value to a float. If the value is not a Float, the result of the toString() method is parsed. If the value is null, zero is returned.

Specified by:

floatValue in interface ValueModel<T>

Returns:

the float version of our value

setValue

public void setValue(float pValue)

Converts the given float to an object and sets it as new value.

Specified by:

setValue in interface ValueModel<T>

Parameters:

pValue - the value to be converted and set as new value

doubleValue

public double doubleValue()

Converts our value to a double. If the value is not a Double, the result of the toString() method is parsed. If the value is null, zero is returned.

Specified by:

doubleValue in interface ValueModel<T>

Returns:

the double version of our value

setValue

public void setValue(double pValue)

Converts the given double to an object and sets it as new value.

Specified by:

setValue in interface ValueModel<T>

Parameters:

pValue - the value to be converted and set as new value

stringValue

public String stringValue()

Converts our value to a String. If the value is not a String, the result of the toString() method is returned. If the value is null, null is returned.

Specified by:

stringValue in interface ValueModel<T>

Returns:

the String version of our value