| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public class Vector extends AbstractList implements List, RandomAccess, Cloneable, Serializable
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 Vector'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 Vector's 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 {@link List} interface, making it a member of the Java Collections Framework. Unlike the new collection implementations, {@code Vector} is synchronized.
Field Summary | |
---|---|
protected int |
capacityIncrement
The amount by which the capacity of the vector is automatically incremented when its size becomes greater than its capacity. |
protected int |
elementCount
The number of valid components in this object. |
protected Object[] |
elementData
The array buffer into which the components of the vector are stored. |
Fields inherited from class java.util.AbstractList |
---|
modCount |
Constructor Summary | |
---|---|
Vector() Constructs an empty vector so that its internal data array has size and its standard capacity increment is zero. |
|
Vector(Collection c) Constructs a vector containing the elements of the specified collection, in the order they are returned by the collection's iterator. |
|
Vector(int initialCapacity) Constructs an empty vector with the specified initial capacity and with its capacity increment equal to zero. |
|
Vector(int initialCapacity, int capacityIncrement) Constructs an empty vector with the specified initial capacity and capacity increment. |
Method Summary | |
---|---|
boolean |
Appends the specified element to the end of this Vector. |
void |
Inserts the specified element at the specified position in this Vector. |
boolean |
addAll(Collection 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. |
boolean |
addAll(int index, Collection c) Inserts all of the elements in the specified Collection into this Vector at the specified position. |
void |
addElement(Object obj) Adds the specified component to the end of this vector, increasing its size by one. |
int |
capacity() Returns the current capacity of this vector. |
void |
clear() Removes all of the elements from this Vector. |
Object |
clone() Returns a clone of this vector. |
boolean |
Returns if this vector contains the specified element. |
boolean |
Returns true if this Vector contains all of the elements in the specified Collection. |
void |
Copies the components of this vector into the specified array. |
Object |
elementAt(int index) Returns the component at the specified index. |
Enumeration |
elements() Returns an enumeration of the components of this vector. |
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. |
boolean |
Compares the specified Object with this Vector for equality. |
Object |
Returns the first component (the item at index ) of this vector. |
Object |
get(int index) Returns the element at the specified position in this Vector. |
int |
hashCode() Returns the hash code value for this Vector. |
int |
Returns the index of the first occurrence of the specified element in this vector, or -1 if this vector does not contain the element. |
int |
Returns the index of the first occurrence of the specified element in this vector, searching forwards from , or returns -1 if the element is not found. |
void |
insertElementAt(Object obj, int index) Inserts the specified object as a component in this vector at the specified . |
boolean |
isEmpty() Tests if this vector has no components. |
Object |
Returns the last component of the vector. |
int |
Returns the index of the last occurrence of the specified element in this vector, or -1 if this vector does not contain the element. |
int |
lastIndexOf(Object o, int index) Returns the index of the last occurrence of the specified element in this vector, searching backwards from , or returns -1 if the element is not found. |
Object |
remove(int index) Removes the element at the specified position in this Vector. |
boolean |
Removes the first occurrence of the specified element in this Vector If the Vector does not contain the element, it is unchanged. |
boolean |
Removes from this Vector all of its elements that are contained in the specified Collection. |
void |
Removes all components from this vector and sets its size to zero. |
boolean |
removeElement(Object obj) Removes the first (lowest-indexed) occurrence of the argument from this vector. |
void |
removeElementAt(int index) Deletes the component at the specified index. |
protected void |
removeRange(int fromIndex, int toIndex) Removes from this List all of the elements whose index is between fromIndex, inclusive and toIndex, exclusive. |
boolean |
Retains only the elements in this Vector that are contained in the specified Collection. |
Object |
Replaces the element at the specified position in this Vector with the specified element. |
void |
setElementAt(Object obj, int index) Sets the component at the specified of this vector to be the specified object. |
void |
setSize(int newSize) Sets the size of this vector. |
int |
size() Returns the number of components in this vector. |
List |
subList(int fromIndex, int toIndex) Returns a view of the portion of this List between fromIndex, inclusive, and toIndex, exclusive. |
Object[] |
toArray() Returns an array containing all of the elements in this Vector in the correct order. |
Object[] |
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. |
String |
toString() Returns a string representation of this Vector, containing the String representation of each element. |
void |
Trims the capacity of this vector to be the vector's current size. |
Methods inherited from class java.util.AbstractList |
---|
add, add, addAll, clear, equals, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList |
Methods inherited from class java.util.AbstractCollection |
---|
add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected int capacityIncrement
protected int elementCount
protected Object[] elementData
Any array elements following the last element in the Vector are null.
Constructor Detail |
---|
public Vector()
public Vector(Collection c)
c
- the collection whose elements are to be placed into this
vectorpublic Vector(int initialCapacity)
initialCapacity
- the initial capacity of the vectorpublic Vector(int initialCapacity, int capacityIncrement)
initialCapacity
- the initial capacity of the vectorcapacityIncrement
- the amount by which the capacity is
increased when the vector overflowsMethod Detail |
---|
public synchronized boolean add(Object e)
add
in class AbstractList
e
- element to be appended to this Vectorpublic void add(int index, Object element)
add
in class AbstractList
index
- index at which the specified element is to be insertedelement
- element to be insertedpublic synchronized boolean addAll(Collection c)
addAll
in class AbstractCollection
c
- elements to be inserted into this Vectorpublic synchronized boolean addAll(int index, Collection c)
addAll
in class AbstractList
index
- index at which to insert the first element from the
specified collectionc
- elements to be inserted into this Vectorpublic synchronized void addElement(Object obj)
This method is identical in functionality to the {@link #add(Object) add(E)} method (which is part of the {@link List} interface).
obj
- the component to be addedpublic synchronized int capacity()
public void clear()
clear
in class AbstractList
public synchronized Object clone()
clone
in class Object
public boolean contains(Object o)
contains
in class AbstractCollection
o
- element whose presence in this vector is to be testedpublic synchronized boolean containsAll(Collection c)
containsAll
in class AbstractCollection
c
- a collection whose elements will be tested for containment
in this Vectorpublic synchronized void copyInto(Object[] anArray)
anArray
- the array into which the components get copiedpublic synchronized Object elementAt(int index)
This method is identical in functionality to the {@link #get(int)} method (which is part of the {@link List} interface).
index
- an index into this vectorpublic Enumeration elements()
public synchronized void ensureCapacity(int minCapacity)
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}.
minCapacity
- the desired minimum capacitypublic synchronized boolean equals(Object o)
equals
in class AbstractList
o
- the Object to be compared for equality with this Vectorpublic synchronized Object firstElement()
public synchronized Object get(int index)
get
in class AbstractList
index
- index of the element to returnpublic synchronized int hashCode()
hashCode
in class AbstractList
public int indexOf(Object o)
indexOf
in class AbstractList
o
- element to search forpublic synchronized int indexOf(Object o, int index)
o
- element to search forindex
- index to start searching frompublic synchronized void insertElementAt(Object obj, int index)
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 {@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.
obj
- the component to insertindex
- where to insert the new componentpublic synchronized boolean isEmpty()
isEmpty
in class AbstractCollection
public synchronized Object lastElement()
size() - 1
.public synchronized int lastIndexOf(Object o)
lastIndexOf
in class AbstractList
o
- element to search forpublic synchronized int lastIndexOf(Object o, int index)
o
- element to search forindex
- index to start searching backwards frompublic synchronized Object remove(int index)
remove
in class AbstractList
index
- the index of the element to be removedpublic boolean remove(Object o)
remove
in class AbstractCollection
o
- element to be removed from this Vector, if presentpublic synchronized boolean removeAll(Collection c)
removeAll
in class AbstractCollection
c
- a collection of elements to be removed from the Vectorpublic synchronized void removeAllElements()
This method is identical in functionality to the {@link #clear} method (which is part of the {@link List} interface).
public synchronized boolean removeElement(Object obj)
This method is identical in functionality to the {@link #remove(Object)} method (which is part of the {@link List} interface).
obj
- the component to be removedpublic synchronized void removeElementAt(int index)
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 {@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.
index
- the index of the object to removeprotected synchronized void removeRange(int fromIndex, int toIndex)
removeRange
in class AbstractList
fromIndex
- index of first element to be removedtoIndex
- index after last element to be removedpublic synchronized boolean retainAll(Collection c)
retainAll
in class AbstractCollection
c
- a collection of elements to be retained in this Vector
(all other elements are removed)public synchronized Object set(int index, Object element)
set
in class AbstractList
index
- index of the element to replaceelement
- element to be stored at the specified positionpublic synchronized void setElementAt(Object obj, int index)
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 {@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.
obj
- what the component is to be set toindex
- the specified indexpublic synchronized void setSize(int newSize)
newSize
- the new size of this vectorpublic synchronized int size()
size
in class AbstractCollection
public synchronized List subList(int fromIndex, int toIndex)
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.)
subList
in class AbstractList
fromIndex
- low endpoint (inclusive) of the subListtoIndex
- high endpoint (exclusive) of the subListpublic synchronized Object[] toArray()
toArray
in class AbstractCollection
public synchronized Object[] toArray(Object[] a)
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.)
toArray
in class AbstractCollection
a
- the array into which the elements of the Vector are to
be stored, if it is big enough; otherwise, a new array of the
same runtime type is allocated for this purpose.public synchronized String toString()
toString
in class AbstractCollection
public synchronized void trimToSize()
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |