Public Member Functions
	List ()
	List (int size)
boolean	add (Object obj)
boolean	add (int index, Object obj) throws IndexOutOfBoundsException
void	clear ()
Object	clone ()
boolean	contains (Object obj)
boolean	equals (Object obj)
Object	get (int index) throws IndexOutOfBoundsException
int	hashCode ()
int	indexOf (Object obj)
boolean	isEmpty ()
int	lastIndexOf (Object obj)
Object	remove (int index)
boolean	remove (Object obj)
void	trimToSize ()
Object	set (int index, Object element) throws IndexOutOfBoundsException
int	size ()
List	subList (int fromIndex, int toIndex)
Object[]	toArray ()
Object[]	toArray (Object[] dst)
Object[]	toArray (Object[] dst, int offset)

Detailed Description

This is my implementation of the JDK 1.2 List interface. I wrote this because I want people using 1.1.x to be able to use my apps, but I don't want to use a "synchronized" Vector. I also wanted to get a start in moving my source to JDK 1.2
I use the implementation of the hashCode method that is listed in the JDK 1.2 API, so this List can be compared correctly to actual JDK 1.2 lists using the equals method. Note: This is not a complete implementation yet, None of the methods that take a Collection have been imlplemented.

Author:: Keith Visco

Version:

Revision:: 1.2

Date:: 2004/05/10 07:51:52

See also:: java.util.List; java.util.Collection

Constructor & Destructor Documentation

org.exolab.castor.util.List.List ( )

Creates a new BasicSet with the default Size

Referenced by org.exolab.castor.util.List.subList().

org.exolab.castor.util.List.List ( int size )

Member Function Documentation

boolean org.exolab.castor.util.List.add ( Object obj )

Adds the specified Object to the list

Parameters:

obj

the Object to add to the list

Returns:: true if the Object is added to the list

Referenced by org.exolab.castor.xml.schema.FacetList.add(), org.exolab.castor.xml.Marshaller.addProcessingInstruction(), org.exolab.castor.xml.Introspector.generateClassDescriptor(), org.exolab.castor.util.List.set(), org.exolab.castor.xml.util.AttributeSetImpl.setAttribute(), org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setMatches(), and org.exolab.castor.util.List.subList().

boolean org.exolab.castor.util.List.add	(	int	index,
		Object	obj
	)			throws IndexOutOfBoundsException

Adds the specified Object to the list at the specified index

Parameters:

obj

the Object to add to the list

Returns:: true if the Object is added to the list

Exceptions:

IndexOutOfBoundsException

void org.exolab.castor.util.List.clear ( )

Removes all elements from the list

Referenced by org.exolab.castor.xml.util.AttributeSetImpl.clear().

Object org.exolab.castor.util.List.clone ( )

boolean org.exolab.castor.util.List.contains ( Object obj )

Returns true if the specified element is contained in the list. if the specfied element is null, then if the list contains a null value, true will be returned.

Parameters:

obj

the element to search the list for

Returns:: true if specified element is contained in the list

References org.exolab.castor.util.List.indexOf().

boolean org.exolab.castor.util.List.equals ( Object obj )

Compares the specified object with this list for equality. Returns true if and only if the specified Object is a list and all of its associated elements are equal to the elements of this list

References org.exolab.castor.util.List.get(), and org.exolab.castor.util.List.size().

Object org.exolab.castor.util.List.get ( int index ) throws IndexOutOfBoundsException

Returns the element at the specified position in this list.

Parameters:

index

the position of the element to return

Exceptions:

IndexOutOfBoundsException

int org.exolab.castor.util.List.hashCode ( )

As defined by the JDK 1.2 API spec:
Returns the hash code value for this list. The hash code of a list is defined to be the result of the following calculation:
hashCode = 1; Iterator i = list.iterator(); while (i.hasNext()) { Object obj = i.next(); hashCode = 31*hashCode + (obj==null ? 0 : obj.hashCode()); }

Returns:: the hash code value for this list

int org.exolab.castor.util.List.indexOf ( Object obj )

Returns the index of the first occurrence of the specified element, or -1 if the element is not contained in the List

Parameters:

obj

the Object to get the index for

Referenced by org.exolab.castor.util.List.contains(), and org.exolab.castor.util.List.remove().

boolean org.exolab.castor.util.List.isEmpty ( )

Returns true if there are no elements in the List.

Returns:: true if there are no elements in the List.

int org.exolab.castor.util.List.lastIndexOf ( Object obj )

Returns the index of the last occurrence of the specified element, or -1 if the element is not contained in the List

Parameters:

obj

the Object to get the last index for

Object org.exolab.castor.util.List.remove ( int index )

Removes the element at the specified index from the List

Parameters:

index

the position in the list tp remove the element from

Returns:: the Object that was removed from the list

Referenced by org.exolab.castor.xml.schema.FacetList.remove().

boolean org.exolab.castor.util.List.remove ( Object obj )

Removes the first occurrence of the specified element from the List

Parameters:

obj

the Object to remove from the List

Returns:: true if the Object was removed from the list

References org.exolab.castor.util.List.indexOf().

Object org.exolab.castor.util.List.set	(	int	index,
		Object	element
	)			throws IndexOutOfBoundsException

Replaces the element at the specified position in this list with the specified element.

Parameters:

	index	the position in the list to place the element at
	element	the element to add to the list

Exceptions:

IndexOutOfBoundsException

References org.exolab.castor.util.List.add().

int org.exolab.castor.util.List.size ( )

Returns the number of elements in the List

Returns:: the number of elements in the List

List org.exolab.castor.util.List.subList	(	int	fromIndex,
		int	toIndex
	)

Returns a new List which contains elements from a given section of this list.

Parameters:

	fromIndex	the start index (inclusize) of elements to add to the new list
	toIndex	the end index (exclusive)of the elements to add to the new list

Returns:: a new List which contains elements from a given section of this list.

Exceptions:

IndexOutOfBoundsException

for invalid index values

References org.exolab.castor.util.List.add(), org.exolab.castor.util.List.List(), and org.exolab.castor.util.List.size().

Object [] org.exolab.castor.util.List.toArray ( Object[] dst )

Returns an array containing all of the elements in this list in proper sequence.

Returns:: the array of elements of this List

References org.exolab.castor.util.List.toArray().

Object [] org.exolab.castor.util.List.toArray	(	Object[]	dst,
		int	offset
	)

Returns an array containing all of the elements in this list in proper sequence.

Returns:: the array of elements of this List

Object [] org.exolab.castor.util.List.toArray ( )

Returns an array containing all of the elements in this list in proper sequence.

Returns:: the array of elements of this List

Referenced by org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setMatches(), and org.exolab.castor.util.List.toArray().

void org.exolab.castor.util.List.trimToSize ( )

Reduces the capacity of the internal buffer to the current size freeing up unused memory.

The documentation for this class was generated from the following file:

castor/config/antbuild/src_patched/org/exolab/castor/util/List.java

org.exolab.castor.util.List Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation