Encapsulates an interval of double precision numbers. * * The endpoints of the interval may be supplied in any order * and will be ordered automatically.
* * @author Richard Rasala * @author Jeff Raab * @version 2.2 * @since 1.0 */ public class Interval implements Cloneable, Serializable, Stringable { /** Bound property name for the minimum property. */ protected static final String MINIMUM = "minimum"; /** Bound property name for the maximum property. */ protected static final String MAXIMUM = "maximum"; /** Bound property name for the midpoint property. */ protected static final String MIDPOINT = "midpoint"; /** Bound property name for the size property. */ protected static final String SIZE = "SIZE"; /** Lower endpoint of interval. */ protected double minimum = 0.0; /** Upper endpoint of interval. */ protected double maximum = 0.0; /** * Interval size, equal to the difference between * the maximum and minimum endpoints. */ protected double size = 0.0; /** The midpoint of the interval. */ protected double midpoint = 0.0; /** Helper object for property change API. */ protected SwingPropertyChangeSupport changeAdapter = new SwingPropertyChangeSupport(this); ////////////////// // Constructors // ////////////////// /** * Constructs an interval with all data set to 0.0. * * @see #Interval(double, double) * @see #Interval(String) */ public Interval() {}; /** * Constructs an interval with the given endpoints. * * @param endpointA one of the two endpoints * @param endpointB the other of the two endpoints * @see #Interval() * @see #Interval(String) * @see #setEndpoints(double, double) */ public Interval(double endpointA, double endpointB) { setEndpoints(endpointA, endpointB); } /** * Constructs an interval from encodedString data.
*
* @param data the encoded String data
* @see #Interval()
* @see #Interval(double, double)
* @see #toStringData()
* @see #fromStringData(String)
* @see #toString()
*/
public Interval(String data) throws ParseException {
fromStringData(data);
}
////////////////
// Stringable //
////////////////
/**
* Returns a String representation of the data state
* for this Interval object.
*
* @see #Interval(String)
* @see #fromStringData(String)
* @see #toString()
*/
public String toStringData() {
return toString();
}
/**
* Extracts the data state for this Interval object
* from a String representation of the data state.
*
* @param data String representation of the desired value
* @throws ParseException if the data is malformed
* @see #Interval(String)
* @see #toStringData()
* @see #toString()
*/
public void fromStringData(String data) throws ParseException {
if (data == null)
throw new ParseException("Input was null.", -1);
String[] pair = XPoint2D.decodeIntoPair(data);
double lower = XDouble.parseDouble(pair[0]);
double upper = XDouble.parseDouble(pair[1]);
setEndpoints(lower, upper);
}
/**
* Returns a human readable String representing the
* data state of this Interval as: (minimum;maximum).
*
* @see #Interval(String)
* @see #toStringData()
* @see #fromStringData(String)
*/
public String toString() {
return "[" + minimum + ";" + maximum + "]";
}
////////////////
// Public API //
////////////////
/**
* Sets the endpoints for the interval * to the given endpoints.
* *Calling this method may result in the firing
* of one or more PropertyChangeEvents.
*
* These events will be fired for property changes
* in the following order:
* MINIMUM, MAXIMUM,
* MIDPOINT, SIZE.
null,
* this method does nothing.
*
* @param other the interval to be copied
* @see #setEndpoints(double, double)
*/
public void setInterval(Interval other) {
if (other == null)
return;
setEndpoints(other.minimum, other.maximum);
}
/**
* Returns the lower endpoint of the interval.
*
* @see #getMaximum()
*/
public double getMinimum() {
return minimum;
}
/**
* Returns the upper endpoint of the interval.
*
* @see #getMinimum()
*/
public double getMaximum() {
return maximum;
}
/**
* Returns the size of the interval, that is,
* the difference between the upper and lower endpoints.
*/
public double getSize() {
return size;
}
/**
* Returns the midpoint of the interval.
*/
public double getMidpoint() {
return midpoint;
}
/////////////////////////////
// Property Change Support //
/////////////////////////////
/**
* Registers the given object
* to listen for property change events
* generated by this object.
*
* @param listener the listener to be registered
*/
public void addPropertyChangeListener(
PropertyChangeListener listener)
{
changeAdapter.addPropertyChangeListener(listener);
}
/**
* Registers the given object
* to listen for property change events
* generated by this object
* with the given property name.
*
* @param propertyName the name of the desired property
* @param listener the listener to be registered
*/
public void addPropertyChangeListener(
String propertyName,
PropertyChangeListener listener)
{
changeAdapter.addPropertyChangeListener(
propertyName,
listener);
}
/**
* Deregisters the given object
* from listening for property change events
* generated by this object.
*
* @param listener the listener to be deregistered
*/
public void removePropertyChangeListener(
PropertyChangeListener listener)
{
changeAdapter.removePropertyChangeListener(listener);
}
/**
* Deregisters the given object
* from listening for property change events
* generated by this object
* with the given property name.
*
* @param propertyName the name of the desired property
* @param listener the listener to be deregistered
*/
public void removePropertyChangeListener(
String propertyName,
PropertyChangeListener listener)
{
changeAdapter.removePropertyChangeListener(
propertyName,
listener);
}
}