org.springframework.web.socket

Class AbstractWebSocketMessage<T>

java.lang.Object

org.springframework.web.socket.AbstractWebSocketMessage<T>

All Implemented Interfaces:

WebSocketMessage<T>

Direct Known Subclasses:

BinaryMessage, PingMessage, PongMessage, TextMessage

public abstract class AbstractWebSocketMessage<T>
extends java.lang.Object
implements WebSocketMessage<T>

A message that can be handled or sent on a WebSocket connection.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	last
private T	payload

Constructor Summary

Constructors

Constructor and Description
AbstractWebSocketMessage(T payload) Create a new WebSocket message with the given payload.
AbstractWebSocketMessage(T payload, boolean isLast) Create a new WebSocket message given payload representing the full or partial message content.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
T	getPayload() Return the message payload, never be null.
int	hashCode()
boolean	isLast() Whether this is the last part of a message sent as a series of partial messages.
java.lang.String	toString()
protected abstract java.lang.String	toStringPayload()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.web.socket.WebSocketMessage

getPayloadLength

Field Detail

payload

private final T payload

last

private final boolean last

Constructor Detail

AbstractWebSocketMessage

AbstractWebSocketMessage(T payload)

Create a new WebSocket message with the given payload.

Parameters:

payload - the non-null payload

AbstractWebSocketMessage

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 - the non-null payload

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

Method Detail

getPayload

public T getPayload()

Return the message payload, never be null.

Specified by:

getPayload in interface WebSocketMessage<T>

isLast

public boolean isLast()

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

Specified by:

isLast in interface WebSocketMessage<T>

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringPayload

protected abstract java.lang.String toStringPayload()