Interface SortedList<T extends java.lang.Comparable<? super T>>

All Superinterfaces:

java.lang.Iterable<T>

All Known Implementing Classes:

CarlSortedList

public interface SortedList<T extends java.lang.Comparable<? super T>>
extends java.lang.Iterable<T>

SortedList interface adapted from Carrano 16.4 and java.util.List. A sorted list ADT is like a list, but maintains its entries in sorted order (rather than in the order they were inserted or the order that the user specified).

Method Summary

Modifier and Type	Method and Description
void	add(T item) Adds item to the list in sorted order.
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.
T	remove(int i) 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 interface java.lang.Iterable

forEach, spliterator

Method Detail

add

void add(T item)

Adds item to the list in sorted order.

Parameters:

item - element to be added to the list

remove

boolean remove(T targetItem)

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.

Parameters:

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

Returns:

true if this list contained the specified element

remove

T remove(int i)

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.

Parameters:

i - index of the element to be removed

Returns:

the element previously at the specified position

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

indexOf

int indexOf(T targetItem)

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

Parameters:

targetItem - item

Returns:

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

get

T get(int position)

Returns the element at the specified position in this list.

Parameters:

position - specified position

Returns:

the element at the specified position in this list

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of bounds.

contains

boolean contains(T targetItem)

Returns true if this list contains the specified element.

Parameters:

targetItem - specified element

Returns:

true if this list contains the specified element

size

int size()

Returns the number of elements in this list.

Returns:

the number of elements in this list

isEmpty

boolean isEmpty()

Returns true if this list contains no elements.

Returns:

true if this list contains no elements

clear

void clear()

Removes all of the elements from this list.

toArray

java.lang.Object[] toArray()

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.

Returns:

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

iterator

java.util.Iterator<T> iterator()

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

Returns:

an iterator over the elements in this list in proper sequence

Throws:

java.lang.UnsupportedOperationException - if iterator not supported