org.jboss.cache.eviction
Class ElementSizeQueue

java.lang.Object
  org.jboss.cache.eviction.ElementSizeQueue

All Implemented Interfaces:

Iterable<NodeEntry>, EvictionQueue, SortedEvictionQueue

public class ElementSizeQueue
extends Object
implements SortedEvictionQueue

Version:

$Revision: 7168 $

Author:

Daniel Huang

Nested Class Summary

protected static class

ElementSizeQueue.MaxElementComparator Comparator class for Max Elements.

Constructor Summary

protected

ElementSizeQueue()

Method Summary

void	addNodeEntry(NodeEntry entry) Add a NodeEntry to the queue.
void	clear() Clear the queue.
boolean	containsNodeEntry(NodeEntry entry) Check if queue contains the given NodeEntry.
protected List<NodeEntry>	getEvictionList()
NodeEntry	getFirstNodeEntry() Get the first entry in the queue.
NodeEntry	getNodeEntry(Fqn fqn) Retrieve a node entry by Fqn.
NodeEntry	getNodeEntry(String fqn)
int	getNumberOfElements() Get the number of elements in the queue.
int	getNumberOfNodes() Get the number of nodes in the queue.
protected Set<NodeEntry>	getRemovalQueue()
Iterator<NodeEntry>	iterator()
void	modifyElementCount(int difference)
protected void	prune()
void	removeNodeEntry(NodeEntry entry) Remove a NodeEntry from queue.
void	resortEvictionQueue() Provide contract to resort a sorted queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementSizeQueue

protected ElementSizeQueue()

Method Detail

resortEvictionQueue

public void resortEvictionQueue()

Description copied from interface: SortedEvictionQueue

Provide contract to resort a sorted queue.

Specified by:

resortEvictionQueue in interface SortedEvictionQueue

getFirstNodeEntry

public NodeEntry getFirstNodeEntry()

Description copied from interface: EvictionQueue

Get the first entry in the queue.

If there are no entries in queue, this method will return null.

The first node returned is expected to be the first node to evict.

Specified by:

getFirstNodeEntry in interface EvictionQueue

Returns:

first NodeEntry in queue.

getNodeEntry

public NodeEntry getNodeEntry(Fqn fqn)

Description copied from interface: EvictionQueue

Retrieve a node entry by Fqn.

This will return null if the entry is not found.

Specified by:

getNodeEntry in interface EvictionQueue

Parameters:

fqn - Fqn of the node entry to retrieve.

Returns:

Node Entry object associated with given Fqn param.

getNodeEntry

public NodeEntry getNodeEntry(String fqn)

Specified by:

getNodeEntry in interface EvictionQueue

containsNodeEntry

public boolean containsNodeEntry(NodeEntry entry)

Description copied from interface: EvictionQueue

Check if queue contains the given NodeEntry.

Specified by:

containsNodeEntry in interface EvictionQueue

Parameters:

entry - NodeEntry to check for existence in queue.

Returns:

true/false if NodeEntry exists in queue.

removeNodeEntry

public void removeNodeEntry(NodeEntry entry)

Description copied from interface: EvictionQueue

Remove a NodeEntry from queue.

If the NodeEntry does not exist in the queue, this method will return normally.

Specified by:

removeNodeEntry in interface EvictionQueue

Parameters:

entry - The NodeEntry to remove from queue.

addNodeEntry

public void addNodeEntry(NodeEntry entry)

Description copied from interface: EvictionQueue

Add a NodeEntry to the queue.

Specified by:

addNodeEntry in interface EvictionQueue

Parameters:

entry - The NodeEntry to add to queue.

getNumberOfNodes

public int getNumberOfNodes()

Description copied from interface: EvictionQueue

Get the number of nodes in the queue.

Specified by:

getNumberOfNodes in interface EvictionQueue

Returns:

The number of nodes in the queue.

getNumberOfElements

public int getNumberOfElements()

Description copied from interface: EvictionQueue

Get the number of elements in the queue.

Specified by:

getNumberOfElements in interface EvictionQueue

Returns:

The number of elements in the queue.

modifyElementCount

public void modifyElementCount(int difference)

Specified by:

modifyElementCount in interface EvictionQueue

clear

public void clear()

Description copied from interface: EvictionQueue

Clear the queue.

Specified by:

clear in interface EvictionQueue

getEvictionList

protected final List<NodeEntry> getEvictionList()

getRemovalQueue

protected final Set<NodeEntry> getRemovalQueue()

prune

protected final void prune()

iterator

public Iterator<NodeEntry> iterator()

Specified by:

iterator in interface Iterable<NodeEntry>