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

public Class GenericMessage<T>

extends Object
implements Message<T>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.springframework.messaging.Message
Known Direct Subclasses
org.springframework.messaging.support.ErrorMessage
Type Parameters
<T>
the payload type
Imports
java.io.Serializable, java.util.Map, org.springframework.lang.Nullable, org.springframework.messaging.Message, .MessageHeaders, org.springframework.util.Assert, .ObjectUtils

An implementation of Message with a generic payload. Once created, a GenericMessage is immutable.
Author
Mark Fisher
Since
4.0
See Also
MessageBuilder

Field Summary

Modifier and TypeField and Description
private final MessageHeaders
private final T
private static final long

Constructor Summary

AccessConstructor and Description
public
GenericMessage(T
the message payload (never null)
payload
)

Create a new message with the given payload.

public
GenericMessage(T
the message payload (never null)
payload
,
Map<String, Object>
message headers to use for initialization
headers
)

Create a new message with the given payload and headers.

public
GenericMessage(T
the message payload (never null)
payload
,
MessageHeaders
message headers
headers
)

A constructor with the MessageHeaders instance to use.

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 MessageHeaders
getHeaders()

Implements org.springframework.messaging.Message.getHeaders.

Return message headers for the message (never null but may be empty).

public T
getPayload()

Implements org.springframework.messaging.Message.getPayload.

Return the message payload.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

headersback to summary
private final MessageHeaders headers
payloadback to summary
private final T payload
Annotations
@SuppressWarnings:serial
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

GenericMessageback to summary
public GenericMessage(T payload)

Create a new message with the given payload.

Parameters
payload:T

the message payload (never null)

GenericMessageback to summary
public GenericMessage(T payload, Map<String, Object> headers)

Create a new message with the given payload and headers. The content of the given header map is copied.

Parameters
payload:T

the message payload (never null)

headers:Map<String, Object>

message headers to use for initialization

GenericMessageback to summary
public GenericMessage(T payload, MessageHeaders headers)

A constructor with the MessageHeaders instance to use.

Note

the given MessageHeaders instance is used directly in the new message, i.e. it is not copied.

Parameters
payload:T

the message payload (never null)

headers:MessageHeaders

message headers

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
getHeadersback to summary
public MessageHeaders getHeaders()

Implements org.springframework.messaging.Message.getHeaders.

Doc from org.springframework.messaging.Message.getHeaders.

Return message headers for the message (never null but may be empty).

Annotations
@Override
getPayloadback to summary
public T getPayload()

Implements org.springframework.messaging.Message.getPayload.

Doc from org.springframework.messaging.Message.getPayload.

Return the message payload.

Annotations
@Override
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
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