Module dev.mccue.jdk.httpserver

Package dev.mccue.jdk.httpserver

Class ResponseLength

java.lang.Object

dev.mccue.jdk.httpserver.ResponseLength

public final class ResponseLength
extends Object

The length (in bytes)of a response body that will be sent through an HttpExchange.

This is either a known quantity, in which case the body written must match the number of bytes specified, or unknown, in which case the response is sent with a chunked encoding.

The need for this arises out of an idiosyncrasy in the HttpExchange.sendResponseHeaders(int, long) method where 0 means that the size of a response is unknown and -1 means that there is no response body to send.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
static ResponseLength	known(long responseLength)	Construct a ResponseLength given a known response length that will be sent.
String	toString()
static ResponseLength	unknown()	Construct a ResponseLength which represents an unknown number of bytes to be sent in a response.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

known

public static ResponseLength known(long responseLength)

Construct a ResponseLength given a known response length that will be sent. Negative values are treated as if zero were provided.

Note that unlike the HttpExchange.sendResponseHeaders(int, long) method, 0 means a length of 0, not an unknown length.

Parameters:

responseLength - The length of the response body to be sent.

Returns:

An instance of ResponseLength.

unknown

public static ResponseLength unknown()

Construct a ResponseLength which represents an unknown number of bytes to be sent in a response.

Returns:

An instance of ResponseLength.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object