Interface ListInterface<I extends java.lang.Comparable<? super I>>

public interface ListInterface<I extends java.lang.Comparable<? super I>>

This is the interface for the List Abstract Data Type (ADT).

Please note that this interface uses the generic type I which either implements the Comparable interface , or some super class of I implements the Comparable interface

Author:

Sameh Fakhouri

Method Summary

Modifier and Type	Method and Description
void	add(I element) This method is called to add the specified Element to the end of the list.
void	add(I element, int index) This method is called to add the specified Element to the list at the given index.
void	addSorted(I element) This method is called to add the specified Element to the list in sorted order.
ListInterface<I>	copy() This method will make a copy of the list and return it.
I	get(int index) This method is called to retrieve the Element at the specified index.
boolean	isEmpty() This method is called to determine if the list is empty.
I	remove(int index) This method is called to remove the Element at the specified index
void	removeAll() This method removes all Elements from the list, making the list empty.
I	replace(I element, int index) This method is called to replace the element at the specified index with the specified element.
int	size() This method is called to obtain the count of elements in the list.

Method Detail

copy

ListInterface<I> copy()

This method will make a copy of the list and return it.

Returns:

a copy of the list.

size

int size()

This method is called to obtain the count of elements in the list.

Returns:

Returns the numbers of Elements that are currently in the list.

isEmpty

boolean isEmpty()

This method is called to determine if the list is empty.

Returns:

Returns true if the list is empty, otherwise it returns false.

add

void add(I element)

This method is called to add the specified Element to the end of the list.

Parameters:

element - A reference to the element to be added to the end of the list. All Elements being added to the list must implement the Comparable interface.

See Also:

Comparable

add

void add(I element,
         int index)
  throws java.lang.IndexOutOfBoundsException

This method is called to add the specified Element to the list at the given index.

Parameters:

element - A reference to the element to be added to the list. All Elements being added to the list must implement the Comparable interface.

index - Indicates the position at which to add the specified Element.

• Using an index = 0 indicates that the element being added should become the head of the list and the add should succeed even if the list is currently empty.
• If the list currently contains n elements, using an index = n indicates that the element being added should become the tail of the list and the add should succeed.
• If the list currently contains n elements, using an index = i, where 0 ≤ i ≤ n, the add should succeed, since the index is valid.
• If the list currently contains n elements, using an index = i, where i > n, the add should fail and cause the method to throw an IndexOutOfBoundsException.

Throws:

java.lang.IndexOutOfBoundsException - This exception is thrown if the specified index is invalid.

See Also:

Comparable

addSorted

void addSorted(I element)

This method is called to add the specified Element to the list in sorted order. More specifically, the Elements preceding the specified Element must be "less than" the specified Element, and the Elements following the specified Element must be "greater than or equal to" the specified Element.

Parameters:

element - A reference to the element being added, in sorted order, to the list. All Elements being added to the list must implement the Comparable interface.

See Also:

Comparable

get

I get(int index)
throws java.lang.IndexOutOfBoundsException

This method is called to retrieve the Element at the specified index.

Parameters:

index - Indicates the position from which to retrieve the Element. If the list currently contains n elements, using an index = i, where 0 ≤ i < n, the get should succeed, since the index is valid.

Returns:

Returns a reference to the Element at the given index.

Throws:

java.lang.IndexOutOfBoundsException - This exception is thrown if the specified index is invalid.

replace

I replace(I element,
          int index)
   throws java.lang.IndexOutOfBoundsException

This method is called to replace the element at the specified index with the specified element. The method then returns the replaced element or null if no element exists at the specified index.

Parameters:

element - A reference to the element that will replace the current element in the list.

index - Indicates the position in the list where the replacement should be made. If the list currently contains n elements, using an index = i, where 0 ≤ i < n, the get should succeed, since the index is valid.

Returns:

If the replacement is successful, the method will return a reference to the replaced element at the specified index.

Throws:

java.lang.IndexOutOfBoundsException - This exception is thrown if the specified index is invalid.

remove

I remove(int index)
  throws java.lang.IndexOutOfBoundsException

This method is called to remove the Element at the specified index

Parameters:

index - Indicates the position from which to remove the Element. If the list currently contains n elements, using an index = i, where 0 ≤ i < n, the get should succeed, since the index is valid.

Returns:

If the remove is successful, the method will return a reference to the removed element at the specified index.

Throws:

java.lang.IndexOutOfBoundsException - This exception is thrown if the specified index is invalid.

removeAll

void removeAll()

This method removes all Elements from the list, making the list empty.