com.bloomberg.bmq

Enum QueueFlags

java.lang.Object

java.lang.Enum<QueueFlags>

com.bloomberg.bmq.QueueFlags

All Implemented Interfaces:

Serializable, Comparable<QueueFlags>

@Immutable
public enum QueueFlags
extends Enum<QueueFlags>

Represents all the flags that can be used at AbstractSession.getQueue(com.bloomberg.bmq.Uri, long, com.bloomberg.bmq.QueueEventHandler, com.bloomberg.bmq.AckMessageHandler, com.bloomberg.bmq.PushMessageHandler). Each value of the enum correspond to a bit of a bit-mask integer. It also exposes a set of utilities to manipulate such bit-mask value.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACK Set to indicate interested in receiving ACK events for all message posted
ADMIN The queue is opened in admin mode (valid only for BlazingMQ admin tasks).
EMPTY
READ The queue is opened for consuming messages.
WRITE The queue is opened for posting messages.

Method Summary

Modifier and Type	Method and Description
static boolean	isAck(long flags) Returns true if the specified flags represent ack required.
static boolean	isAdmin(long flags) Returns true if the specified flags represent an admin.
static boolean	isReader(long flags) Returns true if the specified flags represent a reader.
static boolean	isWriter(long flags) Returns true if the specified flags represent a writer.
static long	setAck(long flags) Sets the specified flags representation for ack.
static long	setAdmin(long flags) Sets the specified flags representation for admin.
static long	setReader(long flags) Sets the specified flags representation for reader.
static long	setWriter(long flags) Sets the specified flags representation for writer.
int	toInt() Returns integer representation of this enum value.
static QueueFlags	valueOf(String name) Returns the enum constant of this type with the specified name.
static QueueFlags[]	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

ADMIN

public static final QueueFlags ADMIN

The queue is opened in admin mode (valid only for BlazingMQ admin tasks).

READ

public static final QueueFlags READ

The queue is opened for consuming messages.

WRITE

public static final QueueFlags WRITE

The queue is opened for posting messages.

ACK

public static final QueueFlags ACK

Set to indicate interested in receiving ACK events for all message posted

EMPTY

public static final QueueFlags EMPTY

Method Detail

values

public static QueueFlags[] 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 (QueueFlags c : QueueFlags.values())
    System.out.println(c);

Returns:

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

valueOf

public static QueueFlags 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

toInt

public int toInt()

Returns integer representation of this enum value.

Returns:

int this enum value as an integer

setReader

public static long setReader(long flags)

Sets the specified flags representation for reader.

Parameters:

flags - initial flags value to modify

Returns:

long resulting flags value

setAdmin

public static long setAdmin(long flags)

Sets the specified flags representation for admin.

Parameters:

flags - initial flags value to modify

Returns:

long resulting flags value

setWriter

public static long setWriter(long flags)

Sets the specified flags representation for writer.

Parameters:

flags - initial flags value to modify

Returns:

long resulting flags value

setAck

public static long setAck(long flags)

Sets the specified flags representation for ack.

Parameters:

flags - initial flags value to modify

Returns:

long resulting flags value

isReader

public static boolean isReader(long flags)

Returns true if the specified flags represent a reader.

Parameters:

flags - flags value to check

Returns:

boolean true if the reader bit is set, false otherwise

isAdmin

public static boolean isAdmin(long flags)

Returns true if the specified flags represent an admin.

Parameters:

flags - flags value to check

Returns:

boolean true if the admin bit is set, false otherwise

isWriter

public static boolean isWriter(long flags)

Returns true if the specified flags represent a writer.

Parameters:

flags - flags value to check

Returns:

boolean true if the writer bit is set, false otherwise

isAck

public static boolean isAck(long flags)

Returns true if the specified flags represent ack required.

Parameters:

flags - flags value to check

Returns:

boolean true if the ack required bit is set, false otherwise