ValueModel (CUF2 Parent Project 2.0.8 API)

Type Parameters:
T - the type we contain as our value

All Known Subinterfaces:

TypeConverter<OwnT,SubjectT>

All Known Implementing Classes:

AbstractNumberStringConverter, AbstractTypeConverter, AbstractValueModel, AspectAdapter, BigDecimalStringConverter, BufferedValueHolder, Collection2ListConverter, DoubleStringConverter, FormatConverter, IndexedAdapter, IntegerStringConverter, ListFilterConverter, LongStringConverter, LOVMapper, MultiSelectionInList, PropertiesAdapter, RegExpConverter, SelectionInList, StateValue, UnmodifiableValueHolder, ValueHolder
```
public interface ValueModel<T>
```
Java version of the Smalltalk/VisualWorks Value Model framework. See http://c2.com/ppr/vmodels.html for an introduction of the Smalltalk version.
Because i was not sure what is the "right" listener registration method, i included both the smalltalk-like onChangeSend() as well as the Java-like addChangeListener() method.
In any case, a change of the value of a ValueModel object will call the dependent method with a ChangeEvent as sole argument, the source of the event is always the ValueModel firing the event.

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.
`void`	`dispose()` Cleanup all resources: disconnect from any input sources (like other ValueModel's ...), and remove all listeners. Any method besides isDisposed, dispose or getName will throw an IllegalStateException after the ValueModel was disposed.
`double`	`doubleValue()` Converts our value to a double.
`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.
`T`	`getValue()` Get the current value, during a callback this is the new value.
`int`	`intValue()` Converts our value to an int.
`boolean`	`isDisposed()` Check if the value model is disposed.
`boolean`	`isEditable()` Returns true if a setValue() is possible, and doesn't throw an UnsupportedOperationException,
`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".
`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 in this model.
`void`	`setValue(T pValue, boolean pIsSetForced)` Set a new value, either forced or without force.
`void`	`setValueForced(T pValue)` Set a new value in this model.
`String`	`stringValue()` Converts our value to a String.

- Method Detail
  - getValue
```
T getValue()
```
    Get the current value, during a callback this is the new value.
    
    Returns:
    null or the value object
  - setValue
```
void setValue(T pValue)
```
    Set a new value in this model. The method will fire a ChangeEvent to its listeners if the new value is different from the old value. If a ChangeEvent should always be sent, use #setValueForced.
    
    Parameters:
    pValue - the new value (null is o.k.)
    
    Throws:
    
    UnsupportedOperationException - if this ValueModel is not mutable
  - setObjectValue
```
void setObjectValue(Object pValue)
```
    Needed since we generified everything, if we have no type given.
    
    Parameters:
    pValue - the value to be casted and set as new value
  - setValueForced
```
void setValueForced(T pValue)
```
    Set a new value in this model. The method will always fire a ChangeEvent to its listeners, even if the new value equals the old value.
    
    Parameters:
    pValue - the new value (null is o.k.)
    
    Throws:
    
    UnsupportedOperationException - if this ValueModel is not mutable
  - setValue
```
void setValue(T pValue,
            boolean pIsSetForced)
```
    Set a new value, either forced or without force. The method might fire a ChangeEvent to its listeners.
    
    Parameters:
    pValue - the new value (null is o.k.)
    pIsSetForced - true if a forced setValue should be done (see #setValueForced for details)
    
    Throws:
    
    UnsupportedOperationException - if this ValueModel is not mutable
  - isSetForced
```
boolean isSetForced()
```
    Returns true if setValueForced() was called, only useful during a callback.
    
    Returns:
    false if we are not inside a callback or a "normal" setValue() was issued
  - isEditable
```
boolean isEditable()
```
    Returns true if a setValue() is possible, and doesn't throw an UnsupportedOperationException,
    
    Returns:
    true if setValue() can be called
  - onChangeSend
```
void onChangeSend(Object pDependent,
                String pMethodName)
```
    Add an dependent listener to a ValueModel, "Smalltalk style".
    
    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
```
void addChangeListener(ChangeListener pDependent)
```
    Add an dependent listener to a ValueModel, "Java style".
    
    Parameters:
    pDependent - the object to call
    
    Throws:
    
    IllegalArgumentException - if pDependent is null
  - retractInterestsFor
```
void retractInterestsFor(Object pDependent)
```
    Remove a dependent listener, "Smalltalk style". If pDependent is null or not known, nothing happens.
    
    Parameters:
    pDependent - object to de-register
  - removeChangeListener
```
void removeChangeListener(ChangeListener pDependent)
```
    Remove a dependent listener, "Java style". If pDependent is null or not known, nothing happens.
    
    Parameters:
    pDependent - object to de-register
  - dispose
```
void dispose()
```
    Cleanup all resources: disconnect from any input sources (like other ValueModel's ...), and remove all listeners.
    Any method besides isDisposed, dispose or getName will throw an IllegalStateException after the ValueModel was disposed.
  - isDisposed
```
boolean isDisposed()
```
    Check if the value model is disposed.
    
    Returns:
    true if the value model is disposed (= no longer valid)
  - getDependents
```
List<Object> getDependents()
```
    Return a immutable list of all direct dependents of the value model.
    
    Returns:
    an immutable List of all direct dependents
  - getName
```
String getName()
```
    Return the name of the state.
    
    Returns:
    the name of the state (never null)
  - setName
```
void setName(String pName)
```
    Set the name of the state.
    
    Parameters:
    pName - the name of the state (must not be null)
    
    Throws:
    
    IllegalArgumentException - if pState is null
  - booleanValue
```
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.
    
    Returns:
    the boolean version of our value
    
    Throws:
    
    NumberFormatException - if the value can't be converted to a boolean
  - setValue
```
void setValue(boolean pValue)
```
    Converts the given boolean to an object and sets it as new value.
    
    Parameters:
    pValue - the value to be converted and set as new value
  - intValue
```
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.
    
    Returns:
    the int version of our value
    
    Throws:
    
    NumberFormatException - if the value can't be converted to a int
  - setValue
```
void setValue(int pValue)
```
    Converts the given int to an object and sets it as new value.
    
    Parameters:
    pValue - the value to be converted and set as new value
  - longValue
```
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.
    
    Returns:
    the long version of our value
    
    Throws:
    
    NumberFormatException - if the value can't be converted to a long
  - setValue
```
void setValue(long pValue)
```
    Converts the given long to an object and sets it as new value.
    
    Parameters:
    pValue - the value to be converted and set as new value
  - floatValue
```
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.
    
    Returns:
    the float version of our value
    
    Throws:
    
    NumberFormatException - if the value can't be converted to a float
  - setValue
```
void setValue(float pValue)
```
    Converts the given float to an object and sets it as new value.
    
    Parameters:
    pValue - the value to be converted and set as new value
  - doubleValue
```
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.
    
    Returns:
    the double version of our value
    
    Throws:
    
    NumberFormatException - if the value can't be converted to a double
  - setValue
```
void setValue(double pValue)
```
    Converts the given double to an object and sets it as new value.
    
    Parameters:
    pValue - the value to be converted and set as new value
  - stringValue
```
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.
    
    Returns:
    the String version of our value

Interface ValueModel<T>

Method Summary

Method Detail

getValue

setValue

setObjectValue

setValueForced

setValue

isSetForced

isEditable

onChangeSend

addChangeListener

retractInterestsFor

removeChangeListener

dispose

isDisposed

getDependents

getName

setName

booleanValue

setValue

intValue

setValue

longValue

setValue

floatValue

setValue

doubleValue

setValue

stringValue