< prev index next >
src/java.desktop/share/classes/javax/swing/SpinnerNumberModel.java
Print this page
@@ -28,28 +28,28 @@
import java.util.*;
import java.io.Serializable;
/**
- * A <code>SpinnerModel</code> for sequences of numbers.
+ * A {@code SpinnerModel} for sequences of numbers.
* The upper and lower bounds of the sequence are defined
- * by properties called <code>minimum</code> and
- * <code>maximum</code>. The size of the increase or decrease
- * computed by the <code>nextValue</code> and
- * <code>previousValue</code> methods is defined by a property called
- * <code>stepSize</code>. The <code>minimum</code> and
- * <code>maximum</code> properties can be <code>null</code>
+ * by properties called {@code minimum} and
+ * {@code maximum}. The size of the increase or decrease
+ * computed by the {@code nextValue} and
+ * {@code previousValue} methods is defined by a property called
+ * {@code stepSize}. The {@code minimum} and
+ * {@code maximum} properties can be {@code null}
* to indicate that the sequence has no lower or upper limit.
* All of the properties in this class are defined in terms of two
- * generic types: <code>Number</code> and
- * <code>Comparable</code>, so that all Java numeric types
+ * generic types: {@code Number} and
+ * {@code Comparable}, so that all Java numeric types
* may be accommodated. Internally, there's only support for
- * values whose type is one of the primitive <code>Number</code> types:
- * <code>Double</code>, <code>Float</code>, <code>Long</code>,
- * <code>Integer</code>, <code>Short</code>, or <code>Byte</code>.
+ * values whose type is one of the primitive {@code Number} types:
+ * {@code Double}, {@code Float}, {@code Long},
+ * {@code Integer}, {@code Short}, or {@code Byte}.
* <p>
- * To create a <code>SpinnerNumberModel</code> for the integer
+ * To create a {@code SpinnerNumberModel} for the integer
* range zero to one hundred, with
* fifty as the initial value, one could write:
* <pre>
* Integer value = new Integer(50);
* Integer min = new Integer(0);
@@ -64,14 +64,14 @@
* the previous example, one could also write:
* <pre>
* SpinnerNumberModel model = new SpinnerNumberModel(50, 0, 100, 1);
* </pre>
* <p>
- * This model inherits a <code>ChangeListener</code>.
- * The <code>ChangeListeners</code> are notified
- * whenever the model's <code>value</code>, <code>stepSize</code>,
- * <code>minimum</code>, or <code>maximum</code> properties changes.
+ * This model inherits a {@code ChangeListener}.
+ * The {@code ChangeListeners} are notified
+ * whenever the model's {@code value}, {@code stepSize},
+ * {@code minimum}, or {@code maximum} properties changes.
*
* @see JSpinner
* @see SpinnerModel
* @see AbstractSpinnerModel
* @see SpinnerListModel
@@ -95,38 +95,38 @@
// bridge.
private Comparable<?> minimum, maximum;
/**
- * Constructs a <code>SpinnerModel</code> that represents
+ * Constructs a {@code SpinnerModel} that represents
* a closed sequence of
- * numbers from <code>minimum</code> to <code>maximum</code>. The
- * <code>nextValue</code> and <code>previousValue</code> methods
+ * numbers from {@code minimum} to {@code maximum}. The
+ * {@code nextValue} and {@code previousValue} methods
* compute elements of the sequence by adding or subtracting
- * <code>stepSize</code> respectively. All of the parameters
- * must be mutually <code>Comparable</code>, <code>value</code>
- * and <code>stepSize</code> must be instances of <code>Integer</code>
- * <code>Long</code>, <code>Float</code>, or <code>Double</code>.
+ * {@code stepSize} respectively. All of the parameters
+ * must be mutually {@code Comparable}, {@code value}
+ * and {@code stepSize} must be instances of {@code Integer}
+ * {@code Long}, {@code Float}, or {@code Double}.
* <p>
- * The <code>minimum</code> and <code>maximum</code> parameters
- * can be <code>null</code> to indicate that the range doesn't
+ * The {@code minimum} and {@code maximum} parameters
+ * can be {@code null} to indicate that the range doesn't
* have an upper or lower bound.
- * If <code>value</code> or <code>stepSize</code> is <code>null</code>,
- * or if both <code>minimum</code> and <code>maximum</code>
- * are specified and <code>minimum > maximum</code> then an
- * <code>IllegalArgumentException</code> is thrown.
- * Similarly if <code>(minimum <= value <= maximum</code>) is false,
- * an <code>IllegalArgumentException</code> is thrown.
- *
- * @param value the current (non <code>null</code>) value of the model
- * @param minimum the first number in the sequence or <code>null</code>
- * @param maximum the last number in the sequence or <code>null</code>
+ * If {@code value} or {@code stepSize} is {@code null},
+ * or if both {@code minimum} and {@code maximum}
+ * are specified and {@code minimum > maximum} then an
+ * {@code IllegalArgumentException} is thrown.
+ * Similarly if {@code (minimum <= value <= maximum}) is false,
+ * an {@code IllegalArgumentException} is thrown.
+ *
+ * @param value the current (non {@code null}) value of the model
+ * @param minimum the first number in the sequence or {@code null}
+ * @param maximum the last number in the sequence or {@code null}
* @param stepSize the difference between elements of the sequence
*
* @throws IllegalArgumentException if stepSize or value is
- * <code>null</code> or if the following expression is false:
- * <code>minimum <= value <= maximum</code>
+ * {@code null} or if the following expression is false:
+ * {@code minimum <= value <= maximum}
*/
@SuppressWarnings("unchecked") // Casts to Comparable<Object>
public SpinnerNumberModel(Number value,
Comparable<?> minimum,
Comparable<?> maximum,
@@ -144,85 +144,85 @@
this.stepSize = stepSize;
}
/**
- * Constructs a <code>SpinnerNumberModel</code> with the specified
- * <code>value</code>, <code>minimum</code>/<code>maximum</code> bounds,
- * and <code>stepSize</code>.
+ * Constructs a {@code SpinnerNumberModel} with the specified
+ * {@code value}, {@code minimum}/{@code maximum} bounds,
+ * and {@code stepSize}.
*
* @param value the current value of the model
* @param minimum the first number in the sequence
* @param maximum the last number in the sequence
* @param stepSize the difference between elements of the sequence
* @throws IllegalArgumentException if the following expression is false:
- * <code>minimum <= value <= maximum</code>
+ * {@code minimum <= value <= maximum}
*/
public SpinnerNumberModel(int value, int minimum, int maximum, int stepSize) {
this(Integer.valueOf(value), Integer.valueOf(minimum), Integer.valueOf(maximum), Integer.valueOf(stepSize));
}
/**
- * Constructs a <code>SpinnerNumberModel</code> with the specified
- * <code>value</code>, <code>minimum</code>/<code>maximum</code> bounds,
- * and <code>stepSize</code>.
+ * Constructs a {@code SpinnerNumberModel} with the specified
+ * {@code value}, {@code minimum}/{@code maximum} bounds,
+ * and {@code stepSize}.
*
* @param value the current value of the model
* @param minimum the first number in the sequence
* @param maximum the last number in the sequence
* @param stepSize the difference between elements of the sequence
* @throws IllegalArgumentException if the following expression is false:
- * <code>minimum <= value <= maximum</code>
+ * {@code minimum <= value <= maximum}
*/
public SpinnerNumberModel(double value, double minimum, double maximum, double stepSize) {
this(new Double(value), new Double(minimum), new Double(maximum), new Double(stepSize));
}
/**
- * Constructs a <code>SpinnerNumberModel</code> with no
- * <code>minimum</code> or <code>maximum</code> value,
- * <code>stepSize</code> equal to one, and an initial value of zero.
+ * Constructs a {@code SpinnerNumberModel} with no
+ * {@code minimum} or {@code maximum} value,
+ * {@code stepSize} equal to one, and an initial value of zero.
*/
public SpinnerNumberModel() {
this(Integer.valueOf(0), null, null, Integer.valueOf(1));
}
/**
* Changes the lower bound for numbers in this sequence.
- * If <code>minimum</code> is <code>null</code>,
+ * If {@code minimum} is {@code null},
* then there is no lower bound. No bounds checking is done here;
- * the new <code>minimum</code> value may invalidate the
- * <code>(minimum <= value <= maximum)</code>
+ * the new {@code minimum} value may invalidate the
+ * {@code (minimum <= value <= maximum)}
* invariant enforced by the constructors. This is to simplify updating
* the model, naturally one should ensure that the invariant is true
- * before calling the <code>getNextValue</code>,
- * <code>getPreviousValue</code>, or <code>setValue</code> methods.
+ * before calling the {@code getNextValue},
+ * {@code getPreviousValue}, or {@code setValue} methods.
* <p>
- * Typically this property is a <code>Number</code> of the same type
- * as the <code>value</code> however it's possible to use any
- * <code>Comparable</code> with a <code>compareTo</code>
- * method for a <code>Number</code> with the same type as the value.
- * For example if value was a <code>Long</code>,
- * <code>minimum</code> might be a Date subclass defined like this:
+ * Typically this property is a {@code Number} of the same type
+ * as the {@code value} however it's possible to use any
+ * {@code Comparable} with a {@code compareTo}
+ * method for a {@code Number} with the same type as the value.
+ * For example if value was a {@code Long},
+ * {@code minimum} might be a Date subclass defined like this:
* <pre>
* MyDate extends Date { // Date already implements Comparable
* public int compareTo(Long o) {
* long t = getTime();
* return (t < o.longValue() ? -1 : (t == o.longValue() ? 0 : 1));
* }
* }
* </pre>
* <p>
- * This method fires a <code>ChangeEvent</code>
- * if the <code>minimum</code> has changed.
+ * This method fires a {@code ChangeEvent}
+ * if the {@code minimum} has changed.
*
- * @param minimum a <code>Comparable</code> that has a
- * <code>compareTo</code> method for <code>Number</code>s with
- * the same type as <code>value</code>
+ * @param minimum a {@code Comparable} that has a
+ * {@code compareTo} method for {@code Number}s with
+ * the same type as {@code value}
* @see #getMinimum
* @see #setMaximum
* @see SpinnerModel#addChangeListener
*/
public void setMinimum(Comparable<?> minimum) {
@@ -234,42 +234,42 @@
/**
* Returns the first number in this sequence.
*
- * @return the value of the <code>minimum</code> property
+ * @return the value of the {@code minimum} property
* @see #setMinimum
*/
public Comparable<?> getMinimum() {
return minimum;
}
/**
* Changes the upper bound for numbers in this sequence.
- * If <code>maximum</code> is <code>null</code>, then there
+ * If {@code maximum} is {@code null}, then there
* is no upper bound. No bounds checking is done here; the new
- * <code>maximum</code> value may invalidate the
- * <code>(minimum <= value < maximum)</code>
+ * {@code maximum} value may invalidate the
+ * {@code (minimum <= value < maximum)}
* invariant enforced by the constructors. This is to simplify updating
* the model, naturally one should ensure that the invariant is true
- * before calling the <code>next</code>, <code>previous</code>,
- * or <code>setValue</code> methods.
+ * before calling the {@code next}, {@code previous},
+ * or {@code setValue} methods.
* <p>
- * Typically this property is a <code>Number</code> of the same type
- * as the <code>value</code> however it's possible to use any
- * <code>Comparable</code> with a <code>compareTo</code>
- * method for a <code>Number</code> with the same type as the value.
+ * Typically this property is a {@code Number} of the same type
+ * as the {@code value} however it's possible to use any
+ * {@code Comparable} with a {@code compareTo}
+ * method for a {@code Number} with the same type as the value.
* See <a href="#setMinimum(java.lang.Comparable)">
- * <code>setMinimum</code></a> for an example.
+ * {@code setMinimum}</a> for an example.
* <p>
- * This method fires a <code>ChangeEvent</code> if the
- * <code>maximum</code> has changed.
+ * This method fires a {@code ChangeEvent} if the
+ * {@code maximum} has changed.
*
- * @param maximum a <code>Comparable</code> that has a
- * <code>compareTo</code> method for <code>Number</code>s with
- * the same type as <code>value</code>
+ * @param maximum a {@code Comparable} that has a
+ * {@code compareTo} method for {@code Number}s with
+ * the same type as {@code value}
* @see #getMaximum
* @see #setMinimum
* @see SpinnerModel#addChangeListener
*/
public void setMaximum(Comparable<?> maximum) {
@@ -281,29 +281,29 @@
/**
* Returns the last number in the sequence.
*
- * @return the value of the <code>maximum</code> property
+ * @return the value of the {@code maximum} property
* @see #setMaximum
*/
public Comparable<?> getMaximum() {
return maximum;
}
/**
* Changes the size of the value change computed by the
- * <code>getNextValue</code> and <code>getPreviousValue</code>
- * methods. An <code>IllegalArgumentException</code>
- * is thrown if <code>stepSize</code> is <code>null</code>.
+ * {@code getNextValue} and {@code getPreviousValue}
+ * methods. An {@code IllegalArgumentException}
+ * is thrown if {@code stepSize} is {@code null}.
* <p>
- * This method fires a <code>ChangeEvent</code> if the
- * <code>stepSize</code> has changed.
+ * This method fires a {@code ChangeEvent} if the
+ * {@code stepSize} has changed.
*
* @param stepSize the size of the value change computed by the
- * <code>getNextValue</code> and <code>getPreviousValue</code> methods
+ * {@code getNextValue} and {@code getPreviousValue} methods
* @see #getNextValue
* @see #getPreviousValue
* @see #getStepSize
* @see SpinnerModel#addChangeListener
*/
@@ -318,14 +318,14 @@
}
/**
* Returns the size of the value change computed by the
- * <code>getNextValue</code>
- * and <code>getPreviousValue</code> methods.
+ * {@code getNextValue}
+ * and {@code getPreviousValue} methods.
*
- * @return the value of the <code>stepSize</code> property
+ * @return the value of the {@code stepSize} property
* @see #setStepSize
*/
public Number getStepSize() {
return stepSize;
}
@@ -372,12 +372,12 @@
/**
* Returns the next number in the sequence.
*
- * @return <code>value + stepSize</code> or <code>null</code> if the sum
- * exceeds <code>maximum</code>.
+ * @return {@code value + stepSize} or {@code null} if the sum
+ * exceeds {@code maximum}.
*
* @see SpinnerModel#getNextValue
* @see #getPreviousValue
* @see #setStepSize
*/
@@ -387,13 +387,13 @@
/**
* Returns the previous number in the sequence.
*
- * @return <code>value - stepSize</code>, or
- * <code>null</code> if the sum is less
- * than <code>minimum</code>.
+ * @return {@code value - stepSize}, or
+ * {@code null} if the sum is less
+ * than {@code minimum}.
*
* @see SpinnerModel#getPreviousValue
* @see #getNextValue
* @see #setStepSize
*/
@@ -424,31 +424,31 @@
return value;
}
/**
- * Sets the current value for this sequence. If <code>value</code> is
- * <code>null</code>, or not a <code>Number</code>, an
- * <code>IllegalArgumentException</code> is thrown. No
+ * Sets the current value for this sequence. If {@code value} is
+ * {@code null}, or not a {@code Number}, an
+ * {@code IllegalArgumentException} is thrown. No
* bounds checking is done here; the new value may invalidate the
- * <code>(minimum <= value <= maximum)</code>
+ * {@code (minimum <= value <= maximum)}
* invariant enforced by the constructors. It's also possible to set
* the value to be something that wouldn't naturally occur in the sequence,
- * i.e. a value that's not modulo the <code>stepSize</code>.
+ * i.e. a value that's not modulo the {@code stepSize}.
* This is to simplify updating the model, and to accommodate
* spinners that don't want to restrict values that have been
* directly entered by the user. Naturally, one should ensure that the
- * <code>(minimum <= value <= maximum)</code> invariant is true
- * before calling the <code>next</code>, <code>previous</code>, or
- * <code>setValue</code> methods.
+ * {@code (minimum <= value <= maximum)} invariant is true
+ * before calling the {@code next}, {@code previous}, or
+ * {@code setValue} methods.
* <p>
- * This method fires a <code>ChangeEvent</code> if the value has changed.
+ * This method fires a {@code ChangeEvent} if the value has changed.
*
- * @param value the current (non <code>null</code>) <code>Number</code>
+ * @param value the current (non {@code null}) {@code Number}
* for this sequence
- * @throws IllegalArgumentException if <code>value</code> is
- * <code>null</code> or not a <code>Number</code>
+ * @throws IllegalArgumentException if {@code value} is
+ * {@code null} or not a {@code Number}
* @see #getNumber
* @see #getValue
* @see SpinnerModel#addChangeListener
*/
public void setValue(Object value) {
< prev index next >