com.hcl.domino.mq

Enum MessageQueue.IMQCallback.Action

java.lang.Object

java.lang.Enum<MessageQueue.IMQCallback.Action>

com.hcl.domino.mq.MessageQueue.IMQCallback.Action

All Implemented Interfaces:

Serializable, Comparable<MessageQueue.IMQCallback.Action>

Enclosing interface:

MessageQueue.IMQCallback

public static enum MessageQueue.IMQCallback.Action
extends Enum<MessageQueue.IMQCallback.Action>

Enum Constant Summary

Enum Constants

Enum Constant and Description
Abort Return from MQScan immediately without dequeueing a message. Note that MQScan returns ERR_MQSCAN_ABORT
Continue Process the next message
Delete Remove the current message from the message queue and continue the enumeration
Dequeue Remove the message from the queue, terminate the enumeration, and return the current message to the caller of MQScan. If the Buffer is smaller than the message, MQScan can return ERR_MQ_BFR_TOO_SMALL.

Method Summary

Modifier and Type	Method and Description
static MessageQueue.IMQCallback.Action	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageQueue.IMQCallback.Action[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Continue

public static final MessageQueue.IMQCallback.Action Continue

Process the next message

Abort

public static final MessageQueue.IMQCallback.Action Abort

Return from MQScan immediately without dequeueing a message.
Note that MQScan returns ERR_MQSCAN_ABORT

Dequeue

public static final MessageQueue.IMQCallback.Action Dequeue

Remove the message from the queue, terminate the enumeration, and return the current message to the caller of MQScan.
If the Buffer is smaller than the message, MQScan can return ERR_MQ_BFR_TOO_SMALL.

Delete

public static final MessageQueue.IMQCallback.Action Delete

Remove the current message from the message queue and continue the enumeration

Method Detail

values

public static MessageQueue.IMQCallback.Action[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MessageQueue.IMQCallback.Action c : MessageQueue.IMQCallback.Action.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MessageQueue.IMQCallback.Action valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null