Save This Page
Home » openjdk-7 » java » util » [javadoc | source]
java.util
public class: Vector [javadoc | source]
java.lang.Object
   java.util.AbstractCollection<E>
      java.util.AbstractList<E>
         java.util.Vector

All Implemented Interfaces:
    Cloneable, List, Serializable, RandomAccess, Collection

Direct Known Subclasses:
    Stack, LinkVector, DConnector

The {@code Vector} class implements a growable array of objects. Like an array, it contains components that can be accessed using an integer index. However, the size of a {@code Vector} can grow or shrink as needed to accommodate adding and removing items after the {@code Vector} has been created.

Each vector tries to optimize storage management by maintaining a {@code capacity} and a {@code capacityIncrement}. The {@code capacity} is always at least as large as the vector size; it is usually larger because as components are added to the vector, the vector's storage increases in chunks the size of {@code capacityIncrement}. An application can increase the capacity of a vector before inserting a large number of components; this reduces the amount of incremental reallocation.

The iterators returned by this class's iterator and listIterator methods are fail-fast: if the vector is structurally modified at any time after the iterator is created, in any way except through the iterator's own remove or add methods, the iterator will throw a ConcurrentModificationException . Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future. The Enumerations returned by the elements method are not fail-fast.

Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw {@code ConcurrentModificationException} on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect bugs.

As of the Java 2 platform v1.2, this class was retrofitted to implement the List interface, making it a member of the Java Collections Framework. Unlike the new collection implementations, {@code Vector} is synchronized. If a thread-safe implementation is not needed, it is recommended to use ArrayList in place of {@code Vector}.

Nested Class Summary:
final class  Vector.ListItr  An optimized version of AbstractList.ListItr 
Field Summary
protected  Object[] elementData    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.

Any array elements following the last element in the Vector are null.

    serial:
 
protected  int elementCount    The number of valid components in this {@code Vector} object. Components {@code elementData[0]} through {@code elementData[elementCount-1]} are the actual items.
    serial:
 
protected  int capacityIncrement    The amount by which the capacity of the vector is automatically incremented when its size becomes greater than its capacity. If the capacity increment is less than or equal to zero, the capacity of the vector is doubled each time it needs to grow.
    serial:
 
Fields inherited from java.util.AbstractList:
modCount
Constructor:
 public Vector() 
 public Vector(int initialCapacity) 
 public Vector(Collection<? extends E> c) 
    Constructs a vector containing the elements of the specified collection, in the order they are returned by the collection's iterator.
    Parameters:
    c - the collection whose elements are to be placed into this vector
    Throws:
    NullPointerException - if the specified collection is null
    since: 1.2 -
 public Vector(int initialCapacity,
    int capacityIncrement) 
Method from java.util.Vector Summary:
add,   add,   addAll,   addAll,   addElement,   capacity,   clear,   clone,   contains,   containsAll,   copyInto,   elementAt,   elementData,   elements,   ensureCapacity,   equals,   firstElement,   get,   hashCode,   indexOf,   indexOf,   insertElementAt,   isEmpty,   iterator,   lastElement,   lastIndexOf,   lastIndexOf,   listIterator,   listIterator,   remove,   remove,   removeAll,   removeAllElements,   removeElement,   removeElementAt,   removeRange,   retainAll,   set,   setElementAt,   setSize,   size,   subList,   toArray,   toArray,   toString,   trimToSize
Methods from java.util.AbstractList:
add,   add,   addAll,   clear,   equals,   get,   hashCode,   indexOf,   iterator,   lastIndexOf,   listIterator,   listIterator,   remove,   removeRange,   set,   subList
Methods from java.util.AbstractCollection:
add,   addAll,   clear,   contains,   containsAll,   isEmpty,   iterator,   remove,   removeAll,   retainAll,   size,   toArray,   toArray,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.util.Vector Detail:
 public synchronized boolean add(E e) 
    Appends the specified element to the end of this Vector.
 public  void add(int index,
    E element) 
    Inserts the specified element at the specified position in this Vector. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
 public synchronized boolean addAll(Collection<? extends E> c) 
    Appends all of the elements in the specified Collection to the end of this Vector, in the order that they are returned by the specified Collection's Iterator. The behavior of this operation is undefined if the specified Collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified Collection is this Vector, and this Vector is nonempty.)
 public synchronized boolean addAll(int index,
    Collection<? extends E> c) 
    Inserts all of the elements in the specified Collection into this Vector at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the Vector in the order that they are returned by the specified Collection's iterator.
 public synchronized  void addElement(E obj) 
    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.

    This method is identical in functionality to the add(E) method (which is part of the List interface).

 public synchronized int capacity() 
    Returns the current capacity of this vector.
 public  void clear() 
    Removes all of the elements from this Vector. The Vector will be empty after this call returns (unless it throws an exception).
 public synchronized Object clone() 
    Returns a clone of this vector. The copy will contain a reference to a clone of the internal data array, not a reference to the original internal data array of this {@code Vector} object.
 public boolean contains(Object o) 
    Returns {@code true} if this vector contains the specified element. More formally, returns {@code true} if and only if this vector contains at least one element {@code e} such that (o==null ? e==null : o.equals(e)).
 public synchronized boolean containsAll(Collection<?> c) 
    Returns true if this Vector contains all of the elements in the specified Collection.
 public synchronized  void copyInto(Object[] anArray) 
    Copies the components of this vector into the specified array. The item at index {@code k} in this vector is copied into component {@code k} of {@code anArray}.
 public synchronized E elementAt(int index) 
    Returns the component at the specified index.

    This method is identical in functionality to the #get(int) method (which is part of the List interface).

 E elementData(int index) 
 public Enumeration<E> elements() 
    Returns an enumeration of the components of this vector. The returned {@code Enumeration} object will generate all items in this vector. The first item generated is the item at index {@code 0}, then the item at index {@code 1}, and so on.
 public synchronized  void ensureCapacity(int minCapacity) 
    Increases the capacity of this vector, if necessary, to ensure that it can hold at least the number of components specified by the minimum capacity argument.

    If the current capacity of this vector is less than {@code minCapacity}, then its capacity is increased by replacing its internal data array, kept in the field {@code elementData}, with a larger one. The size of the new data array will be the old size plus {@code capacityIncrement}, unless the value of {@code capacityIncrement} is less than or equal to zero, in which case the new capacity will be twice the old capacity; but if this new size is still smaller than {@code minCapacity}, then the new capacity will be {@code minCapacity}.

 public synchronized boolean equals(Object o) 
    Compares the specified Object with this Vector for equality. Returns true if and only if the specified Object is also a List, both Lists have the same size, and all corresponding pairs of elements in the two Lists are equal. (Two elements {@code e1} and {@code e2} are equal if {@code (e1==null ? e2==null : e1.equals(e2))}.) In other words, two Lists are defined to be equal if they contain the same elements in the same order.
 public synchronized E firstElement() 
    Returns the first component (the item at index {@code 0}) of this vector.
 public synchronized E get(int index) 
    Returns the element at the specified position in this Vector.
 public synchronized int hashCode() 
    Returns the hash code value for this Vector.
 public int indexOf(Object o) 
    Returns the index of the first occurrence of the specified element in this vector, or -1 if this vector does not contain the element. More formally, returns the lowest index {@code i} such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
 public synchronized int indexOf(Object o,
    int index) 
    Returns the index of the first occurrence of the specified element in this vector, searching forwards from {@code index}, or returns -1 if the element is not found. More formally, returns the lowest index {@code i} such that (i >= index && (o==null ? get(i)==null : o.equals(get(i)))), or -1 if there is no such index.
 public synchronized  void insertElementAt(E obj,
    int index) 
    Inserts the specified object as a component in this vector at the 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.

    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.)

    This method is identical in functionality to the add(int, E) method (which is part of the List interface). Note that the {@code add} method reverses the order of the parameters, to more closely match array usage.

 public synchronized boolean isEmpty() 
    Tests if this vector has no components.
 public synchronized Iterator<E> iterator() 
    Returns an iterator over the elements in this list in proper sequence.

    The returned iterator is fail-fast.

 public synchronized E lastElement() 
    Returns the last component of the vector.
 public synchronized int lastIndexOf(Object o) 
    Returns the index of the last occurrence of the specified element in this vector, or -1 if this vector does not contain the element. More formally, returns the highest index {@code i} such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
 public synchronized int lastIndexOf(Object o,
    int index) 
    Returns the index of the last occurrence of the specified element in this vector, searching backwards from {@code index}, or returns -1 if the element is not found. More formally, returns the highest index {@code i} such that (i <= index && (o==null ? get(i)==null : o.equals(get(i)))), or -1 if there is no such index.
 public synchronized ListIterator<E> listIterator() 
    Returns a list iterator over the elements in this list (in proper sequence).

    The returned list iterator is fail-fast.

 public synchronized ListIterator<E> listIterator(int index) 
    Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first element that would be returned by an initial call to next . An initial call to previous would return the element with the specified index minus one.

    The returned list iterator is fail-fast.

 public boolean remove(Object o) 
    Removes the first occurrence of the specified element in this Vector If the Vector does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that {@code (o==null ? get(i)==null : o.equals(get(i)))} (if such an element exists).
 public synchronized E remove(int index) 
    Removes the element at the specified position in this Vector. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the Vector.
 public synchronized boolean removeAll(Collection<?> c) 
    Removes from this Vector all of its elements that are contained in the specified Collection.
 public synchronized  void removeAllElements() 
    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).

 public synchronized boolean removeElement(Object obj) 
    Removes the first (lowest-indexed) occurrence of the argument 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.

    This method is identical in functionality to the #remove(Object) method (which is part of the List interface).

 public synchronized  void removeElementAt(int index) 
    Deletes the component at the specified index. Each component in 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}.

    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(int) method (which is part of the List interface). Note that the {@code remove} method returns the old value that was stored at the specified position.

 protected synchronized  void removeRange(int fromIndex,
    int toIndex) 
    Removes from this list all of the elements whose index is between {@code fromIndex}, inclusive, and {@code toIndex}, exclusive. Shifts any succeeding elements to the left (reduces their index). This call shortens the list by {@code (toIndex - fromIndex)} elements. (If {@code toIndex==fromIndex}, this operation has no effect.)
 public synchronized boolean retainAll(Collection<?> c) 
    Retains only the elements in this Vector that are contained in the specified Collection. In other words, removes from this Vector all of its elements that are not contained in the specified Collection.
 public synchronized E set(int index,
    E element) 
    Replaces the element at the specified position in this Vector with the specified element.
 public synchronized  void setElementAt(E obj,
    int index) 
    Sets the component at the specified {@code index} of this vector to be the specified object. The previous component at that 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.

    This method is identical in functionality to the set(int, E) method (which is part of the 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.

 public synchronized  void setSize(int newSize) 
    Sets the size of this vector. If the new size is greater than the current size, new {@code null} items are added to the end of the vector. If the new size is less than the current size, all components at index {@code newSize} and greater are discarded.
 public synchronized int size() 
    Returns the number of components in this vector.
 public synchronized List<E> subList(int fromIndex,
    int toIndex) 
    Returns a view of the portion of this List between fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are 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.

    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 removes a range of elements from a List:

         list.subList(from, to).clear();
    
    Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList.

    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 a fashion that iterations in progress may yield incorrect results.)

 public synchronized Object[] toArray() 
    Returns an array containing all of the elements in this Vector in the correct order.
 public synchronized T[] toArray(T[] a) 
    Returns an array containing all of the elements in this Vector in the 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.

    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 of the Vector only if the caller knows that the Vector does not contain any null elements.)

 public synchronized String toString() 
    Returns a string representation of this Vector, containing the String representation of each element.
 public synchronized  void trimToSize() 
    Trims the capacity of this vector to be the vector's current size. If the capacity of this vector is larger than its current size, then the capacity is changed to equal the size by replacing its internal data array, kept in the field {@code elementData}, with a smaller one. An application can use this operation to minimize the storage of a vector.