com.ibm.ras
Interface RASIQueue
All known implementing classes:
Deprecated. As of WAS 6.0, recommend using java.util.logging
- public interface RASIQueue
RASIQueue
interface describes those methods which
must be implemented in order to be a queue for RAS events.
See Also:
Method Summary
Modifier and Type | Method and Description |
---|---|
|
dequeue()
Deprecated. Removes an object from the queue.
|
|
enqueue(java.lang.Object object)
Deprecated. Adds an object to the queue.
|
|
firstObject()
Deprecated. Returns the first object on the queue, but does not remove it from
the queue.
|
|
getMaximumQueueSize()
Deprecated. Gets the maximum number of objects which this queue will hold.
|
|
getQueueSize()
Deprecated. Gets the current number of objects in this queue.
|
|
isCircular()
Deprecated. Determines if the queue is circular.
|
|
isEmpty()
Deprecated. Determines if the queue is empty.
|
|
isFull()
Deprecated. Determines if the queue is full.
|
|
requeue(java.lang.Object object)
Deprecated. Returns an object to the front of the queue.
|
Method Detail
getQueueSize
- int getQueueSize()
Deprecated.
Gets the current number of objects in this queue.
Returns:
The current queue size.
getMaximumQueueSize
- int getMaximumQueueSize()
Deprecated.
Gets the maximum number of objects which this queue will hold. If
this maximum is exceeded, new events will be discarded. If not set,
the default value of 10,000 is returned.
Returns:
The maximum queue size.
isEmpty
- boolean isEmpty()
Deprecated.
Determines if the queue is empty.
Returns:
true
if the queue is empty or false
otherwise. isFull
- boolean isFull()
Deprecated.
Determines if the queue is full.
Returns:
true
if the queue is full or false
otherwise. isCircular
- boolean isCircular()
Deprecated.
Determines if the queue is circular. A circular queue always accepts
new objects. If all slots are full, a new object replaces the oldest
object in the queue.
Returns:
true
if this queue is circular, or false
otherwise. enqueue
- void enqueue(java.lang.Object object)
- throws RASQueueFullException
Deprecated.
Adds an object to the queue. If the object is
null
,
nothing is enqueued.
Parameters:
object
- The object to be placed on the queue. Throws:
RASQueueFullException
- This exception is thrown if the queue is full. dequeue
- java.lang.Object dequeue()
- throws RASQueueEmptyException
Deprecated.
Removes an object from the queue.
Returns:
The first object in the queue.
Throws:
RASQueueEmptyException
- This exception is thrown if the queue is empty. requeue
- void requeue(java.lang.Object object)
Deprecated.
Returns an object to the front of the queue. If the object is
null
, nothing is enqueued.
Parameters:
object
- The object to be placed on the queue. firstObject
- java.lang.Object firstObject()
- throws RASQueueEmptyException
Deprecated.
Returns the first object on the queue, but does not remove it from
the queue.
Returns:
The first object in the queue.
Throws:
RASQueueEmptyException
- This exception is thrown if the queue is empty.