com.mapr.ojai.store.impl.doublylinked

Class DoublyLinked<T extends DoublyLinked<?>>

java.lang.Object

com.mapr.ojai.store.impl.doublylinked.DoublyLinked<T>

Type Parameters:

T - the type of the items on the list.

Direct Known Subclasses:

DoublyLinkedList

public class DoublyLinked<T extends DoublyLinked<?>>
extends java.lang.Object

Base class for instances that want to be on a DoublyLinkedList. Unlike a LinkedList, this data structure allows for cheaply removing items from any position in the list, and inserting them into the list in positions relative to other items.

See Also:

DoublyLinkedList

Constructor Summary

Constructors

Constructor and Description
DoublyLinked() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAfter(DoublyLinked<T> link) Add this item to the list that the provided link is already on, in the position after that link.
void	addBefore(DoublyLinked<T> link) Add this item to the list that the provided link is already on, in the position before that link.
T	getNext(DoublyLinkedList<T> list) Get the next item on the list.
T	getPrevious(DoublyLinkedList<T> list) Get the previous item on the list.
boolean	isOnList() Determine if this item is currently on a list.
void	remove() Link around this item in the list, clearing this item's next and previous pointers so it can't affect the list in any way in the future.
void	removeUnsafe() Link around this item in the list, without clearing this item's next and previous pointers.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoublyLinked

public DoublyLinked()

Constructor.

Method Detail

removeUnsafe

public void removeUnsafe()

Link around this item in the list, without clearing this item's next and previous pointers. This is considered unsafe because the lack of clearing means that if used improperly, further operations on this link could damage the list. This operation is provided as a performance optimization that can be used whenever the link will immediately be added back to another list -- removing the possibility that the list could be damaged with any other operations.

remove

public void remove()

Link around this item in the list, clearing this item's next and previous pointers so it can't affect the list in any way in the future.

getNext

public T getNext(DoublyLinkedList<T> list)

Get the next item on the list.

Parameters:

list - the list

Returns:

the next item on the list, if there is one, otherwise null

getPrevious

public T getPrevious(DoublyLinkedList<T> list)

Get the previous item on the list.

Parameters:

list - the list

Returns:

the previous item on the list, if there is one, otherwise null

addBefore

public void addBefore(DoublyLinked<T> link)

Add this item to the list that the provided link is already on, in the position before that link.

Parameters:

link - the link to add this one before

addAfter

public void addAfter(DoublyLinked<T> link)

Add this item to the list that the provided link is already on, in the position after that link.

Parameters:

link - the link to add this one after

isOnList

public boolean isOnList()

Determine if this item is currently on a list. Not valid if the last thing done to the link is removeUnsafe().

Returns:

true if this is on a list, false otherwise