Package top.focess.qq.api.util.network

Class HttpResponse

java.lang.Object

top.focess.qq.api.util.network.HttpResponse

public class HttpResponse
extends Object

This class is used to define a response to a http-request

Field Summary

Fields

Modifier and Type	Field	Description
static int	EXCEPTION	Exception thrown error code
static int	UNKNOWN_REQUEST	Unknown request type error code

Constructor Summary

Constructors

Constructor	Description
HttpResponse(Plugin plugin, int code, okhttp3.Headers headers, String value)	Initialize a HttpResponse without exceptions
HttpResponse(Plugin plugin, Exception e)	Initialize an exception thrown HttpResponse with e

Method Summary

Modifier and Type	Method	Description
JSON	getAsJSON()	Get the value as JSON
@NonNull String	getAsString()	Get the value as String
int	getCode()
Exception	getException()
okhttp3.Headers	getHeaders()
Plugin	getPlugin()
String	getResponse()
boolean	isError()	Indicate this is an exception thrown HttpResponse
static HttpResponse	ofNull(Plugin plugin)

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_REQUEST

public static final int UNKNOWN_REQUEST

Unknown request type error code

See Also:

Constant Field Values

EXCEPTION

public static final int EXCEPTION

Exception thrown error code

See Also:

Constant Field Values

Constructor Detail

HttpResponse

public HttpResponse(Plugin plugin,
                    Exception e)

Initialize an exception thrown HttpResponse with e

Parameters:

plugin - the request plugin

e - the thrown exception in this http-request processing

HttpResponse

public HttpResponse(Plugin plugin,
                    int code,
                    okhttp3.Headers headers,
                    String value)

Initialize a HttpResponse without exceptions

Parameters:

plugin - the request plugin

code - the response code

headers - the response header

value - the response data

Method Detail

ofNull

public static HttpResponse ofNull(Plugin plugin)

getException

@Nullable
public Exception getException()

getCode

public int getCode()

getAsJSON

@NotNull
public JSON getAsJSON()
               throws HttpResponseException

Get the value as JSON

Returns:

JSON instance of this response data

Throws:

HttpResponseException - if there is something wrong with this request

getAsString

public @NonNull String getAsString()
                            throws HttpResponseException

Get the value as String

Returns:

String instance of this response data

Throws:

HttpResponseException - if there is something wrong with this request

getResponse

@Nullable
public String getResponse()

getHeaders

@Nullable
public okhttp3.Headers getHeaders()

getPlugin

public Plugin getPlugin()

isError

@EnsuresNonNullIf(result=true,
                  expression="getException()")
public boolean isError()

Indicate this is an exception thrown HttpResponse

Returns:

true if this is an exception thrown HttpResponse, false otherwise