org.snf4j.websocket.frame

Class TextFrame

java.lang.Object

org.snf4j.websocket.frame.Frame

org.snf4j.websocket.frame.DataFrame

org.snf4j.websocket.frame.TextFrame

Direct Known Subclasses:

AggregatedTextFrame

public class TextFrame
extends DataFrame

Web Socket text frame.

Author:

SNF4J.ORG

Field Summary

Fields inherited from class org.snf4j.websocket.frame.Frame

payload, RSV1, RSV2, RSV3

Constructor Summary

Constructors

Constructor and Description
TextFrame() Constructs an empty Web Socket text frame.
TextFrame(boolean finalFragment, int rsvBits, byte[] payload) Constructs a Web Socket text frame containing binary data.
TextFrame(boolean finalFragment, int rsvBits, String text) Constructs a Web Socket text frame containing text data.
TextFrame(byte[] payload) Constructs a Web Socket text frame containing binary data.
TextFrame(String text) Constructs a Web Socket text frame containing text data.

Method Summary

Modifier and Type	Method and Description
String	getText() Returns the text data in this frame.

Methods inherited from class org.snf4j.websocket.frame.Frame

getOpcode, getPayload, getPayloadLength, getRsvBits, isFinalFragment, isRsvBit1, isRsvBit2, isRsvBit3

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextFrame

public TextFrame(boolean finalFragment,
                 int rsvBits,
                 byte[] payload)

Constructs a Web Socket text frame containing binary data.

NOTE: The binary data should be a valid UTF-8 encoding.

Parameters:

finalFragment - determines if the created frame is the final fragment in a message

rsvBits - reserved bits for extensions or future versions

payload - payload data

TextFrame

public TextFrame(boolean finalFragment,
                 int rsvBits,
                 String text)

Constructs a Web Socket text frame containing text data.

Parameters:

finalFragment - determines if the created frame is the final fragment in a message

rsvBits - reserved bits for extensions or future versions

text - text data

TextFrame

public TextFrame(byte[] payload)

Constructs a Web Socket text frame containing binary data. The frame is created as the final fragment in a message and with all reserved bits cleared.

NOTE: The binary data should be a valid UTF-8 encoding.

Parameters:

payload - payload data

TextFrame

public TextFrame(String text)

Constructs a Web Socket text frame containing text data. The frame is created as the final fragment in a message and with all reserved bits cleared.

Parameters:

text - text data

TextFrame

public TextFrame()

Constructs an empty Web Socket text frame. The frame is created as the final fragment in a message and with all reserved bits cleared.

Method Detail

getText

public String getText()

Returns the text data in this frame.

Returns:

the text data