Spring Framework 6.1.4 · org.springframework.web.socket.sockjs.frame.SockJsFrame

Modifier and Type	Field and Description
public static final Charset	CHARSET The charset used by SockJS.
private static final SockJsFrame	CLOSE_ANOTHER_CONNECTION_OPEN_FRAME
private static final SockJsFrame	CLOSE_GO_AWAY_FRAME
private final String	content
private static final SockJsFrame	HEARTBEAT_FRAME
private static final SockJsFrame	OPEN_FRAME
private final SockJsFrameType	type

Access	Constructor and Description
public	SockJsFrame(String the content (must be a non-empty and represent a valid SockJS frame) content) Create a new instance frame with the given frame content.

Method Summary

Modifier and Type	Method and Description
public static SockJsFrame	closeFrame(int code, String reason)
public static SockJsFrame	closeFrameAnotherConnectionOpen()
public static SockJsFrame	closeFrameGoAway()
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 String	getContent() Return the SockJS frame content (never `null`).
public byte[]	getContentBytes() Return the SockJS frame content as a byte array.
public String	getFrameData() Return data contained in a SockJS "message" and "close" frames.
public SockJsFrameType	getType() Return the SockJS frame type.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public static SockJsFrame	heartbeatFrame()
public static SockJsFrame	messageFrame(SockJsMessageCodec codec, String... messages)
public static SockJsFrame	openFrame()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

CHARSET	back to summary
public static final Charset CHARSET The charset used by SockJS.

CLOSE_ANOTHER_CONNECTION_OPEN_FRAME	back to summary
private static final SockJsFrame CLOSE_ANOTHER_CONNECTION_OPEN_FRAME

CLOSE_GO_AWAY_FRAME	back to summary
private static final SockJsFrame CLOSE_GO_AWAY_FRAME

content	back to summary
private final String content

HEARTBEAT_FRAME	back to summary
private static final SockJsFrame HEARTBEAT_FRAME

OPEN_FRAME	back to summary
private static final SockJsFrame OPEN_FRAME

type	back to summary
private final SockJsFrameType type

SockJsFrame	back to summary
public SockJsFrame(String content) Create a new instance frame with the given frame content. Parameters content:String the content (must be a non-empty and represent a valid SockJS frame)

Method Detail

closeFrame	back to summary
public static SockJsFrame closeFrame(int code, String reason)

closeFrameAnotherConnectionOpen	back to summary
public static SockJsFrame closeFrameAnotherConnectionOpen()

closeFrameGoAway	back to summary
public static SockJsFrame closeFrameGoAway()

equals back to summary

equals	back 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

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

getContent	back to summary
public String getContent() Return the SockJS frame content (never `null`).

getContentBytes	back to summary
public byte[] getContentBytes() Return the SockJS frame content as a byte array.

getFrameData back to summary

getFrameData	back to summary
public String getFrameData() Return data contained in a SockJS "message" and "close" frames. Otherwise for SockJS "open" and "close" frames, which do not contain data, return `null`. Annotations @Nullable

public String getFrameData()

Return data contained in a SockJS "message" and "close" frames. Otherwise for SockJS "open" and "close" frames, which do not contain data, return null.

Annotations

@Nullable

getType	back to summary
public SockJsFrameType getType() Return the SockJS frame type.

hashCode back to summary

hashCode	back 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

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

heartbeatFrame	back to summary
public static SockJsFrame heartbeatFrame()

messageFrame	back to summary
public static SockJsFrame messageFrame(SockJsMessageCodec codec, String... messages)

openFrame	back to summary
public static SockJsFrame openFrame()

toString back to summary

toString	back 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

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

public Class SockJsFrame

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail