Top Description Fields Constructors Methods
org.springframework.web.socket

public abstract Class AbstractWebSocketMessage<T>

extends Object
implements WebSocketMessage<T>
Class Inheritance
All Implemented Interfaces
org.springframework.web.socket.WebSocketMessage
Known Direct Subclasses
org.springframework.web.socket.BinaryMessage, org.springframework.web.socket.PingMessage, org.springframework.web.socket.PongMessage, org.springframework.web.socket.TextMessage
Type Parameters
<T>
the payload type
Imports
org.springframework.lang.Nullable, org.springframework.util.Assert, .ObjectUtils
A message that can be handled or sent on a WebSocket connection.
Author
Rossen Stoyanchev
Since
4.0

Field Summary

Modifier and TypeField and Description
private final boolean
last

private final T
payload

Constructor Summary

AccessConstructor and Description
pack-priv
AbstractWebSocketMessage(T
the non-null payload
payload)

Create a new WebSocket message with the given payload.

pack-priv
AbstractWebSocketMessage(T
the non-null payload
payload, boolean
if the message is the last of a series of partial messages
isLast)

Create a new WebSocket message given payload representing the full or partial message content.

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 T
getPayload()

Implements org.springframework.web.socket.WebSocketMessage.getPayload.

Return the message payload (never null).

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isLast()

Implements org.springframework.web.socket.WebSocketMessage.isLast.

Whether this is the last part of a message sent as a series of partial messages.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

protected abstract String
toStringPayload()

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

lastback to summary
private final boolean last
payloadback to summary
private final T payload

Constructor Detail

AbstractWebSocketMessageback to summary
pack-priv AbstractWebSocketMessage(T payload)

Create a new WebSocket message with the given payload.

Parameters
payload:T

the non-null payload

AbstractWebSocketMessageback to summary
pack-priv AbstractWebSocketMessage(T payload, boolean isLast)

Create a new WebSocket message given payload representing the full or partial message content. When the isLast boolean flag is set to false the message is sent as partial content and more partial messages will be expected until the boolean flag is set to true.

Parameters
payload:T

the non-null payload

isLast:boolean

if the message is the last of a series of partial messages

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
getPayloadback to summary
public T getPayload()

Implements org.springframework.web.socket.WebSocketMessage.getPayload.

Return the message payload (never null).

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
isLastback to summary
public boolean isLast()

Implements org.springframework.web.socket.WebSocketMessage.isLast.

Whether this is the last part of a message sent as a series of partial messages.

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
toStringPayloadback to summary
protected abstract String toStringPayload()