Class CarlSortedList<T extends java.lang.Comparable<? super T>>

java.lang.Object

CarlSortedList<T>

Type Parameters:

T - The type of data that the list stores.

All Implemented Interfaces:

java.lang.Iterable<T>, SortedList<T>

public class CarlSortedList<T extends java.lang.Comparable<? super T>>
extends java.lang.Object
implements SortedList<T>

An implementation of the SortedList ADT. Note that you cannot add null items to a sorted list, since the list must be able to compare the values of items.

Constructor Summary

Constructors

Constructor and Description
CarlSortedList() Default constructor: creates an empty list.

Method Summary

Modifier and Type	Method and Description
void	add(T newItem) Adds newItem in sorted order, and shifts each item at or beyond that index to the next higher index.
void	clear() Removes all of the elements from this list.
boolean	contains(T targetItem) Returns true if this list contains the specified element.
T	get(int position) Returns the element at the specified position in this list.
int	indexOf(T targetItem) Returns the position of the item, or -1 if item is not in the list.
boolean	isEmpty() Returns true if this list contains no elements.
java.util.Iterator<T>	iterator() Returns an iterator over the elements in this list in proper sequence.
static void	main(java.lang.String[] args)
T	remove(int index) Removes the element at the specified position in this list.
boolean	remove(T targetItem) Removes the specified element from this list, if it is present.
int	size() Returns the number of elements in this list.
java.lang.Object[]	toArray() Returns an array version of the list.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CarlSortedList

public CarlSortedList()

Default constructor: creates an empty list.

Method Detail

add

public void add(T newItem)

Adds newItem in sorted order, and shifts each item at or beyond that index to the next higher index.

Specified by:

add in interface SortedList<T extends java.lang.Comparable<? super T>>

Parameters:

newItem - element to be added to the list

remove

public boolean remove(T targetItem)

Description copied from interface: SortedList

Removes the specified element from this list, if it is present. If this list does not contain the element, it is unchanged. Returns true if this list contained the specified element.

Specified by:

remove in interface SortedList<T extends java.lang.Comparable<? super T>>

Parameters:

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

Returns:

true if this list contained the specified element

remove

public T remove(int index)

Description copied from interface: SortedList

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

Specified by:

remove in interface SortedList<T extends java.lang.Comparable<? super T>>

Parameters:

index - index of the element to be removed

Returns:

the element previously at the specified position

indexOf

public int indexOf(T targetItem)

Description copied from interface: SortedList

Returns the position of the item, or -1 if item is not in the list.

Specified by:

indexOf in interface SortedList<T extends java.lang.Comparable<? super T>>

Parameters:

targetItem - item

Returns:

The position of the item, or -1 if item is not in the list

clear

public void clear()

Description copied from interface: SortedList

Removes all of the elements from this list.

Specified by:

clear in interface SortedList<T extends java.lang.Comparable<? super T>>

get

public T get(int position)

Description copied from interface: SortedList

Returns the element at the specified position in this list.

Specified by:

get in interface SortedList<T extends java.lang.Comparable<? super T>>

Parameters:

position - specified position

Returns:

the element at the specified position in this list

contains

public boolean contains(T targetItem)

Description copied from interface: SortedList

Returns true if this list contains the specified element.

Specified by:

contains in interface SortedList<T extends java.lang.Comparable<? super T>>

Parameters:

targetItem - specified element

Returns:

true if this list contains the specified element

size

public int size()

Description copied from interface: SortedList

Returns the number of elements in this list.

Specified by:

size in interface SortedList<T extends java.lang.Comparable<? super T>>

Returns:

the number of elements in this list

isEmpty

public boolean isEmpty()

Description copied from interface: SortedList

Returns true if this list contains no elements.

Specified by:

isEmpty in interface SortedList<T extends java.lang.Comparable<? super T>>

Returns:

true if this list contains no elements

toArray

public java.lang.Object[] toArray()

Description copied from interface: SortedList

Returns an array version of the list. Note that, for technical reasons, the type of the items contained in the list can't be communicated properly to the caller, so an array of Objects gets returned.

Specified by:

toArray in interface SortedList<T extends java.lang.Comparable<? super T>>

Returns:

an array of length size(), with the same items in it as are stored in the list, in the same order

iterator

public java.util.Iterator<T> iterator()

Description copied from interface: SortedList

Returns an iterator over the elements in this list in proper sequence. (Optional.)

Specified by:

iterator in interface java.lang.Iterable<T extends java.lang.Comparable<? super T>>

Specified by:

iterator in interface SortedList<T extends java.lang.Comparable<? super T>>

Returns:

an iterator over the elements in this list in proper sequence

main

public static void main(java.lang.String[] args)