Top Description Fields Constructors Methods
org.springframework.jms.support

public Class QosSettings

extends Object
Class Inheritance
Imports
jakarta.jms.Message, org.springframework.lang.Nullable

Gather the Quality-of-Service settings that can be used when sending a message.
Author
Stephane Nicoll
Since
5.0

Field Summary

Modifier and TypeField and Description
private int
private int
private long

Constructor Summary

AccessConstructor and Description
public
QosSettings()

Create a new instance with the default settings.

public
QosSettings(int deliveryMode, int priority, long timeToLive)

Create a new instance with the specified settings.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
other
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
getDeliveryMode()

Return the delivery mode to use when sending a message.

public int
getPriority()

Return the priority of a message when sending.

public long
getTimeToLive()

Return the time-to-live of the message when sending.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setDeliveryMode(int
the delivery mode to use
deliveryMode
)

Set the delivery mode to use when sending a message.

public void
setPriority(int priority)

Set the priority of a message when sending.

public void
setTimeToLive(long
the message's lifetime (in milliseconds)
timeToLive
)

Set the time-to-live of the message when sending.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

deliveryModeback to summary
private int deliveryMode
priorityback to summary
private int priority
timeToLiveback to summary
private long timeToLive

Constructor Detail

QosSettingsback to summary
public QosSettings()

Create a new instance with the default settings.

See Also
Message#DEFAULT_DELIVERY_MODE, Message#DEFAULT_PRIORITY, Message#DEFAULT_TIME_TO_LIVE
QosSettingsback to summary
public QosSettings(int deliveryMode, int priority, long timeToLive)

Create a new instance with the specified settings.

Method Detail

equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getDeliveryModeback to summary
public int getDeliveryMode()

Return the delivery mode to use when sending a message.

getPriorityback to summary
public int getPriority()

Return the priority of a message when sending.

getTimeToLiveback to summary
public long getTimeToLive()

Return the time-to-live of the message when sending.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
setDeliveryModeback to summary
public void setDeliveryMode(int deliveryMode)

Set the delivery mode to use when sending a message. Default is the JMS Message default: "PERSISTENT".

Parameters
deliveryMode:int

the delivery mode to use

See Also
jakarta.jms.DeliveryMode#PERSISTENT, jakarta.jms.DeliveryMode#NON_PERSISTENT, jakarta.jms.Message#DEFAULT_DELIVERY_MODE, jakarta.jms.MessageProducer#send(jakarta.jms.Message, int, int, long)
setPriorityback to summary
public void setPriority(int priority)

Set the priority of a message when sending.

See Also
jakarta.jms.Message#DEFAULT_PRIORITY, jakarta.jms.MessageProducer#send(jakarta.jms.Message, int, int, long)
setTimeToLiveback to summary
public void setTimeToLive(long timeToLive)

Set the time-to-live of the message when sending.

Parameters
timeToLive:long

the message's lifetime (in milliseconds)

See Also
jakarta.jms.Message#DEFAULT_TIME_TO_LIVE, jakarta.jms.MessageProducer#send(jakarta.jms.Message, int, int, long)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override