QueueOptions (BlazingMQ Java SDK 0.0.10-SNAPSHOT API)

java.lang.Object
- com.bloomberg.bmq.QueueOptions

```
@Immutable
public class QueueOptions
extends Object
```
A value-semantic type for options related to a queue.
Provides a value-semantic type, QueueOptions, which is used to specify parameters for a queue. The following parameters are supported:
- maxUnconfirmedMessages: Maximum number of outstanding messages that can be sent by the broker without being confirmed.
- maxUnconfirmedBytes: Maximum accumulated bytes of all outstanding messages that can be sent by the broker without being confirmed.
- consumerPriority: Priority of a consumer with respect to delivery of messages.
- suspendsOnBadHostHealth: Sets whether queue should suspend when the host machine is unhealthy.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QueueOptions.Builder
A helper class to create immutable QueueOptions with custom settings.

Nested Classes
Modifier and Type	Class and Description
`static class`	`QueueOptions.Builder` A helper class to create immutable `QueueOptions` with custom settings.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`k_CONSUMER_PRIORITY_DEFAULT` Default priority of a consumer with respect to delivery of messages.
`static long`	`k_MAX_UNCONFIRMED_BYTES_DEFAULT` Default maximum accumulated bytes of all outstanding messages that can be sent by the broker without being confirmed.
`static long`	`k_MAX_UNCONFIRMED_MESSAGES_DEFAULT` Default maximum number of outstanding messages that can be sent by the broker without being confirmed.
`static boolean`	`k_SUSPENDS_ON_BAD_HOST_HEALTH_DEFAULT` By default, queue is not sensitive to host-health changes.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static QueueOptions.Builder`	`builder()` Returns a helper class object to create immutable `QueueOptions` with custom settings.
`static QueueOptions`	`createDefault()` Returns queue options with default values.
`boolean`	`equals(Object obj)` Returns true if this `QueueOptions` is equal to the specified `obj`, false otherwise.
`int`	`getConsumerPriority()` Returns priority of a consumer with respect to delivery of messages.
`long`	`getMaxUnconfirmedBytes()` Returns maximum accumulated bytes of all outstanding messages that can be sent by the broker without being confirmed.
`long`	`getMaxUnconfirmedMessages()` Returns maximum number of outstanding messages that can be sent by the broker without being confirmed.
`boolean`	`getSuspendsOnBadHostHealth()` Gets whether queue suspends operation when the host machine is unhealthy.
`boolean`	`hasConsumerPriority()` Returns whether `consumerPriority` has been set for this object, or whether it implicitly holds `k_CONSUMER_PRIORITY_DEFAULT`.
`int`	`hashCode()` Returns a hash code value for this `QueueOptions` object.
`boolean`	`hasMaxUnconfirmedBytes()` Returns whether `maxUnconfirmedBytes` has been set for this object, or whether it implicitly holds `k_MAX_UNCONFIRMED_BYTES_DEFAULT`.
`boolean`	`hasMaxUnconfirmedMessages()` Returns whether `maxUnconfirmedMessages` has been set for this object, or whether it implicitly holds `k_MAX_UNCONFIRMED_MESSAGES_DEFAULT`.
`boolean`	`hasSuspendsOnBadHostHealth()` Returns whether `suspendsOnBadHostHealth` has been set for this object, or whether it implicitly holds `k_SUSPENDS_ON_BAD_HOST_HEALTH_DEFAULT`.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - k_MAX_UNCONFIRMED_MESSAGES_DEFAULT
```
public static final long k_MAX_UNCONFIRMED_MESSAGES_DEFAULT
```
    Default maximum number of outstanding messages that can be sent by the broker without being confirmed.
    
    See Also:
    
    Constant Field Values
  - k_MAX_UNCONFIRMED_BYTES_DEFAULT
```
public static final long k_MAX_UNCONFIRMED_BYTES_DEFAULT
```
    Default maximum accumulated bytes of all outstanding messages that can be sent by the broker without being confirmed.
    
    See Also:
    
    Constant Field Values
  - k_CONSUMER_PRIORITY_DEFAULT
```
public static final int k_CONSUMER_PRIORITY_DEFAULT
```
    Default priority of a consumer with respect to delivery of messages.
    
    See Also:
    
    Constant Field Values
  - k_SUSPENDS_ON_BAD_HOST_HEALTH_DEFAULT
```
public static final boolean k_SUSPENDS_ON_BAD_HOST_HEALTH_DEFAULT
```
    By default, queue is not sensitive to host-health changes.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Returns true if this QueueOptions is equal to the specified obj, false otherwise. Two QueueOptions are equal if they have equal properties.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - QueueOptions object to compare with
    
    Returns:
    
    boolean true if QueueOptions are equal, false otherwise
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for this QueueOptions object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    int a hash code value for this object.
  - getMaxUnconfirmedMessages
```
public long getMaxUnconfirmedMessages()
```
    Returns maximum number of outstanding messages that can be sent by the broker without being confirmed. If not set, returns default value.
    
    Returns:
    
    long maximum number of outstanding messages
  - hasMaxUnconfirmedMessages
```
public boolean hasMaxUnconfirmedMessages()
```
    Returns whether maxUnconfirmedMessages has been set for this object, or whether it implicitly holds k_MAX_UNCONFIRMED_MESSAGES_DEFAULT.
    
    Returns:
    
    boolean true if maxUnconfirmedMessages has been set.
  - getMaxUnconfirmedBytes
```
public long getMaxUnconfirmedBytes()
```
    Returns maximum accumulated bytes of all outstanding messages that can be sent by the broker without being confirmed. If not set returns default value.
    
    Returns:
    
    long maximum accumulated bytes of all outstanding messages without being confirmed
  - hasMaxUnconfirmedBytes
```
public boolean hasMaxUnconfirmedBytes()
```
    Returns whether maxUnconfirmedBytes has been set for this object, or whether it implicitly holds k_MAX_UNCONFIRMED_BYTES_DEFAULT.
    
    Returns:
    
    boolean true if maxUnconfirmedBytes has been set.
  - getConsumerPriority
```
public int getConsumerPriority()
```
    Returns priority of a consumer with respect to delivery of messages. If not set, returns default value.
    
    Returns:
    
    int priority of a consumer
  - hasConsumerPriority
```
public boolean hasConsumerPriority()
```
    Returns whether consumerPriority has been set for this object, or whether it implicitly holds k_CONSUMER_PRIORITY_DEFAULT.
    
    Returns:
    
    boolean true if consumerPriority has been set.
  - getSuspendsOnBadHostHealth
```
public boolean getSuspendsOnBadHostHealth()
```
    Gets whether queue suspends operation when the host machine is unhealthy. If not set, returns default value.
    
    Returns:
    
    boolean true if queue suspends operation when the host machine is unhealthy
  - hasSuspendsOnBadHostHealth
```
public boolean hasSuspendsOnBadHostHealth()
```
    Returns whether suspendsOnBadHostHealth has been set for this object, or whether it implicitly holds k_SUSPENDS_ON_BAD_HOST_HEALTH_DEFAULT.
    
    Returns:
    
    boolean true if suspendsOnBadHostHealth has been set.
  - builder
```
public static QueueOptions.Builder builder()
```
    Returns a helper class object to create immutable QueueOptions with custom settings.
    
    Returns:
    
    Builder a helper class object to create immutable QueueOptions
  - createDefault
```
public static QueueOptions createDefault()
```
    Returns queue options with default values.
    
    Returns:
    
    QueueOptions queue option object with default values
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class QueueOptions

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

k_MAX_UNCONFIRMED_MESSAGES_DEFAULT

k_MAX_UNCONFIRMED_BYTES_DEFAULT

k_CONSUMER_PRIORITY_DEFAULT

k_SUSPENDS_ON_BAD_HOST_HEALTH_DEFAULT

Method Detail

equals

hashCode

getMaxUnconfirmedMessages

hasMaxUnconfirmedMessages

getMaxUnconfirmedBytes

hasMaxUnconfirmedBytes

getConsumerPriority

hasConsumerPriority

getSuspendsOnBadHostHealth

hasSuspendsOnBadHostHealth

builder

createDefault

toString