Package net.officefloor.frame.impl.execute.linkedlistset

Class StrictLinkedListSet<E extends LinkedListSetEntry<E,O>,O>

java.lang.Object

net.officefloor.frame.impl.execute.linkedlistset.StrictLinkedListSet<E,O>

All Implemented Interfaces:

LinkedListSet<E,O>

Direct Known Subclasses:

ComparatorLinkedListSet

public abstract class StrictLinkedListSet<E extends LinkedListSetEntry<E,O>,O>
extends Object
implements LinkedListSet<E,O>

LinkedListSet that provides strict adherence to ensuring correctness.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	StrictLinkedListSet.LinkedListItemImpl	Implementation of the LinkedListSetItem.

Constructor Summary

Constructors

Constructor	Description
StrictLinkedListSet()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

StrictLinkedListSet

public StrictLinkedListSet()

Method Details

getOwner

protected abstract O getOwner()

Obtains the owner of this LinkedListSet.

Returns:

Owner of this LinkedListSet.

getHead

public final E getHead()

Description copied from interface: LinkedListSet

Obtains the head of this LinkedListSet.

Specified by:

getHead in interface LinkedListSet<E extends LinkedListSetEntry<E,O>,O>

Returns:

Head LinkedListSetEntry of this LinkedListSet.

getTail

public final E getTail()

Description copied from interface: LinkedListSet

Obtains the tail of this LinkedListSet.

Specified by:

getTail in interface LinkedListSet<E extends LinkedListSetEntry<E,O>,O>

Returns:

Tail of this LinkedListSet.

addEntry

public void addEntry(E entry)

Description copied from interface: LinkedListSet

Adds a LinkedListSetEntry to this LinkedListSet.

Specified by:

addEntry in interface LinkedListSet<E extends LinkedListSetEntry<E,O>,O>

Parameters:

entry - LinkedListSetEntry to be added to this LinkedListSet.

removeEntry

public final boolean removeEntry(E entry)

Description copied from interface: LinkedListSet

Removes this LinkedListSetEntry from the LinkedListSet.

Specified by:

removeEntry in interface LinkedListSet<E extends LinkedListSetEntry<E,O>,O>

Parameters:

entry - LinkedListSetEntry to be removed from this LinkedListSet.

Returns:

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

purgeEntries

public final E purgeEntries()

Description copied from interface: LinkedListSet

Purges all LinkedListSetEntry instances within this LinkedListSet.

Specified by:

purgeEntries in interface LinkedListSet<E extends LinkedListSetEntry<E,O>,O>

Returns:

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

copyEntries

public final LinkedListSetItem<E> copyEntries()

Description copied from interface: LinkedListSet

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

The returned copy is Thread safe to iterate.

Specified by:

copyEntries in interface LinkedListSet<E extends LinkedListSetEntry<E,O>,O>

Returns:

Head LinkedListSetItem of the copy.