Package org.threadly.litesockets.protocols.http.response

Class HTTPResponse

java.lang.Object

org.threadly.litesockets.protocols.http.response.HTTPResponse

public class HTTPResponse
extends java.lang.Object

An Immutable HTTPResponse object. This contains all information from an HTTP Response.

Constructor Summary

Constructors

Constructor	Description
HTTPResponse(HTTPResponseHeader rHeader, HTTPHeaders headers)	Creates an HTTPResponse object.
HTTPResponse(HTTPResponseCode rCode, java.lang.String httpVersion, java.util.Map<java.lang.String,java.lang.String> headers)	Creates an HTTPResponse object.

Method Summary

Modifier and Type	Method	Description
static HTTPResponseBuilder	builder()	Creates an HTTPResponseBuilder from this HTTPResponse.
boolean	equals(java.lang.Object o)
java.nio.ByteBuffer	getByteBuffer()	Gets this HTTPResponse as a ByteBuffer.
HTTPHeaders	getHeaders()	Gets the HTTPHeaders for this HTTPResponse object.
HTTPResponseCode	getResponseCode()	Gets the HTTPResponseCode for this HTTPResponse object.
HTTPResponseHeader	getResponseHeader()	Gets the HTTPResponseHeader for this HTTPResponse object.
int	hashCode()
HTTPResponseBuilder	makeBuilder()	Creates an HTTPResponseBuilder from this HTTPResponse.
static HTTPResponse	parseResponse(java.lang.String response)	Creates a new HTTPResponse object from a string.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HTTPResponse

public HTTPResponse(HTTPResponseHeader rHeader,
                    HTTPHeaders headers)

Creates an HTTPResponse object.

Parameters:

rHeader - the HTTPResponseHeader to use for this HTTPResponse.

headers - the HTTPHeaders to use for this HTTPResponse.

HTTPResponse

public HTTPResponse(HTTPResponseCode rCode,
                    java.lang.String httpVersion,
                    java.util.Map<java.lang.String,java.lang.String> headers)

Creates an HTTPResponse object.

Parameters:

rCode - the HTTPResponseCode to use for this HTTPResponse.

httpVersion - the HTTP version to use for this HTTPResponse.

headers - the HTTPHeaders to use for this HTTPResponse.

Method Detail

getResponseHeader

public HTTPResponseHeader getResponseHeader()

Gets the HTTPResponseHeader for this HTTPResponse object.

Returns:

the HTTPResponseHeader for this HTTPResponse object.

getHeaders

public HTTPHeaders getHeaders()

Gets the HTTPHeaders for this HTTPResponse object.

Returns:

the HTTPHeaders for this HTTPResponse object.

getResponseCode

public HTTPResponseCode getResponseCode()

Gets the HTTPResponseCode for this HTTPResponse object.

Returns:

the HTTPResponseCode for this HTTPResponse object.

getByteBuffer

public java.nio.ByteBuffer getByteBuffer()

Gets this HTTPResponse as a ByteBuffer.

Returns:

a ByteBuffer of this HTTPResponse.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

makeBuilder

public HTTPResponseBuilder makeBuilder()

Creates an HTTPResponseBuilder from this HTTPResponse. This allows for easy modification of the Response.

Returns:

an HTTPResponseBuilder from this HTTPResponse.

builder

public static HTTPResponseBuilder builder()

Creates an HTTPResponseBuilder from this HTTPResponse. This allows for easy modification of the Response.

Returns:

an HTTPResponseBuilder from this HTTPResponse.

parseResponse

public static HTTPResponse parseResponse(java.lang.String response)
                                  throws HTTPParsingException

Creates a new HTTPResponse object from a string.

Parameters:

response - the HTTP Response string to parse.

Returns:

an HTTPResponse from the provided string.

Throws:

HTTPParsingException - is thrown if there are any problems parsing the HTTPResponse.