eve.util

Class mVector

java.lang.Object

java.util.Vector

eve.util.mVector

All Implemented Interfaces:

DataUnit, Copyable, Serializable, Cloneable, Comparable, Collection

Direct Known Subclasses:

Grid, ImageList, PropertyList, RangeList

public class mVector
extends Vector
implements DataUnit

A vector is an array of object references. The vector grows and shrinks dynamically as objects are added and removed.

Here is an example showing a vector being used:

 ...
 Vector vec = new Vector();
 vec.add(obj1);
 vec.add(obj2);
 ...
 vec.insert(3, obj3);
 vec.del(2);
 if (vec.getCount() > 5)
 ...
 

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Vector

capacityIncrement, elementCount, elementData

Fields inherited from interface java.io.Serializable

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
mVector() Constructs an empty vector.
mVector(int size) Constructs an empty vector with a given initial size.
mVector(int size, int incrementCount)
mVector(Object[] items)
mVector(Vector items)

Method Summary

Modifier and Type	Method and Description
void	add(int index, Object obj) Inserts an object at the given index.
static Vector	add(Vector v, Object toAdd) This adds an object to the end of the Vector v.
void	addAll(Object[] objs)
void	addAll(Object[] objs, int start, int length) Finds the index of the given object using the compare() method.
void	addAll(Vector objs)
static Vector	addAll(Vector dest, Object[] data)
void	addCopiesFrom(Object[] object, int start, int length)
static Vector	cacheAllElements(Vector v) Remove elements from the vector and cache them.
void	clear() Clear the collection, such that a subsequent call to isEmpty() would return true.
int	compareTo(Object other) This just compares the sizes of the two vectors.
protected void	copied(Object from) This method is called after the base implementation of copyFrom() is executed.
void	copyCopiesFrom(Object other)
void	copyFrom(Object other) This does not make copies of the elements of the other Object.
void	copyInto(Object[] array) The destination array MUST be big enough to hold the vector.
void	copyInto(Object[] array, int destPos) The destination array MUST be big enough to hold the vector.
void	del(int index) Deletes the object reference at the given index.
Object	find(ObjectFinder finder)
Object	get(int index) Get the element at a particular index.
Object	getCopy() Return a copy of this object.
int	getCount() Returns the number of objects in the vector.
mVector	getFullCopy() This returns a Vector that is a copy of this one, where all the items are themselves copies of the original items.
Object	getNew() Return a new Object which is of the same class as the original.
void	insert(int index, Object obj) Deprecated. Use add(index,obj) instead.
static Iterator	iterator(Vector v) This returns an iterator for the specified Vector.
static Vector	newVector(Object[] data)
static Object	pop(Vector v) This removes and returns the object at the front of the Vector v.
static Vector	push(Vector v, Object toPush) This inserts an object to the front of the Vector v.
static int	size(Collection c)
Object[]	toArray() Create a new Object array and copy all the elements into it.
Object[]	toArray(Class elementType) Create and return an array of objects that contain the contents of this mVector.
Object[]	toArray(Object[] dest) Copy the vector into the destination array, creating a new one if the provided destination is not big enough to hold all the elements.
static Object[]	toArray(Vector source)
static Object[]	toArray(Vector src, Class elementType) Create and return an array of objects that contain the contents of the supplied Vector.
Object[]	toObjectArray() Converts the vector to an array of objects.
String	toString() Return a String representation of this object.

Methods inherited from class java.util.Vector

add, addAll, addAll, addElement, capacity, clone, contains, containsAll, elementAt, elements, ensureCapacity, firstElement, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, remove, removeAll, removeAllElements, removeElement, removeElementAt, retainAll, setElementAt, setSize, size, trimToSize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode

Constructor Detail

mVector

public mVector()

Constructs an empty vector.

mVector

public mVector(int size)

Constructs an empty vector with a given initial size. The size is the initial size of the vector's internal object array. The vector will grow as needed when objects are added.

mVector

public mVector(int size,
               int incrementCount)

mVector

public mVector(Object[] items)

mVector

public mVector(Vector items)

Method Detail

copyFrom

public void copyFrom(Object other)

This does not make copies of the elements of the other Object.

Specified by:

copyFrom in interface DataUnit

copied

protected void copied(Object from)

This method is called after the base implementation of copyFrom() is executed. It gives you a chance to do extra work after the standard field by field copy is done.

Parameters:

from - The object that data was copied from.

addCopiesFrom

public void addCopiesFrom(Object[] object,
                          int start,
                          int length)

copyCopiesFrom

public void copyCopiesFrom(Object other)

getFullCopy

public mVector getFullCopy()

This returns a Vector that is a copy of this one, where all the items are themselves copies of the original items.

insert

public void insert(int index,
                   Object obj)

Deprecated. Use add(index,obj) instead.

Insert an object at the given index.

Parameters:

index - The index to insert the object.

obj - The object to add.

add

public void add(int index,
                Object obj)

Inserts an object at the given index.

Overrides:

add in class Vector

del

public void del(int index)

Deletes the object reference at the given index.

get

public Object get(int index)

Description copied from class: Vector

Get the element at a particular index. This is the same as elementAt().

Overrides:

get in class Vector

Parameters:

index - the index of the element.

Returns:

the element at the specified index.

getCount

public int getCount()

Returns the number of objects in the vector.

toObjectArray

public Object[] toObjectArray()

Converts the vector to an array of objects.

clear

public void clear()

Description copied from interface: Collection

Clear the collection, such that a subsequent call to isEmpty() would return true.

Specified by:

clear in interface Collection

Overrides:

clear in class Vector

addAll

public void addAll(Object[] objs,
                   int start,
                   int length)

Finds the index of the given object using the compare() method. The list is searched using a O(n) linear search through all the objects in the vector using the compare method.

addAll

public void addAll(Object[] objs)

addAll

public void addAll(Vector objs)

copyInto

public void copyInto(Object[] array,
                     int destPos)

The destination array MUST be big enough to hold the vector.

copyInto

public void copyInto(Object[] array)

The destination array MUST be big enough to hold the vector.

Overrides:

copyInto in class Vector

find

public Object find(ObjectFinder finder)

add

public static Vector add(Vector v,
                         Object toAdd)

This adds an object to the end of the Vector v. If v is null a new Vector is created and returned.

push

public static Vector push(Vector v,
                          Object toPush)

This inserts an object to the front of the Vector v. If v is null a new Vector is created and returned. This is not meant to be a high-performance Stack implementation.

pop

public static Object pop(Vector v)

This removes and returns the object at the front of the Vector v. If v is null OR v is empty, it will return null. This is not meant to be a high-performance Stack implementation.

iterator

public static Iterator iterator(Vector v)

This returns an iterator for the specified Vector. If the vector is null it will return an Iterator with no elements.

toArray

public Object[] toArray(Object[] dest)

Copy the vector into the destination array, creating a new one if the provided destination is not big enough to hold all the elements. If the provided destination array is big enough for the vector, the elements are copied into the array starting from the first index. If the array is bigger than the size of the vector, the extra elements of the array are set to null. If the array is smaller than the vector, then a new array is created, whose runtime type is the same as the destination parameter, and whose size is the same size as the vector. The vector elements are then copied into the newly created array and this array is then returned.

Specified by:

toArray in interface Collection

Overrides:

toArray in class Vector

Parameters:

[] - dest A destination object array to copy the vector elements into.

Returns:

The destination object array if it is big enough, or a new array if it is not.

toArray

public Object[] toArray()

Create a new Object array and copy all the elements into it.

Specified by:

toArray in interface Collection

Overrides:

toArray in class Vector

Returns:

A new Object array containing the vector's elements.

toArray

public static Object[] toArray(Vector source)

getNew

public Object getNew()

Description copied from interface: DataUnit

Return a new Object which is of the same class as the original.

Specified by:

getNew in interface DataUnit

getCopy

public Object getCopy()

Description copied from interface: Copyable

Return a copy of this object.

Specified by:

getCopy in interface Copyable

compareTo

public int compareTo(Object other)

This just compares the sizes of the two vectors.

Specified by:

compareTo in interface Comparable

addAll

public static Vector addAll(Vector dest,
                            Object[] data)

newVector

public static Vector newVector(Object[] data)

toString

public String toString()

Description copied from class: Object

Return a String representation of this object.

Overrides:

toString in class Vector

Returns:

a String representing this object.

cacheAllElements

public static Vector cacheAllElements(Vector v)

Remove elements from the vector and cache them.

Returns:

toArray

public Object[] toArray(Class elementType)

Create and return an array of objects that contain the contents of this mVector.

Parameters:

elementType - the type of the Object array to return. If this is null Object.class is used.

Returns:

an Object array of the specified type containing all the elements in the Vector.

toArray

public static Object[] toArray(Vector src,
                               Class elementType)

Create and return an array of objects that contain the contents of the supplied Vector.

Parameters:

src - the Vector to get the objects from. If this is null an empty array is returned.

elementType - the type of the Object array to return. If this is null Object.class is used.

Returns:

an Object array of the specified type containing all the elements in the Vector.

size

public static int size(Collection c)