Package net.officefloor.frame.internal.structure

Interface LinkedListSet<I extends LinkedListSetEntry<I,O>,O>

All Known Implementing Classes:

ComparatorLinkedListSet, StrictLinkedListSet

public interface LinkedListSet<I extends LinkedListSetEntry<I,O>,O>

Linked List maintaining a unique set of LinkedListSetEntry.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	addEntry(I entry)	Adds a LinkedListSetEntry to this LinkedListSet.
LinkedListSetItem<I>	copyEntries()	Creates a copy of this LinkedListSet returning the head of the copy.
I	getHead()	Obtains the head of this LinkedListSet.
I	getTail()	Obtains the tail of this LinkedListSet.
I	purgeEntries()	Purges all LinkedListSetEntry instances within this LinkedListSet.
boolean	removeEntry(I entry)	Removes this LinkedListSetEntry from the LinkedListSet.

Method Details

getHead

I getHead()

Obtains the head of this LinkedListSet.

Returns:

Head LinkedListSetEntry of this LinkedListSet.

getTail

I getTail()

Obtains the tail of this LinkedListSet.

Returns:

Tail of this LinkedListSet.

addEntry

void addEntry(I entry)
       throws IllegalStateException

Adds a LinkedListSetEntry to this LinkedListSet.

Parameters:

entry - LinkedListSetEntry to be added to this LinkedListSet.

Throws:

IllegalStateException - If LinkedListSetEntry is not valid for this LinkedListSet.

removeEntry

boolean removeEntry(I entry)
             throws IllegalStateException

Removes this LinkedListSetEntry from the LinkedListSet.

Parameters:

entry - LinkedListSetEntry to be removed from this LinkedListSet.

Returns:

true if the LinkedListSetEntry just removed was the last LinkedListSetEntry in the LinkedListSet.

Throws:

IllegalStateException - If LinkedListSetEntry is not valid for this LinkedListSet.

purgeEntries

I purgeEntries()

Purges all LinkedListSetEntry instances within this LinkedListSet.

Returns:

Head of the LinkedListSet (before the purge) so that may action the LinkedListSetEntry instances.

copyEntries

LinkedListSetItem<I> copyEntries()

Creates a copy of this LinkedListSet returning the head of the copy.

The returned copy is Thread safe to iterate.

Returns:

Head LinkedListSetItem of the copy.