All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface jdce.util.message.jdceMessageQueueOperations

public interface jdceMessageQueueOperations
Message Queue Operations

Version:
0.5 20 April 1998
Author:
Shrideep Pallickara

Method Index

 o addItem(Object)
Adds an Item to the message Queue
 o dataAvailable()
Report the availability of data on the Message Queue
 o elements()
Return an enumeration of all the Widgets in the message queue
 o nextItem()
Get the next Item from the message Queue
 o peekItem()
Returns the head of the jdceMessageQueue
 o queueSize()
Query the queue Size, corresponds to the number of messages unprocessed in the messageQueue.
 o removeAllItems()
Removes all Widgets from the message Queue.
 o removeItem(Object)
Removes an Item from the message Queue.
 o toString()
Convert the entire MessageQueue into a String

Methods

 o addItem
 public abstract void addItem(Object object)
Adds an Item to the message Queue

Parameters:
obj - The message to be added to the Message Queue, this could be either a jdceMessage type or any Object Type
See Also:
jdceMessage, removeItem
 o nextItem
 public abstract Object nextItem()
Get the next Item from the message Queue

Returns:
object The next messageWidget in the MessageQueue.
See Also:
jdceMessage, removeAllItems, addItem
 o removeItem
 public abstract Object removeItem(Object _object)
Removes an Item from the message Queue. This corresponds to the Object used as the parameter.

Parameters:
obj - The message to be removed from the Message Queue, this could be either a jdceMessage type or any Object Type
See Also:
jdceMessage, removeAllItems, addItem
 o removeAllItems
 public abstract void removeAllItems()
Removes all Widgets from the message Queue. This corresponds to the Object used as the parameter.

Parameters:
obj - The message to be removed from the Message Queue, this could be either a jdceMessage type or any Object Type
See Also:
jdceMessage, nextItem, addItem
 o peekItem
 public abstract Object peekItem()
Returns the head of the jdceMessageQueue

See Also:
nextItem, addItem
 o dataAvailable
 public abstract boolean dataAvailable()
Report the availability of data on the Message Queue

Returns:
true If there is data available
 o queueSize
 public abstract int queueSize()
Query the queue Size, corresponds to the number of messages unprocessed in the messageQueue.

Returns:
size the Message Queue length
See Also:
dataAvailable
 o elements
 public abstract Enumeration elements()
Return an enumeration of all the Widgets in the message queue

Returns:
enum The jdceQueueEnumerator
 o toString
 public abstract String toString()
Convert the entire MessageQueue into a String

Returns:
string The String Representation of all the Widgets in the Queue
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index