org.springframework.web.socket

Class WebSocketMessage<T>

java.lang.Object

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

Direct Known Subclasses:

BinaryMessage, TextMessage

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

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

Since:

4.0

Author:

Rossen Stoyanchev

See Also:

BinaryMessage, TextMessage

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
WebSocketMessage(T payload, boolean isLast) Create a new WebSocketMessage instance with the given payload.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
T	getPayload() Returns the message payload.
protected abstract int	getPayloadSize()
int	hashCode()
boolean	isLast() Whether this is the last part of a message, when partial message support on a WebSocketHandler is enabled.
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

Field Detail

payload

private final T payload

last

private final boolean last

Constructor Detail

WebSocketMessage

WebSocketMessage(T payload,
                boolean isLast)

Create a new WebSocketMessage instance with the given payload.

Parameters:

payload - a non-null payload

Method Detail

getPayload

public T getPayload()

Returns the message payload. This will never be null.

isLast

public boolean isLast()

Whether this is the last part of a message, when partial message support on a WebSocketHandler is enabled. If partial message support is not enabled the returned value is always true.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals 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()

getPayloadSize

protected abstract int getPayloadSize()