Vector (JanosRuntime JavaDOC)

java.lang.Object
- java.util.Vector<E>

Type Parameters:

E - Entry type

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

Stack
```
public class Vector<E>
extends Object
implements Cloneable
```
The 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 Vector can grow or shrink as needed to accommodate adding and removing items after the Vector has been created.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`capacityIncrement` When the `Vector` needs to grow its size is increased by this amount.
`protected int`	`elementCount` The number of elements stored.
`protected Object[]`	`elementData` Array buffer into which elements are stored.

Constructor Summary

Constructors
Constructor and Description
`Vector()` Constructs an empty vector with the specified initial capacity set to 6 and with its capacity increment equal to zero.
`Vector(int initcap)` Constructs an empty vector with the specified initial capacity and with its capacity increment equal to zero.
`Vector(int initcap, int capinc)` Constructs an empty vector with the specified initial capacity and capacity increment.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addElement(E obj)` Adds an element to the end of the vector increasing its size by 1.
`int`	`capacity()` Returns the capacity of the vector (not the count of elements that are stored within it).
`Object`	`clone()` Returns a clone of this vector.
`boolean`	`contains(E obj)` Returns `true` if this vector contains the specified element.
`void`	`copyInto(Object[] aobj)` Copies the components of this vector into the specified array.
`E`	`elementAt(int index)` Returns the element at the specified index.
`Enumeration<E>`	`elements()` Returns an enumeration of the components of this vector.
`void`	`ensureCapacity(int mincap)` 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.
`E`	`firstElement()` Returns the first component (the item at index `0`) of this vector.
`int`	`indexOf(Object obj)` 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`	`indexOf(Object obj, int index)` Returns the index of the first occurrence of the specified element in this vector, searching forwards from `index`, or returns -1 if the element is not found.
`void`	`insertElementAt(E obj, int index)` Inserts the specified object as a component in this vector at the specified `index`.
`boolean`	`isEmpty()` Tests if this vector has no elements.
`E`	`lastElement()` Returns the last element in the vector.
`int`	`lastIndexOf(Object obj)` 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 obj, int index)` Returns the index of the last occurrence of the specified element in this vector, searching backwards from `index`, or returns -1 if the element is not found.
`void`	`removeAllElements()` Removes all elements 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.
`void`	`setElementAt(E obj, int index)` Sets the element at the specified `index` of this vector to be the specified object.
`void`	`setSize(int size)` Sets the size of this vector.
`int`	`size()` Returns the number of components in this vector.
`String`	`toString()` Returns a string representation of this Vector, containing the String representation of each element.
`void`	`trimToSize()` Trims the capacity of this vector to be the vector's current size.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - elementData
```
protected Object[] elementData
```
    Array buffer into which elements are stored.
  - elementCount
```
protected int elementCount
```
    The number of elements stored.
  - capacityIncrement
```
protected int capacityIncrement
```
    When the Vector needs to grow its size is increased by this amount.
- Constructor Detail
  - Vector
```
public Vector()
```
    Constructs an empty vector with the specified initial capacity set to 6 and with its capacity increment equal to zero.
  - Vector
```
public Vector(int initcap)
```
    Constructs an empty vector with the specified initial capacity and with its capacity increment equal to zero.
    
    Parameters:
    
    initcap - initial capacity
  - Vector
```
public Vector(int initcap,
              int capinc)
```
    Constructs an empty vector with the specified initial capacity and capacity increment.
    
    Parameters:
    
    initcap - initial capacity?
    
    capinc - capacity increment
- Method Detail
  - addElement
```
public void addElement(E obj)
```
    Adds an element to the end of the vector increasing its size by 1.
    
    Parameters:
    
    obj - an object to be added
  - capacity
```
public int capacity()
```
    Returns the capacity of the vector (not the count of elements that are stored within it).
    
    Returns:
    
    capacity
  - clone
```
public 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 Vector object.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a clone of this vector
    
    See Also:
    
    Cloneable
  - contains
```
public boolean contains(E obj)
```
    Returns true if this vector contains the specified element.
    
    Parameters:
    
    obj - element whose presence is to be tested
    
    Returns:
    
    true if this contains the element
  - copyInto
```
public void copyInto(Object[] aobj)
```
    Copies the components of this vector into the specified array.
    
    Parameters:
    
    aobj - the array receiving the elements
  - elementAt
```
public E elementAt(int index)
```
    Returns the element at the specified index.
    
    Parameters:
    
    index - an index into this vector
    
    Returns:
    
    the element at the specified index
  - elements
```
public Enumeration<E> elements()
```
    Returns an enumeration of the components of this vector.
    
    Returns:
    
    an enumeration of the components of this vector
  - ensureCapacity
```
public void ensureCapacity(int mincap)
```
    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.
    
    Parameters:
    
    mincap - the desired minimum capacity
  - firstElement
```
public E firstElement()
```
    Returns the first component (the item at index 0) of this vector.
    
    Returns:
    
    the first component of this vector
    
    Throws:
    
    NoSuchElementException - if this vector has no components
  - indexOf
```
public int indexOf(Object obj)
```
    Returns the index of the first occurrence of the specified element in this vector, or -1 if this vector does not contain the element.
    
    Parameters:
    
    obj - element to search for
    
    Returns:
    
    the index of the first occurrence of the specified element in this vector, or -1 if this vector does not contain the element
  - indexOf
```
public int indexOf(Object obj,
                   int index)
```
    Returns the index of the first occurrence of the specified element in this vector, searching forwards from index, or returns -1 if the element is not found.
    
    Parameters:
    
    obj - element to search for
    
    index - index to start searching from
    
    Returns:
    
    the index of the first occurrence of the element in this vector at position index or later in the vector; -1 if the element is not found.
  - insertElementAt
```
public void insertElementAt(E obj,
                            int index)
```
    Inserts the specified object as a component in this vector at the specified index. Each component in this vector with an index greater or equal to the specified index is shifted upward to have an index one greater than the value it had previously.
    
    Parameters:
    
    obj - the component to insert
    
    index - where to insert the new component
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())
  - isEmpty
```
public boolean isEmpty()
```
    Tests if this vector has no elements.
    
    Returns:
    
    true if and only if this vector has no elements, that is, its size is zero; false otherwise.
  - lastElement
```
public E lastElement()
```
    Returns the last element in the vector.
    
    Returns:
    
    the last element in the vector
    
    Throws:
    
    NoSuchElementException - if this vector is empty
  - lastIndexOf
```
public int lastIndexOf(Object obj)
```
    Returns the index of the last occurrence of the specified element in this vector, or -1 if this vector does not contain the element.
    
    Parameters:
    
    obj - element to search for
    
    Returns:
    
    the index of the last occurrence of the specified element in this vector, or -1 if this vector does not contain the element
  - lastIndexOf
```
public int lastIndexOf(Object obj,
                       int index)
```
    Returns the index of the last occurrence of the specified element in this vector, searching backwards from index, or returns -1 if the element is not found.
    
    Parameters:
    
    obj - element to search for
    
    index - index to start searching backwards from
    
    Returns:
    
    the index of the last occurrence of the element at position less than or equal to index in this vector; -1 if the element is not found.
  - removeAllElements
```
public void removeAllElements()
```
    Removes all elements from this vector and sets its size to zero.
  - removeElement
```
public 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.
    
    Parameters:
    
    obj - the component to be removed
    
    Returns:
    
    true if the argument was a component of this vector; false otherwise.
  - removeElementAt
```
public 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 index is shifted downward to have an index one smaller than the value it had previously. The size of this vector is decreased by 1.
    
    Parameters:
    
    index - the index of the object to remove
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
  - setElementAt
```
public void setElementAt(E obj,
                         int index)
```
    Sets the element at the specified index of this vector to be the specified object. The previous component at that position is discarded.
    
    Parameters:
    
    obj - what the component is to be set to
    
    index - the specified index
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
  - setSize
```
public void setSize(int size)
```
    Sets the size of this vector. If the new size is greater than the current size, new null items are added to the end of the vector. If the new size is less than the current size, all components at index newSize and greater are discarded.
    
    Parameters:
    
    size - the new size of this vector
  - size
```
public int size()
```
    Returns the number of components in this vector.
    
    Returns:
    
    the number of components in this vector
  - toString
```
public String toString()
```
    Returns a string representation of this Vector, containing the String representation of each element.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.
  - trimToSize
```
public 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 elementData, with a smaller one. An application can use this operation to minimize the storage of a vector.

Class Vector<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

elementData

elementCount

capacityIncrement

Constructor Detail

Vector

Vector

Vector

Method Detail

addElement

capacity

clone

contains

copyInto

elementAt

elements

ensureCapacity

firstElement

indexOf

indexOf

insertElementAt

isEmpty

lastElement

lastIndexOf

lastIndexOf

removeAllElements

removeElement

removeElementAt

setElementAt

setSize

size

toString

trimToSize