< prev index next >
src/java.desktop/share/classes/javax/swing/SpinnerListModel.java
Print this page
@@ -28,26 +28,26 @@
import java.util.*;
import java.io.Serializable;
/**
- * A simple implementation of <code>SpinnerModel</code> whose
- * values are defined by an array or a <code>List</code>.
+ * A simple implementation of {@code SpinnerModel} whose
+ * values are defined by an array or a {@code List}.
* For example to create a model defined by
* an array of the names of the days of the week:
* <pre>
* String[] days = new DateFormatSymbols().getWeekdays();
* SpinnerModel model = new SpinnerListModel(Arrays.asList(days).subList(1, 8));
* </pre>
- * This class only stores a reference to the array or <code>List</code>
+ * This class only stores a reference to the array or {@code List}
* so if an element of the underlying sequence changes, it's up
- * to the application to notify the <code>ChangeListeners</code> by calling
- * <code>fireStateChanged</code>.
+ * to the application to notify the {@code ChangeListeners} by calling
+ * {@code fireStateChanged}.
* <p>
- * This model inherits a <code>ChangeListener</code>.
- * The <code>ChangeListener</code>s are notified whenever the
- * model's <code>value</code> or <code>list</code> properties changes.
+ * This model inherits a {@code ChangeListener}.
+ * The {@code ChangeListener}s are notified whenever the
+ * model's {@code value} or {@code list} properties changes.
*
* @see JSpinner
* @see SpinnerModel
* @see AbstractSpinnerModel
* @see SpinnerNumberModel
@@ -62,20 +62,20 @@
private List<?> list;
private int index;
/**
- * Constructs a <code>SpinnerModel</code> whose sequence of
- * values is defined by the specified <code>List</code>.
+ * Constructs a {@code SpinnerModel} whose sequence of
+ * values is defined by the specified {@code List}.
* The initial value (<i>current element</i>)
- * of the model will be <code>values.get(0)</code>.
- * If <code>values</code> is <code>null</code> or has zero
- * size, an <code>IllegalArugmentException</code> is thrown.
+ * of the model will be {@code values.get(0)}.
+ * If {@code values} is {@code null} or has zero
+ * size, an {@code IllegalArugmentException} is thrown.
*
* @param values the sequence this model represents
- * @throws IllegalArgumentException if <code>values</code> is
- * <code>null</code> or zero size
+ * @throws IllegalArgumentException if {@code values} is
+ * {@code null} or zero size
*/
public SpinnerListModel(List<?> values) {
if (values == null || values.size() == 0) {
throw new IllegalArgumentException("SpinnerListModel(List) expects non-null non-empty List");
}
@@ -83,19 +83,19 @@
this.index = 0;
}
/**
- * Constructs a <code>SpinnerModel</code> whose sequence of values
+ * Constructs a {@code SpinnerModel} whose sequence of values
* is defined by the specified array. The initial value of the model
- * will be <code>values[0]</code>. If <code>values</code> is
- * <code>null</code> or has zero length, an
- * <code>IllegalArgumentException</code> is thrown.
+ * will be {@code values[0]}. If {@code values} is
+ * {@code null} or has zero length, an
+ * {@code IllegalArgumentException} is thrown.
*
* @param values the sequence this model represents
- * @throws IllegalArgumentException if <code>values</code> is
- * <code>null</code> or zero length
+ * @throws IllegalArgumentException if {@code values} is
+ * {@code null} or zero length
*/
public SpinnerListModel(Object[] values) {
if (values == null || values.length == 0) {
throw new IllegalArgumentException("SpinnerListModel(Object[]) expects non-null non-empty Object[]");
}
@@ -103,41 +103,41 @@
this.index = 0;
}
/**
- * Constructs an effectively empty <code>SpinnerListModel</code>.
+ * Constructs an effectively empty {@code SpinnerListModel}.
* The model's list will contain a single
- * <code>"empty"</code> string element.
+ * {@code "empty"} string element.
*/
public SpinnerListModel() {
this(new Object[]{"empty"});
}
/**
- * Returns the <code>List</code> that defines the sequence for this model.
+ * Returns the {@code List} that defines the sequence for this model.
*
- * @return the value of the <code>list</code> property
+ * @return the value of the {@code list} property
* @see #setList
*/
public List<?> getList() {
return list;
}
/**
* Changes the list that defines this sequence and resets the index
- * of the models <code>value</code> to zero. Note that <code>list</code>
+ * of the models {@code value} to zero. Note that {@code list}
* is not copied, the model just stores a reference to it.
* <p>
- * This method fires a <code>ChangeEvent</code> if <code>list</code> is
+ * This method fires a {@code ChangeEvent} if {@code list} is
* not equal to the current list.
*
* @param list the sequence that this model represents
- * @throws IllegalArgumentException if <code>list</code> is
- * <code>null</code> or zero length
+ * @throws IllegalArgumentException if {@code list} is
+ * {@code null} or zero length
* @see #getList
*/
public void setList(List<?> list) {
if ((list == null) || (list.size() == 0)) {
throw new IllegalArgumentException("invalid list");
@@ -151,25 +151,25 @@
/**
* Returns the current element of the sequence.
*
- * @return the <code>value</code> property
+ * @return the {@code value} property
* @see SpinnerModel#getValue
* @see #setValue
*/
public Object getValue() {
return list.get(index);
}
/**
* Changes the current element of the sequence and notifies
- * <code>ChangeListeners</code>. If the specified
+ * {@code ChangeListeners}. If the specified
* value is not equal to an element of the underlying sequence
- * then an <code>IllegalArgumentException</code> is thrown.
- * In the following example the <code>setValue</code> call
+ * then an {@code IllegalArgumentException} is thrown.
+ * In the following example the {@code setValue} call
* would cause an exception to be thrown:
* <pre>
* String[] values = {"one", "two", "free", "four"};
* SpinnerModel model = new SpinnerListModel(values);
* model.setValue("TWO");
@@ -192,38 +192,38 @@
}
/**
* Returns the next legal value of the underlying sequence or
- * <code>null</code> if value is already the last element.
+ * {@code null} if value is already the last element.
*
* @return the next legal value of the underlying sequence or
- * <code>null</code> if value is already the last element
+ * {@code null} if value is already the last element
* @see SpinnerModel#getNextValue
* @see #getPreviousValue
*/
public Object getNextValue() {
return (index >= (list.size() - 1)) ? null : list.get(index + 1);
}
/**
* Returns the previous element of the underlying sequence or
- * <code>null</code> if value is already the first element.
+ * {@code null} if value is already the first element.
*
* @return the previous element of the underlying sequence or
- * <code>null</code> if value is already the first element
+ * {@code null} if value is already the first element
* @see SpinnerModel#getPreviousValue
* @see #getNextValue
*/
public Object getPreviousValue() {
return (index <= 0) ? null : list.get(index - 1);
}
/**
- * Returns the next object that starts with <code>substring</code>.
+ * Returns the next object that starts with {@code substring}.
*
* @param substring the string to be matched
* @return the match
*/
Object findNextMatch(String substring) {
< prev index next >