--- jsr166/src/main/java/util/Vector.java 2006/06/25 19:41:52 1.14 +++ jsr166/src/main/java/util/Vector.java 2006/06/26 00:17:48 1.17 @@ -63,9 +63,9 @@ public class Vector /** * The array buffer into which the components of the vector are * stored. The capacity of the vector is the length of this array buffer, - * and is at least large enough to contain all the vector's elements.

+ * and is at least large enough to contain all the vector's elements. * - * Any array elements following the last element in the Vector are null. + *

Any array elements following the last element in the Vector are null. * * @serial */ @@ -100,8 +100,8 @@ public class Vector * @param initialCapacity the initial capacity of the vector * @param capacityIncrement the amount by which the capacity is * increased when the vector overflows - * @exception IllegalArgumentException if the specified initial capacity - * is negative + * @throws IllegalArgumentException if the specified initial capacity + * is negative */ public Vector(int initialCapacity, int capacityIncrement) { super(); @@ -117,8 +117,8 @@ public class Vector * with its capacity increment equal to zero. * * @param initialCapacity the initial capacity of the vector - * @exception IllegalArgumentException if the specified initial capacity - * is negative + * @throws IllegalArgumentException if the specified initial capacity + * is negative */ public Vector(int initialCapacity) { this(initialCapacity, 0); @@ -212,7 +212,7 @@ public class Vector * method for ensuring capacity without incurring the cost of an * extra synchronization. * - * @see java.util.Vector#ensureCapacity(int) + * @see #ensureCapacity(int) */ private void ensureCapacityHelper(int minCapacity) { int oldCapacity = elementData.length; @@ -233,8 +233,8 @@ public class Vector * the vector. If the new size is less than the current size, all * components at index {@code newSize} and greater are discarded. * - * @param newSize the new size of this vector - * @throws ArrayIndexOutOfBoundsException if new size is negative + * @param newSize the new size of this vector + * @throws ArrayIndexOutOfBoundsException if the new size is negative */ public synchronized void setSize(int newSize) { modCount++; @@ -286,7 +286,6 @@ public class Vector * then the item at index {@code 1}, and so on. * * @return an enumeration of the components of this vector - * @see Enumeration * @see Iterator */ public Enumeration elements() { @@ -413,18 +412,15 @@ public class Vector } /** - * Returns the component at the specified index.

+ * Returns the component at the specified index. * - * This method is identical in functionality to the get method - * (which is part of the List interface). + *

This method is identical in functionality to the {@link #get(int)} + * method (which is part of the {@link List} interface). * * @param index an index into this vector * @return the component at the specified index - * @exception ArrayIndexOutOfBoundsException if the {@code index} - * is negative or not less than the current size of this - * {@code Vector} object. - * @see #get(int) - * @see List + * @throws ArrayIndexOutOfBoundsException if the index is out of range + * ({@code index < 0 || index >= size()}) */ public synchronized E elementAt(int index) { if (index >= elementCount) { @@ -439,7 +435,7 @@ public class Vector * this vector. * * @return the first component of this vector - * @exception NoSuchElementException if this vector has no components + * @throws NoSuchElementException if this vector has no components */ public synchronized E firstElement() { if (elementCount == 0) { @@ -453,7 +449,7 @@ public class Vector * * @return the last component of the vector, i.e., the component at index * size() - 1. - * @exception NoSuchElementException if this vector is empty + * @throws NoSuchElementException if this vector is empty */ public synchronized E lastElement() { if (elementCount == 0) { @@ -465,23 +461,22 @@ public class Vector /** * Sets the component at the specified {@code index} of this * vector to be the specified object. The previous component at that - * position is discarded.

+ * position is discarded. * - * The index must be a value greater than or equal to {@code 0} - * and less than the current size of the vector.

+ *

The index must be a value greater than or equal to {@code 0} + * and less than the current size of the vector. * - * This method is identical in functionality to the set method - * (which is part of the List interface). Note that the set method reverses - * the order of the parameters, to more closely match array usage. Note - * also that the set method returns the old value that was stored at the - * specified position. + *

This method is identical in functionality to the + * {@link #set(int, Object) set(int, E)} + * method (which is part of the {@link List} interface). Note that the + * {@code set} method reverses the order of the parameters, to more closely + * match array usage. Note also that the {@code set} method returns the + * old value that was stored at the specified position. * * @param obj what the component is to be set to * @param index the specified index - * @exception ArrayIndexOutOfBoundsException if the index was invalid - * @see #size() - * @see List - * @see #set(int, java.lang.Object) + * @throws ArrayIndexOutOfBoundsException if the index is out of range + * ({@code index < 0 || index >= size()}) */ public synchronized void setElementAt(E obj, int index) { if (index >= elementCount) { @@ -496,20 +491,19 @@ public class Vector * this vector with an index greater or equal to the specified * {@code index} is shifted downward to have an index one * smaller than the value it had previously. The size of this vector - * is decreased by {@code 1}.

+ * is decreased by {@code 1}. * - * The index must be a value greater than or equal to {@code 0} - * and less than the current size of the vector.

+ *

The index must be a value greater than or equal to {@code 0} + * and less than the current size of the vector. * - * This method is identical in functionality to the remove method - * (which is part of the List interface). Note that the remove method - * returns the old value that was stored at the specified position. + *

This method is identical in functionality to the {@link #remove(int)} + * method (which is part of the {@link List} interface). Note that the + * {@code remove} method returns the old value that was stored at the + * specified position. * * @param index the index of the object to remove - * @exception ArrayIndexOutOfBoundsException if the index was invalid - * @see #size() - * @see #remove(int) - * @see List + * @throws ArrayIndexOutOfBoundsException if the index is out of range + * ({@code index < 0 || index >= size()}) */ public synchronized void removeElementAt(int index) { modCount++; @@ -533,23 +527,23 @@ public class Vector * specified {@code index}. Each component in this vector with * an index greater or equal to the specified {@code index} is * shifted upward to have an index one greater than the value it had - * previously.

+ * previously. * - * The index must be a value greater than or equal to {@code 0} + *

The index must be a value greater than or equal to {@code 0} * and less than or equal to the current size of the vector. (If the * index is equal to the current size of the vector, the new element - * is appended to the Vector.)

+ * is appended to the Vector.) * - * This method is identical in functionality to the add(Object, int) method - * (which is part of the List interface). Note that the add method reverses - * the order of the parameters, to more closely match array usage. + *

This method is identical in functionality to the + * {@link #add(int, Object) add(int, E)} + * method (which is part of the {@link List} interface). Note that the + * {@code add} method reverses the order of the parameters, to more closely + * match array usage. * * @param obj the component to insert * @param index where to insert the new component - * @exception ArrayIndexOutOfBoundsException if the index was invalid - * @see #size() - * @see #add(int, Object) - * @see List + * @throws ArrayIndexOutOfBoundsException if the index is out of range + * ({@code index < 0 || index > size()}) */ public synchronized void insertElementAt(E obj, int index) { modCount++; @@ -566,14 +560,13 @@ public class Vector /** * Adds the specified component to the end of this vector, * increasing its size by one. The capacity of this vector is - * increased if its size becomes greater than its capacity.

+ * increased if its size becomes greater than its capacity. * - * This method is identical in functionality to the add(Object) method - * (which is part of the List interface). + *

This method is identical in functionality to the + * {@link #remove(Object)} method (which is part of the + * {@link List} interface). * * @param obj the component to be added - * @see #add(Object) - * @see List */ public synchronized void addElement(E obj) { modCount++; @@ -586,9 +579,9 @@ public class Vector * from this vector. If the object is found in this vector, each * component in the vector with an index greater or equal to the * object's index is shifted downward to have an index one smaller - * than the value it had previously.

+ * than the value it had previously. * - * This method is identical in functionality to the remove(Object) + *

This method is identical in functionality to the remove(Object) * method (which is part of the List interface). * * @param obj the component to be removed @@ -608,13 +601,10 @@ public class Vector } /** - * Removes all components from this vector and sets its size to zero.

- * - * This method is identical in functionality to the clear method - * (which is part of the List interface). + * Removes all components from this vector and sets its size to zero. * - * @see #clear - * @see List + *

This method is identical in functionality to the {@link #clear} + * method (which is part of the {@link List} interface). */ public synchronized void removeAllElements() { modCount++; @@ -659,9 +649,9 @@ public class Vector * correct order; the runtime type of the returned array is that of the * specified array. If the Vector fits in the specified array, it is * returned therein. Otherwise, a new array is allocated with the runtime - * type of the specified array and the size of this Vector.

+ * type of the specified array and the size of this Vector. * - * If the Vector fits in the specified array with room to spare + *

If the Vector fits in the specified array with room to spare * (i.e., the array has more elements than the Vector), * the element in the array immediately following the end of the * Vector is set to null. (This is useful in determining the length @@ -672,7 +662,7 @@ public class Vector * be stored, if it is big enough; otherwise, a new array of the * same runtime type is allocated for this purpose. * @return an array containing the elements of the Vector - * @exception ArrayStoreException the runtime type of a is not a supertype + * @throws ArrayStoreException if the runtime type of a is not a supertype * of the runtime type of every element in this Vector * @throws NullPointerException if the given array is null * @since 1.2 @@ -696,8 +686,8 @@ public class Vector * * @param index index of the element to return * @return object at the specified index - * @exception ArrayIndexOutOfBoundsException index is out of range (index - * < 0 || index >= size()) + * @throws ArrayIndexOutOfBoundsException if the index is out of range + * ({@code index < 0 || index >= size()}) * @since 1.2 */ public synchronized E get(int index) { @@ -714,8 +704,8 @@ public class Vector * @param index index of the element to replace * @param element element to be stored at the specified position * @return the element previously at the specified position - * @exception ArrayIndexOutOfBoundsException index out of range - * (index < 0 || index >= size()) + * @throws ArrayIndexOutOfBoundsException if the index is out of range + * ({@code index < 0 || index >= size()}) * @since 1.2 */ public synchronized E set(int index, E element) { @@ -763,8 +753,8 @@ public class Vector * * @param index index at which the specified element is to be inserted * @param element element to be inserted - * @exception ArrayIndexOutOfBoundsException index is out of range - * (index < 0 || index > size()) + * @throws ArrayIndexOutOfBoundsException if the index is out of range + * ({@code index < 0 || index > size()}) * @since 1.2 */ public void add(int index, E element) { @@ -1149,9 +1139,9 @@ public class Vector * equal, the returned List is empty.) The returned List is backed by this * List, so changes in the returned List are reflected in this List, and * vice-versa. The returned List supports all of the optional List - * operations supported by this List.

+ * operations supported by this List. * - * This method eliminates the need for explicit range operations (of + *

This method eliminates the need for explicit range operations (of * the sort that commonly exist for arrays). Any operation that expects * a List can be used as a range operation by operating on a subList view * instead of a whole List. For example, the following idiom @@ -1161,9 +1151,9 @@ public class Vector * * Similar idioms may be constructed for indexOf and lastIndexOf, * and all of the algorithms in the Collections class can be applied to - * a subList.

+ * a subList. * - * The semantics of the List returned by this method become undefined if + *

The semantics of the List returned by this method become undefined if * the backing list (i.e., this List) is structurally modified in * any way other than via the returned List. (Structural modifications are * those that change the size of the List, or otherwise perturb it in such