structure
Class Vector

java.lang.Object
  extended by structure.AbstractStructure
      extended by structure.AbstractList
          extended by structure.Vector
All Implemented Interfaces:
Cloneable, List, Structure

public class Vector
extends AbstractList
implements Cloneable

An implemention of extensible arrays, similar to that of java.util.Vector. This vector class implements a basic extensible array. It does not implement any of the additional features of the Sun class, including list-like operations. Those operations are available in other implementors of List in this package.

Example usage: To put a program's parameters into a Vector, we would use the following:

 public static void main(String[] arguments)
 {
    Vector argVec = new Vector();
    for (int i = 0; i < arguments.length; i++)
    {
       argVec.add(arguments[i]);
    }
    System.out.println(argVec);
 }
 

Since:
JavaStructures 1.0

Constructor Summary
Vector()
          Construct an empty vector.
Vector(Collection c)
           
Vector(int initialCapacity)
          Construct an empty vector capable of storing initialCapacity values before the vector must be extended.
Vector(int initialCapacity, int capacityIncr)
          Construct a vector with initial capacity, and growth characteristic.
Vector(int initialCapacity, int capacityIncr, Object initValue)
          Construct a vector with initial size, growth rate and default value.
Vector(Vector that)
           
 
Method Summary
 void add(int index, Object obj)
          Insert an element at a particular location.
 void add(Object obj)
          Add an element to the high end of the array, possibly expanding vector.
 void addElement(Object o)
          Add an element to the high end of the array, possibly expanding vector.
 int capacity()
          Determine the capacity of the vector.
 void clear()
          Remove all the values of the vector.
 Object clone()
          Construct a shallow copy of the vector.
 boolean contains(Object elem)
          Determine if a value appears in a vector.
 void copyInto(Object[] dest)
          Copy the contents of the vector into an array.
 Object elementAt(int index)
          Fetch the element at a particular index.
 void ensureCapacity(int minCapacity)
          Ensure that the vector is capable of holding at least minCapacity values without expansion.
 Object firstElement()
          Get access to the first element of the vector.
 Object get(int index)
          Fetch the element at a particular index.
 int indexOf(Object elem)
          Assuming the data is not in order, find the index of a value, or return -1 if not found.
 int indexOf(Object elem, int index)
          Assuming the data is not in order, find the index of a value or return -1 if the value is not found.
 void insertElementAt(Object obj, int index)
          Insert an element at a particular location.
 boolean isEmpty()
          Determine if the Vector contains no values.
 Iterator iterator()
          Construct a iterator over the elements of the vector.
 Object lastElement()
          Fetch a reference to the last value in the vector.
 int lastIndexOf(Object obj)
          Search for the last occurrence of a value within the vector.
 int lastIndexOf(Object obj, int index)
          Find the index of the last occurrence of the value in the vector before the indexth position.
 Object remove(int where)
          Remove an element at a particular location.
 Object remove(Object element)
          Remove an element, by value, from vector.
 void removeAllElements()
          Remove all the elements of the vector.
 void removeElementAt(int where)
          Remove an element at a particular location.
 Object set(int index, Object obj)
          Change the value stored at location index.
 void setElementAt(Object obj, int index)
          Change the value stored at location index.
 void setSize(int newSize)
          Explicitly set the size of the array.
 int size()
          Determine the number of elements in the vector.
 String toString()
          Determine a string representation for the vector.
 void trimToSize()
          Trim the vector to exactly the correct size.
 
Methods inherited from class structure.AbstractList
addFirst, addLast, get, getFirst, getLast, remove, removeFirst, removeLast
 
Methods inherited from class structure.AbstractStructure
elements, hashCode, values
 
Methods inherited from class java.lang.Object
equals, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface structure.Structure
elements, values
 

Constructor Detail

Vector

public Vector()
Construct an empty vector.


Vector

public Vector(int initialCapacity)
Construct an empty vector capable of storing initialCapacity values before the vector must be extended.

Parameters:
initialCapacity - The size of vector before reallocation is necessary

Vector

public Vector(int initialCapacity,
              int capacityIncr)
Construct a vector with initial capacity, and growth characteristic.

Parameters:
initialCapacity - The initial number of slots in vector.
capacityIncr - The size of growth of vector.
See Also:
capacityIncrement

Vector

public Vector(int initialCapacity,
              int capacityIncr,
              Object initValue)
Construct a vector with initial size, growth rate and default value.

Parameters:
initialCapacity - The initial number of slots in vector.
capacityIncr - The size of the increment when vector grows.
initValue - The initial value stored in vector elements.

Vector

public Vector(Vector that)

Vector

public Vector(Collection c)
Method Detail

ensureCapacity

public void ensureCapacity(int minCapacity)
Ensure that the vector is capable of holding at least minCapacity values without expansion.

Parameters:
minCapacity - The minimum size of array before expansion.

add

public void add(Object obj)
Add an element to the high end of the array, possibly expanding vector.

Specified by:
add in interface List
Specified by:
add in interface Structure
Overrides:
add in class AbstractList
Parameters:
obj - The object to be added to the end of the vector.
See Also:
AbstractList.addLast(java.lang.Object)

addElement

public void addElement(Object o)
Add an element to the high end of the array, possibly expanding vector.

Parameters:
obj - The object to be added to the end of the vector.

remove

public Object remove(Object element)
Remove an element, by value, from vector.

Specified by:
remove in interface List
Specified by:
remove in interface Structure
Parameters:
element - the element to be removed.
Returns:
the element actually removed, or if none, null.

capacity

public int capacity()
Determine the capacity of the vector. The capacity is always at least as large as its size.

Returns:
The size of the array underlying the vector.

clone

public Object clone()
Construct a shallow copy of the vector. The vector store is copied, but the individual elements are shared objects.

Overrides:
clone in class Object
Returns:
A copy of the original vector.

contains

public boolean contains(Object elem)
Determine if a value appears in a vector.

Specified by:
contains in interface List
Specified by:
contains in interface Structure
Overrides:
contains in class AbstractList
Parameters:
elem - The value sought.
Returns:
True iff the value appears in the vector.

copyInto

public void copyInto(Object[] dest)
Copy the contents of the vector into an array. The array must be large enough to accept all the values in the vector.

Parameters:
dest - An array of size at least size().

elementAt

public Object elementAt(int index)
Fetch the element at a particular index. The index of the first element is zero.

Parameters:
index - The index of the value sought.
Returns:
A reference to the value found in the vector.

get

public Object get(int index)
Fetch the element at a particular index. The index of the first element is zero.

Specified by:
get in interface List
Parameters:
index - The index of the value sought.
Returns:
A reference to the value found in the vector.

iterator

public Iterator iterator()
Construct a iterator over the elements of the vector. The iterator considers elements with increasing index.

Specified by:
iterator in interface List
Specified by:
iterator in interface Structure
Returns:
an iterator to traverse the vector.
See Also:
AbstractIterator, Iterator, Enumeration, Structure.elements()

firstElement

public Object firstElement()
Get access to the first element of the vector.

Returns:
Access to the first element of the vector.

indexOf

public int indexOf(Object elem)
Assuming the data is not in order, find the index of a value, or return -1 if not found.

Specified by:
indexOf in interface List
Parameters:
elem - The value sought in vector.
Returns:
The index of the first occurrence of the value.

indexOf

public int indexOf(Object elem,
                   int index)
Assuming the data is not in order, find the index of a value or return -1 if the value is not found. Search starts at index.

Parameters:
elem - The value sought.
index - The first location considered.
Returns:
The index of the first location, or -1 if not found.

insertElementAt

public void insertElementAt(Object obj,
                            int index)
Insert an element at a particular location. Vector is grown as needed

Parameters:
obj - The value to be inserted.
index - The location of the new value.

add

public void add(int index,
                Object obj)
Insert an element at a particular location. Vector is grown as needed

Specified by:
add in interface List
Parameters:
obj - the value to be inserted.
index - the location of the new value.

isEmpty

public boolean isEmpty()
Determine if the Vector contains no values.

Specified by:
isEmpty in interface List
Specified by:
isEmpty in interface Structure
Overrides:
isEmpty in class AbstractList
Returns:
True iff the vector is empty.

lastElement

public Object lastElement()
Fetch a reference to the last value in the vector.

Returns:
A reference to the last value.

lastIndexOf

public int lastIndexOf(Object obj)
Search for the last occurrence of a value within the vector. If none is found, return -1.

Specified by:
lastIndexOf in interface List
Parameters:
obj - The value sought.
Returns:
The index of the last occurrence in the vector.

lastIndexOf

public int lastIndexOf(Object obj,
                       int index)
Find the index of the last occurrence of the value in the vector before the indexth position.

Parameters:
obj - The value sought.
index - The last acceptable index.
Returns:
The index of the last occurrence of the value, or -1 if none.

clear

public void clear()
Remove all the values of the vector.

Specified by:
clear in interface List
Specified by:
clear in interface Structure

removeAllElements

public void removeAllElements()
Remove all the elements of the vector. Kept for compatibility with java.util.Vector.

See Also:
clear()

removeElementAt

public void removeElementAt(int where)
Remove an element at a particular location.

Parameters:
where - The location of the element to be removed.

remove

public Object remove(int where)
Remove an element at a particular location.

Specified by:
remove in interface List
Parameters:
where - The location of the element to be removed.
Returns:
value retrieved from location i (returns null if i invalid)

setElementAt

public void setElementAt(Object obj,
                         int index)
Change the value stored at location index.

Parameters:
obj - The new value to be stored.
index - The index of the new value.

set

public Object set(int index,
                  Object obj)
Change the value stored at location index.

Specified by:
set in interface List
Parameters:
obj - The new value to be stored.
index - The index of the new value.
Returns:
former value of ith entry of list.

setSize

public void setSize(int newSize)
Explicitly set the size of the array. Any new elements are initialized to the default value.

Parameters:
newSize - The ultimate size of the vector.

size

public int size()
Determine the number of elements in the vector.

Specified by:
size in interface List
Specified by:
size in interface Structure
Returns:
The number of elements within the vector.

trimToSize

public void trimToSize()
Trim the vector to exactly the correct size.


toString

public String toString()
Determine a string representation for the vector.

Overrides:
toString in class Object
Returns:
A string representation for the vector.