Module org.jpo

Package org.jpo.cache

Class ThumbnailQueueRequest

java.lang.Object

org.jpo.cache.ThumbnailQueueRequest

All Implemented Interfaces:

Comparable<ThumbnailQueueRequest>

public class ThumbnailQueueRequest
extends Object
implements Comparable<ThumbnailQueueRequest>

The ThumbnailQueueRequest is the type of object that will sit on the ThumbnailCreationQueue with a references to the ThumbnailQueueRequestCallbackHandler and the queue priority. When the Thumbnail has been created the ThumbnailQueueRequestCallbackHandler.callbackThumbnailCreated(org.jpo.cache.ThumbnailQueueRequest) method will be fired and the caller can process the new Thumbnail.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ThumbnailQueueRequestCallbackHandler	callbackHandler	The target to notify that the Thumbnail is now ready
protected Boolean	isCanceled	A flag to indicate that the request was canceled.
protected final SortableDefaultMutableTreeNode	node	The node for which we are to create a thumbnail
protected QUEUE_PRIORITY	priority	the priority the request has on the queue.
protected final Dimension	size	The size we should scale the thumbnail to

Constructor Summary

Constructors

Constructor	Description
ThumbnailQueueRequest(ThumbnailQueueRequestCallbackHandler callbackHandler, SortableDefaultMutableTreeNode node, QUEUE_PRIORITY priority, Dimension size)	Constructs a ThumbnailQueueRequest object

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancel the request
int	compareTo(ThumbnailQueueRequest thumbnailQueueRequest)	Compares to another request based on priority.
boolean	equals(Object obj)	Compares to another request based on priority.
ImageIcon	getIcon()
SortableDefaultMutableTreeNode	getNode()	Returns the node for the request
Dimension	getSize()	The size the thumbnail should be scaled to
ThumbnailQueueRequestCallbackHandler	getThumbnailQueueRequestCallbackHandler()	returns the ThumbnailQueueRequestCallbackHandler that should be notified when the ImageIcon is ready
void	increasePriorityTo(QUEUE_PRIORITY newPriority)	Increases the priority of the request to the supplied higher priority if the supplied priority is higher.
boolean	isCanceled()
void	notifyCallbackHandler()	sends the notification that the Icon is available to the callback handler if the request was not canceled in the meantime.
void	setIcon(ImageIcon icon)	Sets the icon after the creation queue
void	setPriority(QUEUE_PRIORITY newPriority)	sets the priority in which the ThumbnailController is to be created.

Methods inherited from class java.lang.Object

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

Field Details

callbackHandler

protected final ThumbnailQueueRequestCallbackHandler callbackHandler

The target to notify that the Thumbnail is now ready

priority

protected QUEUE_PRIORITY priority

the priority the request has on the queue.

size

protected final Dimension size

The size we should scale the thumbnail to

node

protected final SortableDefaultMutableTreeNode node

The node for which we are to create a thumbnail

isCanceled

protected Boolean isCanceled

A flag to indicate that the request was canceled.

Constructor Details

ThumbnailQueueRequest

public ThumbnailQueueRequest(ThumbnailQueueRequestCallbackHandler callbackHandler,
 SortableDefaultMutableTreeNode node,
 QUEUE_PRIORITY priority,
 Dimension size)

Constructs a ThumbnailQueueRequest object

Parameters:

callbackHandler - The callback handler that will be notified when the image icon is ready

node - the node for which the image is to be created

priority - The queue priority with which the thumbnail is to be created Possible values are QUEUE_PRIORITY.HIGH_PRIORITY, QUEUE_PRIORITY.MEDIUM_PRIORITY, QUEUE_PRIORITY.LOW_PRIORITY and QUEUE_PRIORITY.LOWEST_PRIORITY.

size - the maximum size of the thumbnail

Method Details

getThumbnailQueueRequestCallbackHandler

public ThumbnailQueueRequestCallbackHandler getThumbnailQueueRequestCallbackHandler()

returns the ThumbnailQueueRequestCallbackHandler that should be notified when the ImageIcon is ready

Returns:

the thumbnail

notifyCallbackHandler

public void notifyCallbackHandler()

sends the notification that the Icon is available to the callback handler if the request was not canceled in the meantime.

setPriority

public void setPriority(QUEUE_PRIORITY newPriority)

sets the priority in which the ThumbnailController is to be created. The possible values are QUEUE_PRIORITY.LOWEST_PRIORITY, QUEUE_PRIORITY.LOW_PRIORITY, QUEUE_PRIORITY.MEDIUM_PRIORITY or QUEUE_PRIORITY.HIGH_PRIORITY. A high numeric value means less priority.

Parameters:

newPriority - The priority of the request: QUEUE_PRIORITY.LOW_PRIORITY, QUEUE_PRIORITY.MEDIUM_PRIORITY or QUEUE_PRIORITY.HIGH_PRIORITY

compareTo

public int compareTo(ThumbnailQueueRequest thumbnailQueueRequest)

Compares to another request based on priority.

Specified by:

compareTo in interface Comparable<ThumbnailQueueRequest>

Parameters:

thumbnailQueueRequest - The request to compare against

Returns:

a negative 0 or positive number as defined by the compareTo interface

equals

public boolean equals(Object obj)

Compares to another request based on priority.

Overrides:

equals in class Object

Parameters:

obj - The request to compare against

Returns:

if the priority is the same interface

increasePriorityTo

public void increasePriorityTo(QUEUE_PRIORITY newPriority)

Increases the priority of the request to the supplied higher priority if the supplied priority is higher.

Parameters:

newPriority - the new, possibly higher priority

getSize

public Dimension getSize()

The size the thumbnail should be scaled to

Returns:

the size

getNode

public SortableDefaultMutableTreeNode getNode()

Returns the node for the request

Returns:

the node

getIcon

public ImageIcon getIcon()

Returns:

the icon that was created

setIcon

public void setIcon(ImageIcon icon)

Sets the icon after the creation queue

Parameters:

icon - the new icon

isCanceled

public boolean isCanceled()

Returns:

true is the request is canceled

cancel

public void cancel()

Cancel the request