Package Torello.Browser

Class Network.WebSocketResponse

java.lang.Object

Torello.Java.Additional.BaseType

Torello.Browser.Network.WebSocketResponse

Enclosing class:

Network

public static class Network.WebSocketResponse
extends BaseType

WebSocket response data.

Hi-Lited Source-Code:

• View Here: Torello/Browser/Network.java
• Open New Browser-Tab: Torello/Browser/Network.java

File Size: 3,288 Bytes Line Count: 91 '\n' Characters Found

Field Summary

Serializable ID
Modifier and Type	Field
protected static long	serialVersionUID	For Object Serialization.
Type Properties
Modifier and Type	Field
JsonObject	headers	HTTP response headers.
String	headersText	HTTP response headers text.
JsonObject	requestHeaders	HTTP request headers.
String	requestHeadersText	HTTP request headers text.
int	status	HTTP response status code.
String	statusText	HTTP response status text.

Constructor Summary

Constructors

Constructor	Description
WebSocketResponse(int status, String statusText, JsonObject headers, String headersText, JsonObject requestHeaders, String requestHeadersText)	Constructor
WebSocketResponse(JsonObject jo)	JSON Object Constructor

Method Summary

Modifier and Type	Method	Description
boolean[]	optionals()	Implementing this method allows sub-classes to specify which JSON Properties may be absent or null.

Methods inherited from class Torello.Java.Additional.BaseType

toJSON, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

🡇 ⇈ ⮫

protected static final long serialVersionUID

For Object Serialization. java.io.Serializable

See Also:

Constant Field Values

status

🡅 🡇 ⇈ ⮫

public final int status

HTTP response status code.

statusText

🡅 🡇 ⇈ ⮫

public final java.lang.String statusText

HTTP response status text.

headers

🡅 🡇 ⇈ ⮫

public final JsonObject headers

HTTP response headers.

headersText

🡅 🡇 ⇈ ⮫

public final java.lang.String headersText

HTTP response headers text.

OPTIONAL

requestHeaders

🡅 🡇 ⇈ ⮫

public final JsonObject requestHeaders

HTTP request headers.

OPTIONAL

requestHeadersText

🡅 🡇 ⇈ ⮫

public final java.lang.String requestHeadersText

HTTP request headers text.

OPTIONAL

Constructor Detail

WebSocketResponse

🡅 🡇 ⇈ ⮫

public WebSocketResponse(int status,
                         java.lang.String statusText,
                         JsonObject headers,
                         java.lang.String headersText,
                         JsonObject requestHeaders,
                         java.lang.String requestHeadersText)

Constructor

Parameters:

status - HTTP response status code.

statusText - HTTP response status text.

headers - HTTP response headers.

headersText - HTTP response headers text.
OPTIONAL

requestHeaders - HTTP request headers.
OPTIONAL

requestHeadersText - HTTP request headers text.
OPTIONAL

WebSocketResponse

🡅 🡇 ⇈ ⮫

public WebSocketResponse(JsonObject jo)

JSON Object Constructor

Parameters:

jo - A Json-Object having data about an instance of 'WebSocketResponse'.

Method Detail

optionals

🡅 ⇈ ⮫

public boolean[] optionals()

Description copied from class: BaseType

Implementing this method allows sub-classes to specify which JSON Properties may be absent or null. When binding a JsonObject to a Java-Object, if some of the expected fields for the Java-Object map to Properties which might be left-out or omitted, then that may be indicated by setting that fields array position TRUE.

NOTE: This array should have a length equal to the number of fields contained by the Java Object. The first boolean in the array should specify whether the first Object Field may by absent. The second boolean should specify whether the second Object Field is optional in the JSON - and so on and so forth...

Specified by:

optionals in class BaseType

Returns:

A boolean[] array whose length is precisely equal to the number of fields in the Java Object.