maspack.util

Class LinkLinkedList<T>

java.lang.Object

maspack.util.LinkLinkedList<T>

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.Deque<T>, java.util.List<T>, java.util.Queue<T>

public class LinkLinkedList<T>
extends java.lang.Object
implements java.util.List<T>, java.util.Deque<T>, java.lang.Cloneable

Basic Doubly Linked-List with access to links

Author:

Antonio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LinkLinkedList.Link<T>

Constructor Summary

Constructors

Constructor and Description
LinkLinkedList()

Method Summary

Modifier and Type	Method and Description
void	add(int idx, T e)
boolean	add(T e)
boolean	addAll(java.util.Collection<? extends T> c)
boolean	addAll(int idx, java.util.Collection<? extends T> c)
void	addFirst(T e) Adds an element to the BEGINNING of this list
void	addFirstLink(LinkLinkedList.Link<T> link) Adds a link to the front of the list
LinkLinkedList.Link<T>	addFirstLink(T e) Adds a link to the front of the list
void	addLast(T e) Adds an element to the END of this list
void	addLastLink(LinkLinkedList.Link<T> link) Adds a link to the end of the list
LinkLinkedList.Link<T>	addLastLink(T e) Adds a link to the end of the list
LinkLinkedList.Link<T>	addLink(T e) Adds a link to the end of the list,
LinkLinkedList.Link<T>	backLink() Last link
LinkLinkedList.Link<T>	begin() First element
void	clear()
LinkLinkedList<T>	clone() Clones the list (shallow copy)
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
java.util.Iterator<T>	descendingIterator()
T	element()
LinkLinkedList.Link<T>	end() Past-the-end element
LinkLinkedList.Link<T>	findLastLink(java.lang.Object o) Finds the last link whose get() method returns the specified value (in == or .equals() sense)
LinkLinkedList.Link<T>	findLastLink(java.lang.Object o, LinkLinkedList.Link<T> front, LinkLinkedList.Link<T> end) Finds the last link whose get() method returns the specified value (in == or .equals() sense)
LinkLinkedList.Link<T>	findLink(java.lang.Object o) Finds the first link whose get() method returns the specified value (in == or .equals() sense)
LinkLinkedList.Link<T>	findLink(java.lang.Object o, LinkLinkedList.Link<T> front, LinkLinkedList.Link<T> end) Finds the first link whose get() method returns the specified value (in == or .equals() sense).
LinkLinkedList.Link<T>	frontLink() First link
T	get(int index)
T	getFirst()
T	getLast()
LinkLinkedList.Link<T>	getLink(int idx) Returns the link at the specified index
int	indexOf(java.lang.Object o)
boolean	isEmpty()
java.util.Iterator<T>	iterator()
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator<T>	listIterator()
java.util.ListIterator<T>	listIterator(int idx)
boolean	offer(T e)
boolean	offerFirst(T e)
boolean	offerLast(T e)
T	peek()
T	peekFirst()
T	peekLast()
T	poll()
T	pollFirst()
T	pollLast()
T	pop()
void	push(T e)
T	remove()
T	remove(int idx)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
T	removeFirst()
boolean	removeFirstOccurrence(java.lang.Object o)
T	removeLast()
boolean	removeLastOccurrence(java.lang.Object o)
void	removeLink(LinkLinkedList.Link<T> link)
boolean	retainAll(java.util.Collection<?> c)
T	set(int idx, T element)
int	size()
LinkLinkedList<T>	subList(int fromIndex, int toIndex)
java.lang.Object[]	toArray()
<E> E[]	toArray(E[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

LinkLinkedList

public LinkLinkedList()

Method Detail

begin

public LinkLinkedList.Link<T> begin()

First element

Returns:

first element

end

public LinkLinkedList.Link<T> end()

Past-the-end element

Returns:

past-the-end element

add

public boolean add(T e)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.Deque<T>

Specified by:

add in interface java.util.List<T>

Specified by:

add in interface java.util.Queue<T>

addLink

public LinkLinkedList.Link<T> addLink(T e)

Adds a link to the end of the list,

Parameters:

e - element to add

Returns:

the newly created link

addLastLink

public LinkLinkedList.Link<T> addLastLink(T e)

Adds a link to the end of the list

Parameters:

e - element to add

Returns:

the new link

addFirstLink

public LinkLinkedList.Link<T> addFirstLink(T e)

Adds a link to the front of the list

Parameters:

e - element to add

Returns:

the new link

addFirstLink

public void addFirstLink(LinkLinkedList.Link<T> link)

Adds a link to the front of the list

Parameters:

link - link to add

addLastLink

public void addLastLink(LinkLinkedList.Link<T> link)

Adds a link to the end of the list

Parameters:

link - link to add

frontLink

public LinkLinkedList.Link<T> frontLink()

First link

Returns:

the first link

Throws:

java.util.NoSuchElementException - if there is no link

backLink

public LinkLinkedList.Link<T> backLink()

Last link

Returns:

the last link

Throws:

java.util.NoSuchElementException - if there is no element in the list

addLast

public void addLast(T e)

Adds an element to the END of this list

Specified by:

addLast in interface java.util.Deque<T>

Parameters:

e - element to add

addFirst

public void addFirst(T e)

Adds an element to the BEGINNING of this list

Specified by:

addFirst in interface java.util.Deque<T>

Parameters:

e - element to add

getLink

public LinkLinkedList.Link<T> getLink(int idx)

Returns the link at the specified index

Parameters:

idx - index

Returns:

link

add

public void add(int idx,
                T e)

Specified by:

add in interface java.util.List<T>

addAll

public boolean addAll(java.util.Collection<? extends T> c)

Specified by:

addAll in interface java.util.Collection<T>

Specified by:

addAll in interface java.util.List<T>

addAll

public boolean addAll(int idx,
                      java.util.Collection<? extends T> c)

Specified by:

addAll in interface java.util.List<T>

removeLink

public void removeLink(LinkLinkedList.Link<T> link)

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface java.util.List<T>

findLink

public LinkLinkedList.Link<T> findLink(java.lang.Object o,
                                       LinkLinkedList.Link<T> front,
                                       LinkLinkedList.Link<T> end)

Finds the first link whose get() method returns the specified value (in == or .equals() sense). Searches a particular range of links.

Parameters:

o - object to check for equality

front - first link to check

end - last link (exclusive)

Returns:

link containing value, end if not found.

findLink

public LinkLinkedList.Link<T> findLink(java.lang.Object o)

Finds the first link whose get() method returns the specified value (in == or .equals() sense)

Parameters:

o - object to check for equality

Returns:

link containing value, end() if not found.

findLastLink

public LinkLinkedList.Link<T> findLastLink(java.lang.Object o,
                                           LinkLinkedList.Link<T> front,
                                           LinkLinkedList.Link<T> end)

Finds the last link whose get() method returns the specified value (in == or .equals() sense)

Parameters:

o - object to check for equality

front - front element (last one checked)

end - end of list (exclusive, not checked)

Returns:

link containing value, end if not found.

findLastLink

public LinkLinkedList.Link<T> findLastLink(java.lang.Object o)

Finds the last link whose get() method returns the specified value (in == or .equals() sense)

Parameters:

o - object to check for equality

Returns:

link containing value, end() if not found.

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<T>

Specified by:

contains in interface java.util.Deque<T>

Specified by:

contains in interface java.util.List<T>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<T>

Specified by:

containsAll in interface java.util.List<T>

get

public T get(int index)

Specified by:

get in interface java.util.List<T>

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<T>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<T>

Specified by:

isEmpty in interface java.util.List<T>

iterator

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

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.util.Deque<T>

Specified by:

iterator in interface java.util.List<T>

listIterator

public java.util.ListIterator<T> listIterator()

Specified by:

listIterator in interface java.util.List<T>

listIterator

public java.util.ListIterator<T> listIterator(int idx)

Specified by:

listIterator in interface java.util.List<T>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface java.util.Deque<T>

Specified by:

remove in interface java.util.List<T>

remove

public T remove(int idx)

Specified by:

remove in interface java.util.List<T>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<T>

Specified by:

removeAll in interface java.util.List<T>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<T>

Specified by:

retainAll in interface java.util.List<T>

set

public T set(int idx,
             T element)

Specified by:

set in interface java.util.List<T>

size

public int size()

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface java.util.Deque<T>

Specified by:

size in interface java.util.List<T>

subList

public LinkLinkedList<T> subList(int fromIndex,
                                 int toIndex)

Specified by:

subList in interface java.util.List<T>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.List<T>

toArray

public <E> E[] toArray(E[] a)

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.List<T>

descendingIterator

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

Specified by:

descendingIterator in interface java.util.Deque<T>

element

public T element()

Specified by:

element in interface java.util.Deque<T>

Specified by:

element in interface java.util.Queue<T>

getFirst

public T getFirst()

Specified by:

getFirst in interface java.util.Deque<T>

getLast

public T getLast()

Specified by:

getLast in interface java.util.Deque<T>

offer

public boolean offer(T e)

Specified by:

offer in interface java.util.Deque<T>

Specified by:

offer in interface java.util.Queue<T>

offerFirst

public boolean offerFirst(T e)

Specified by:

offerFirst in interface java.util.Deque<T>

offerLast

public boolean offerLast(T e)

Specified by:

offerLast in interface java.util.Deque<T>

peek

public T peek()

Specified by:

peek in interface java.util.Deque<T>

Specified by:

peek in interface java.util.Queue<T>

peekFirst

public T peekFirst()

Specified by:

peekFirst in interface java.util.Deque<T>

peekLast

public T peekLast()

Specified by:

peekLast in interface java.util.Deque<T>

poll

public T poll()

Specified by:

poll in interface java.util.Deque<T>

Specified by:

poll in interface java.util.Queue<T>

pollFirst

public T pollFirst()

Specified by:

pollFirst in interface java.util.Deque<T>

pollLast

public T pollLast()

Specified by:

pollLast in interface java.util.Deque<T>

pop

public T pop()

Specified by:

pop in interface java.util.Deque<T>

push

public void push(T e)

Specified by:

push in interface java.util.Deque<T>

remove

public T remove()

Specified by:

remove in interface java.util.Deque<T>

Specified by:

remove in interface java.util.Queue<T>

removeFirst

public T removeFirst()

Specified by:

removeFirst in interface java.util.Deque<T>

removeFirstOccurrence

public boolean removeFirstOccurrence(java.lang.Object o)

Specified by:

removeFirstOccurrence in interface java.util.Deque<T>

removeLast

public T removeLast()

Specified by:

removeLast in interface java.util.Deque<T>

removeLastOccurrence

public boolean removeLastOccurrence(java.lang.Object o)

Specified by:

removeLastOccurrence in interface java.util.Deque<T>

clone

public LinkLinkedList<T> clone()

Clones the list (shallow copy)

Overrides:

clone in class java.lang.Object