|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.umber.catalan.process.queue.QueueManager
Manager for a group of named IQueue objects. Queues can be created, destroyed, renamed, and merged together, unless the QueueManager is read-only.
Constructor Summary | |
QueueManager()
Creates a new instance of QueueManager with no existing queues. |
|
QueueManager(java.util.Map queues)
Creates a new instance of QueueManager with the given queues. |
Method Summary | |
void |
addQueue(java.lang.String name,
IQueue queue)
Adds a named queue. |
void |
copyNodes(java.lang.String sourceQueue,
java.lang.String destQueue,
int destIndex,
NodeSelection sourceSelection)
Copies nodes from one IQueue to another. |
void |
deleteNodes(java.lang.String sourceQueue,
NodeSelection sourceSelection)
Deletes the selected nodes in the given queue. |
void |
deleteQueue(java.lang.String name)
Removes the queue with the given name. |
IQueue |
getDefaultQueue()
Retrieves the default IQueue. |
IQueue |
getQueue(java.lang.String queueName)
Retrieves the named IQueue object, or null if queue does not exist. |
java.lang.String[] |
getQueueNames()
Retrieves the names of all queues. |
IQueue[] |
getQueues()
Retrieves all IQueue objects. |
void |
moveNodes(java.lang.String sourceQueue,
java.lang.String destQueue,
int destIndex,
NodeSelection sourceSelection)
Moves the selected nodes from the source queue to the destination queue. |
void |
renameQueue(java.lang.String oldName,
java.lang.String newName)
Renames the queue to the given name. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public QueueManager()
public QueueManager(java.util.Map queues) throws QueueException
getDefaultQueue()
.
queues
- Map of String keys to IQueue values
QueueException
- if the queues Map contains any
null values or bad typesMethod Detail |
public IQueue getDefaultQueue()
getQueues()
. The default queue
will always exist.
public java.lang.String[] getQueueNames()
public IQueue[] getQueues()
public IQueue getQueue(java.lang.String queueName)
queueName
- name of the queue
public void addQueue(java.lang.String name, IQueue queue) throws QueueException
name
- name of the new queuequeue
- IQueue object to add
QueueException
- if a queue with the given name already
exists, or the queue or name is nullpublic void deleteQueue(java.lang.String name) throws QueueException
name
- name of the queue to destroy
QueueException
- if the IQueue is read-only or if attempting to
delete default queuepublic void renameQueue(java.lang.String oldName, java.lang.String newName) throws QueueException
oldName
- current name of the queuenewName
- new name for the queue
QueueException
- if a queue with the new name already
exists, or if the IQueue is read-only, or if attempting to
rename default queuepublic void copyNodes(java.lang.String sourceQueue, java.lang.String destQueue, int destIndex, NodeSelection sourceSelection) throws QueueException
sourceQueue
- name of queue to copy nodes fromdestQueue
- name of queue to copy nodes todestIndex
- index in destination queue to insert nodes atsourceSelection
- selection of source queue nodes to copy
QueueException
- if source queue does not exist or if destination
queue is read-onlypublic void moveNodes(java.lang.String sourceQueue, java.lang.String destQueue, int destIndex, NodeSelection sourceSelection) throws QueueException
sourceQueue
- name of queue to move nodes fromdestQueue
- name of queue to move nodes todestIndex
- index in destination queue to insert nodes atsourceSelection
- selection of source queue nodes to move
QueueException
- if source queue does not exist or if source or
destination queue is read-onlypublic void deleteNodes(java.lang.String sourceQueue, NodeSelection sourceSelection) throws QueueException
sourceQueue
- name of queue to delete nodes insourceSelection
- selection of nodes to delete
QueueException
- if source queue does not exist or if source
queue is read-only
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |