craterdog.collections.primitives

Class Link<T>

java.lang.Object

craterdog.collections.primitives.Link<T>

Type Parameters:

T - The type of the elements in the linked list.

All Implemented Interfaces:

java.lang.Cloneable

public final class Link<T>
extends java.lang.Object
implements java.lang.Cloneable

This class provides an implementation of a link that makes up a doubly linked list. The first element of the list is connected to the last element in the list to make a ring.

Author:

Derk Norton

Field Summary

Fields

Modifier and Type	Field and Description
Link<T>	next This attribute points to the next link in the list.
Link<T>	previous This attribute points to the previous link in the list.
T	value This attribute contains the value encapsulated by this link.

Constructor Summary

Constructors

Constructor and Description
Link(T value) This constructor takes a value and creates a Link that encapsulates it.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
boolean	equals(java.lang.Object object)
int	hashCode()
static <T> void	insertBeforeLink(Link<T> newLink, Link<T> existingLink) This utility method inserts a new link in a linked list before the specified existing link.
static <T> void	removeLink(Link<T> link) This utility method removes the specified link from a linked list.
static <T> void	removeLinks(Link<T> firstLink, Link<T> lastLink) This utility method removes a set of links from a linked list, starting with the first link and including the link before the lastLink.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

value

public T value

This attribute contains the value encapsulated by this link.

previous

public Link<T> previous

This attribute points to the previous link in the list.

next

public Link<T> next

This attribute points to the next link in the list.

Constructor Detail

Link

public Link(T value)

This constructor takes a value and creates a Link that encapsulates it.

Parameters:

value - The value to be encapsulated in a link.

Method Detail

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

insertBeforeLink

public static <T> void insertBeforeLink(Link<T> newLink,
                                        Link<T> existingLink)

This utility method inserts a new link in a linked list before the specified existing link.

Type Parameters:

T - The type of element encapsulated by the link.

Parameters:

newLink - The new link to be inserted.

existingLink - The existing link before which the new link will be inserted.

removeLink

public static <T> void removeLink(Link<T> link)

This utility method removes the specified link from a linked list.

Type Parameters:

T - The type of element encapsulated by the link.

Parameters:

link - The link to be removed.

removeLinks

public static <T> void removeLinks(Link<T> firstLink,
                                   Link<T> lastLink)

This utility method removes a set of links from a linked list, starting with the first link and including the link before the lastLink. Note, that this means the last link is not removed from the list.

Type Parameters:

T - The type of element encapsulated by the link.

Parameters:

firstLink - The first link in the sub chain to be removed.

lastLink - The link after the last link in the sub chain to be removed.