freenet.support

Interface DoublyLinkedList<T extends DoublyLinkedList.Item<?>>

All Superinterfaces:

java.lang.Iterable<T>

All Known Implementing Classes:

DoublyLinkedListImpl

public interface DoublyLinkedList<T extends DoublyLinkedList.Item<?>>
extends java.lang.Iterable<T>

Framework for managing a doubly linked list. The purpose of DoublyLinkedList is simply and solely so that we can override the entries with our own classes. This makes removal for example extremely fast: O(1) not O(n). In any other case we can use LinkedList.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DoublyLinkedList.Item<T extends DoublyLinkedList.Item<?>> List element

Method Summary

Modifier and Type	Method and Description
void	clear() Clear this list
boolean	contains(T item) Returns true if the list contains an item i where i.equals(item) is true.
java.util.Enumeration<T>	elements() Get a Enumeration of DoublyLinkedList.Item.
boolean	hasNext(T i)
boolean	hasPrev(T i)
T	head() Returns the first item.
void	insertNext(T i, T j) Inserts item j after item i
void	insertPrev(T i, T j) Inserts item j before item i.
boolean	isEmpty() Check if this list is empty.
T	next(T i)
T	pop() Removes and returns the last item.
DoublyLinkedList<T>	pop(int n) Remove n elements from tail and return them as a DoublyLinkedList.
T	prev(T i)
void	push(T i) Puts the item after the last item.
T	remove(T i) Remove and return a element
T	shift() Removes and returns the first item.
DoublyLinkedList<T>	shift(int n) Remove n elements from head and return them as a DoublyLinkedList.
int	size() Return the size of this list
T	tail() Returns the last item.
void	unshift(T i) Puts the item before the first item.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

clear

void clear()

Clear this list

size

int size()

Return the size of this list

isEmpty

boolean isEmpty()

Check if this list is empty. @return true if this list is empty, false otherwise.

elements

java.util.Enumeration<T> elements()

Get a Enumeration of DoublyLinkedList.Item.

contains

boolean contains(T item)

Returns true if the list contains an item i where i.equals(item) is true.

head

T head()

Returns the first item.

Returns:

the item at the head of the list, or null if empty

tail

T tail()

Returns the last item.

Returns:

the item at the tail of the list, or null if empty

unshift

void unshift(T i)

Puts the item before the first item.

shift

T shift()

Removes and returns the first item.

shift

DoublyLinkedList<T> shift(int n)

Remove n elements from head and return them as a DoublyLinkedList.

push

void push(T i)

Puts the item after the last item.

pop

T pop()

Removes and returns the last item.

pop

DoublyLinkedList<T> pop(int n)

Remove n elements from tail and return them as a DoublyLinkedList.

hasNext

boolean hasNext(T i)

Returns:

true if i has next item. (ie. not the last item); false otherwise

hasPrev

boolean hasPrev(T i)

Returns:

true if i has previous item. (ie. not the first item); false otherwise

next

T next(T i)

Returns:

next item of i. If this is the last element, return null

prev

T prev(T i)

Returns:

previous item of i. If this is the first element, return null

remove

T remove(T i)

Remove and return a element

Returns:

this item, or null if the item was not in the list

insertPrev

void insertPrev(T i,
                T j)

Inserts item j before item i.

insertNext

void insertNext(T i,
                T j)

Inserts item j after item i