com.jgoodies.binding.value.AbstractValueModel Maven / Gradle / Ivy
Show all versions of jgoodies-binding Show documentation
/*
* Copyright (c) 2002-2013 JGoodies Software GmbH. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of JGoodies Software GmbH nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.jgoodies.binding.value;
import java.beans.PropertyChangeListener;
import com.jgoodies.binding.beans.Model;
/**
* An abstract class that minimizes the effort required to implement
* the {@link ValueModel} interface. It provides convenience methods
* to convert boolean, double, float, int, and long to their
* corresponding Object values and vice versa.
*
* Subclasses must implement {@code getValue()} and
* {@code setValue(Object)} to get and set this model's value.
*
* @author Karsten Lentzsch
* @version $Revision: 1.12 $
*
* @see com.jgoodies.binding.beans.ExtendedPropertyChangeSupport
*/
public abstract class AbstractValueModel extends Model implements ValueModel {
// Change Management ****************************************************
/**
* Registers the given PropertyChangeListener with this model.
* The listener will be notified if the value has changed.
*
* The PropertyChangeEvents delivered to the listener have the name
* set to "value". In other words, the listeners won't get notified
* when a PropertyChangeEvent is fired that has a null object as
* the name to indicate an arbitrary set of the event source's
* properties have changed.
*
* In the rare case, where you want to notify a PropertyChangeListener
* even with PropertyChangeEvents that have no property name set,
* you can register the listener with #addPropertyChangeListener,
* not #addValueChangeListener.
*
* @param l the listener to add
*
* @see ValueModel
*/
@Override
public final void addValueChangeListener(PropertyChangeListener l) {
addPropertyChangeListener(PROPERTY_VALUE, l);
}
/**
* Removes the given PropertyChangeListener from the model.
*
* @param l the listener to remove
*/
@Override
public final void removeValueChangeListener(PropertyChangeListener l) {
removePropertyChangeListener(PROPERTY_VALUE, l);
}
/**
* Notifies all listeners that have registered interest for
* notification on this event type. The event instance
* is lazily created using the parameters passed into
* the fire method.
*
* @param oldValue the value before the change
* @param newValue the value after the change
*
* @see java.beans.PropertyChangeSupport
*/
public final void fireValueChange(Object oldValue, Object newValue) {
firePropertyChange(PROPERTY_VALUE, oldValue, newValue);
}
/**
* Notifies all listeners that have registered interest for
* notification on this event type. The event instance
* is lazily created using the parameters passed into
* the fire method.
*
* The boolean parameter specifies whether differences between the old
* and new value are tested using {@code ==} or {@code #equals}.
*
* @param oldValue the value before the change
* @param newValue the value after the change
* @param checkIdentity true to compare the old and new value using
* {@code ==}, false to use {@code #equals}
*
* @see java.beans.PropertyChangeSupport
*/
public final void fireValueChange(Object oldValue, Object newValue, boolean checkIdentity) {
firePropertyChange(PROPERTY_VALUE, oldValue, newValue, checkIdentity);
}
/**
* Notifies all listeners that have registered interest for
* notification on this event type. The event instance
* is lazily created using the parameters passed into
* the fire method.
*
* @param oldValue the boolean value before the change
* @param newValue the boolean value after the change
*
* @see java.beans.PropertyChangeSupport
*/
public final void fireValueChange(boolean oldValue, boolean newValue) {
fireValueChange(Boolean.valueOf(oldValue), Boolean.valueOf(newValue));
}
/**
* Notifies all listeners that have registered interest for
* notification on this event type. The event instance
* is lazily created using the parameters passed into
* the fire method.
*
* @param oldValue the int value before the change
* @param newValue the int value after the change
*
* @see java.beans.PropertyChangeSupport
*/
public final void fireValueChange(int oldValue, int newValue) {
fireValueChange(Integer.valueOf(oldValue), Integer.valueOf(newValue));
}
/**
* Notifies all listeners that have registered interest for
* notification on this event type. The event instance
* is lazily created using the parameters passed into
* the fire method.
*
* @param oldValue the long value before the change
* @param newValue the long value after the change
*
* @see java.beans.PropertyChangeSupport
*/
public final void fireValueChange(long oldValue, long newValue) {
fireValueChange(Long.valueOf(oldValue), Long.valueOf(newValue));
}
/**
* Notifies all listeners that have registered interest for
* notification on this event type. The event instance
* is lazily created using the parameters passed into
* the fire method.
*
* @param oldValue the double value before the change
* @param newValue the double value after the change
*
* @see java.beans.PropertyChangeSupport
*/
public final void fireValueChange(double oldValue, double newValue) {
fireValueChange(Double.valueOf(oldValue), Double.valueOf(newValue));
}
/**
* Notifies all listeners that have registered interest for
* notification on this event type. The event instance
* is lazily created using the parameters passed into
* the fire method.
*
* @param oldValue the float value before the change
* @param newValue the float value after the change
*
* @see java.beans.PropertyChangeSupport
*/
public final void fireValueChange(float oldValue, float newValue) {
fireValueChange(Float.valueOf(oldValue), Float.valueOf(newValue));
}
// Type Conversion ******************************************************
/**
* Converts this model's value and returns it as a {@code boolean}.
*
* @return the {@code boolean} value
* @throws ClassCastException if the observed value is not of type
* {@code Boolean}
* @throws NullPointerException if the value is {@code null}
*/
public final boolean booleanValue() {
return ((Boolean) getValue()).booleanValue();
}
/**
* Converts this model's value and returns it as a {@code double}.
*
* @return the {@code double} value
* @throws ClassCastException if the observed value is not of type
* {@code Double}
* @throws NullPointerException if the value is {@code null}
*/
public final double doubleValue() {
return ((Double) getValue()).doubleValue();
}
/**
* Converts this model's value and returns it as a {@code float}.
*
* @return the {@code float} value
* @throws ClassCastException if the observed value is not of type
* {@code Float}
* @throws NullPointerException if the value is {@code null}
*/
public final float floatValue() {
return ((Float) getValue()).floatValue();
}
/**
* Converts this model's value and returns it as an {@code int}.
*
* @return the {@code int} value
* @throws ClassCastException if the observed value is not of type
* {@code Integer}
* @throws NullPointerException if the value is {@code null}
*/
public final int intValue() {
return ((Integer) getValue()).intValue();
}
/**
* Converts this model's value and returns it as a {@code long}.
*
* @return the {@code long} value
* @throws ClassCastException if the observed value is not of type
* {@code Long}
* @throws NullPointerException if the value is {@code null}
*/
public final long longValue() {
return ((Long) getValue()).longValue();
}
/**
* Converts this model's value and returns it as a {@code String}.
*
* @return this model's value as String
* @throws ClassCastException if the observed value is not of type
* {@code String}
*/
public String getString() {
return (String) getValue();
}
/**
* Converts the given {@code boolean} to a {@code Boolean} and
* sets it as new value.
*
* @param b the value to be converted and set as new value
*/
public final void setValue(boolean b) {
setValue(Boolean.valueOf(b));
}
/**
* Converts the given {@code double} to a {@code Double} and
* sets it as new value.
*
* @param d the value to be converted and set as new value
*/
public final void setValue(double d) {
setValue(Double.valueOf(d));
}
/**
* Converts the given {@code float} to a {@code Float} and
* sets it as new value.
*
* @param f the value to be converted and set as new value
*/
public final void setValue(float f) {
setValue(Float.valueOf(f));
}
/**
* Converts the given {@code int} to an {@code Integer} and
* sets it as new value.
*
* @param i the value to be converted and set as new value
*/
public final void setValue(int i) {
setValue(Integer.valueOf(i));
}
/**
* Converts the given {@code long} to a {@code Long} and
* sets it as new value.
*
* @param l the value to be converted and set as new value
*/
public final void setValue(long l) {
setValue(Long.valueOf(l));
}
/**
* Returns a string representation of this value model.
* Answers the print string of the observed value.
*
* @return a string representation of this value model
*/
@Override
public String toString() {
return getClass().getName() + "[" + paramString() + "]";
}
/**
* Returns a string representing the state of this model.
* This method is intended to be used only for debugging purposes,
* and the content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
* {@code null}.
*
* @return a string representation of this model's state
* @since 2.0.3
*/
protected String paramString() {
return "value=" + valueString();
}
/**
* Returns a string representing the value of this model.
* This method is intended to be used for debugging purposes only.
*
* @return a string representation of this model's value
* @since 2.0.3
*/
protected String valueString() {
try {
Object value = getValue();
return value == null ? "null" : value.toString();
} catch (Exception e) {
return "Can't read";
}
}
}