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

All Known Implementing Classes:

LinkedList

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

This interface indicates the public methods that need to be implemented for Homework 3 of CMP-338, Fall 2015.

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.
boolean	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.
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.
boolean	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 obj.
int	size() This method is called to obtain the count of elements in the list.

Method Detail

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

boolean add(I element,
            int index)

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 and index = 0, indicates that the Element being added should become the head of the list and should succeed even if the list is currently empty.

Returns:

Returns true if the Element was successfully added at the given index. If the given index is invalid, this method returns false, indicating that the specified Element was not added to the list.

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 that 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)

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

Parameters:

index - Indicates the position from which to retrieve the Element.

Returns:

Returns a reference to the Element at the given index, or nullL if the given index is invalid.

replace

I replace(I element,
          int index)

This method is called to replace the element at the specified index with the specified obj. 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 - Idicates the position in the list where the replacement should be made.

Returns:

If the replacement is successful, the method will return a reference to the replaced element. Otherwise, the method will return null.

remove

boolean remove(int index)

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

Parameters:

index - Indicates the position from which to remove the Element.

Returns:

Returns true if the Element was successfully removed from the given index, or false if the given index is invalid.

removeAll

void removeAll()

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