project2

Interface OrderedList<E extends Comparable<E>>

Type Parameters:

E - the type of elements in this list

All Superinterfaces:

Cloneable

public interface OrderedList<E extends Comparable<E>>
extends Cloneable

A sorted collection. The element in this list are stored in order determined by the natural ordering of those elements (i.e., the compareTo() method defined in the elements' class). The user can access elements by their integer index (position in the list), and search for elements in the list.

The lists implementing this interface allow duplicate elements. They do not allow null elements.

Author:

Joanna Klukowska

Method Summary

Modifier and Type	Method and Description
boolean	add(E e) Adds the specified element to this list in a sorted order.
void	clear() Removes all of the elements from this list.
Object	clone() Returns a shallow copy of this list.
boolean	contains(Object o) Returns true if this list contains the specified element.
boolean	equals(Object o) Compares the specified object with this list for equality.
E	get(int index) Returns the element at the specified position in this list.
int	indexOf(Object o) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
E	remove(int index) Removes the element at the specified position in this list.
boolean	remove(Object o) Removes the first occurrence of the specified element from this list, if it is present.
int	size() Returns the number of elements in this list.
String	toString() Returns a string representation of this list.

Method Detail

add

boolean add(E e)

Adds the specified element to this list in a sorted order.

The element added must implement Comparable interface. This list does not permit null elements.

Parameters:

e - element to be appended to this list

Returns:

true if this collection changed as a result of the call

Throws:

ClassCastException - if the class of the specified element does not implement Comparable

NullPointerException - if the specified element is null

clear

void clear()

Removes all of the elements from this list. The list will be empty after this call returns.

clone

Object clone()

Returns a shallow copy of this list. (The elements themselves are not cloned.)

Returns:

a shallow copy of this list instance

Throws:

CloneNotSupportedException - if the object's class does not support the Cloneable interface

contains

boolean contains(Object o)

Returns true if this list contains the specified element.

Parameters:

o - element whose presence in this list is to be tested

Returns:

true if this list contains the specified element

Throws:

ClassCastException - if the type of the specified element is incompatible with this list

NullPointerException - if the specified element is null

equals

boolean equals(Object o)

Compares the specified object with this list for equality. Returns true if and only if the specified object is also a list, both lists have the same size, and all corresponding pairs of elements in the two lists are equal. (Two elements e1 and e2 are equal if e1.equals(e2).) In other words, two lists are defined to be equal if they contain the same elements in the same order.

Overrides:

equals in class Object

Parameters:

o - the object to be compared for equality with this list

Returns:

true if the specified object is equal to this list

get

E get(int index)

Returns the element at the specified position in this list.

Parameters:

index - index of the element to return

Returns:

the element at the specified position in this list

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

indexOf

int indexOf(Object o)

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.

Parameters:

o - element to search for

Returns:

the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element

remove

E remove(int index)

Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices if such exist). Returns the element that was removed from the list.

Parameters:

index - the index of the element to be removed

Returns:

the element previously at the specified position

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

remove

boolean remove(Object o)

Removes the first occurrence of the specified element from this list, if it is present. If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that (o.equals(get(i)) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).

Parameters:

o - element to be removed from this list, if present

Returns:

true if this list contained the specified element

Throws:

ClassCastException - if the type of the specified element is incompatible with this list

NullPointerException - if the specified element is null and this list does not permit null elements

size

int size()

Returns the number of elements in this list.

Returns:

the number of elements in this list

toString

String toString()

Returns a string representation of this list. The string representation consists of a list of the list's elements in the order they are stored in this list, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings by the toString() method of those elements.

Overrides:

toString in class Object

Returns:

a string representation of this list