Top Description Fields Constructors Methods
io.netty.handler.codec.http

public Class DefaultHttpResponse

extends DefaultHttpMessage
implements HttpResponse
Class Inheritance
All Implemented Interfaces
io.netty.handler.codec.http.HttpResponse, io.netty.handler.codec.http.HttpMessage, io.netty.handler.codec.http.HttpObject, io.netty.handler.codec.DecoderResultProvider
Known Direct Subclasses
io.netty.handler.codec.http.DefaultFullHttpResponse
Imports
io.netty.util.internal.ObjectUtil
The default HttpResponse implementation.

Field Summary

Modifier and TypeField and Description
private HttpResponseStatus
status

Constructor Summary

AccessConstructor and Description
public
DefaultHttpResponse(HttpVersion
the HTTP version of this response
version, HttpResponseStatus
the status of this response
status)

Creates a new instance.

public
DefaultHttpResponse(HttpVersion
the HTTP version of this response
version, HttpResponseStatus
the status of this response
status, boolean
validate the header names and values when adding them to the HttpHeaders
validateHeaders)

Deprecated Use the DefaultHttpResponse(HttpVersion, HttpResponseStatus, HttpHeadersFactory) constructor instead.
Creates a new instance.
public
DefaultHttpResponse(HttpVersion
the HTTP version of this response
version, HttpResponseStatus
the status of this response
status, boolean
validate the header names and values when adding them to the HttpHeaders
validateHeaders, boolean
true to check and enforce that headers with the same name are appended to the same entry and comma separated. See RFC 7230, 3.2.2. false to allow multiple header entries with the same name to coexist.
singleFieldHeaders)

Deprecated Use the DefaultHttpResponse(HttpVersion, HttpResponseStatus, HttpHeadersFactory) constructor instead.
Creates a new instance.
public
DefaultHttpResponse(HttpVersion
the HTTP version of this response
version, HttpResponseStatus
the status of this response
status, HttpHeadersFactory
the HttpHeadersFactory used to create the headers for this HTTP Response. The recommended default is DefaultHttpHeadersFactory#headersFactory().
headersFactory)

Creates a new instance.

public
DefaultHttpResponse(HttpVersion
the HTTP version of this response
version, HttpResponseStatus
the status of this response
status, HttpHeaders
the headers for this HTTP Response
headers)

Creates a new instance.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides io.netty.handler.codec.http.DefaultHttpMessage.equals.

Indicates whether some other object is "equal to" this one.
public HttpResponseStatus
getStatus()

Implements io.netty.handler.codec.http.HttpResponse.getStatus.

Deprecated
public int
hashCode()

Overrides io.netty.handler.codec.http.DefaultHttpMessage.hashCode.

Returns a hash code value for this object.
public HttpResponse
setProtocolVersion(HttpVersion version)

Overrides io.netty.handler.codec.http.DefaultHttpMessage.setProtocolVersion.

Implements io.netty.handler.codec.http.HttpResponse.setProtocolVersion, io.netty.handler.codec.http.HttpMessage.setProtocolVersion.

Set the protocol version of this HttpMessage
public HttpResponse
setStatus(HttpResponseStatus status)

Implements io.netty.handler.codec.http.HttpResponse.setStatus.

Set the status of this HttpResponse.
public HttpResponseStatus
status()

Implements io.netty.handler.codec.http.HttpResponse.status.

Returns the status of this HttpResponse.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from io.netty.handler.codec.http.DefaultHttpMessage:
getProtocolVersionheadersprotocolVersion

Field Detail

statusback to summary
private HttpResponseStatus status

Constructor Detail

DefaultHttpResponseback to summary
public DefaultHttpResponse(HttpVersion version, HttpResponseStatus status)

Creates a new instance.

Parameters
version:HttpVersion

the HTTP version of this response

status:HttpResponseStatus

the status of this response

DefaultHttpResponseback to summary
public DefaultHttpResponse(HttpVersion version, HttpResponseStatus status, boolean validateHeaders)

Deprecated

Use the DefaultHttpResponse(HttpVersion, HttpResponseStatus, HttpHeadersFactory) constructor instead.

Creates a new instance.

Parameters
version:HttpVersion

the HTTP version of this response

status:HttpResponseStatus

the status of this response

validateHeaders:boolean

validate the header names and values when adding them to the HttpHeaders

Annotations
@Deprecated
DefaultHttpResponseback to summary
public DefaultHttpResponse(HttpVersion version, HttpResponseStatus status, boolean validateHeaders, boolean singleFieldHeaders)

Deprecated

Use the DefaultHttpResponse(HttpVersion, HttpResponseStatus, HttpHeadersFactory) constructor instead.

Creates a new instance.

Parameters
version:HttpVersion

the HTTP version of this response

status:HttpResponseStatus

the status of this response

validateHeaders:boolean

validate the header names and values when adding them to the HttpHeaders

singleFieldHeaders:boolean

true to check and enforce that headers with the same name are appended to the same entry and comma separated. See RFC 7230, 3.2.2. false to allow multiple header entries with the same name to coexist.

Annotations
@Deprecated
DefaultHttpResponseback to summary
public DefaultHttpResponse(HttpVersion version, HttpResponseStatus status, HttpHeadersFactory headersFactory)

Creates a new instance.

Parameters
version:HttpVersion

the HTTP version of this response

status:HttpResponseStatus

the status of this response

headersFactory:HttpHeadersFactory

the HttpHeadersFactory used to create the headers for this HTTP Response. The recommended default is DefaultHttpHeadersFactory#headersFactory().

DefaultHttpResponseback to summary
public DefaultHttpResponse(HttpVersion version, HttpResponseStatus status, HttpHeaders headers)

Creates a new instance.

Parameters
version:HttpVersion

the HTTP version of this response

status:HttpResponseStatus

the status of this response

headers:HttpHeaders

the headers for this HTTP Response

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides io.netty.handler.codec.http.DefaultHttpMessage.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getStatusback to summary
public HttpResponseStatus getStatus()

Implements io.netty.handler.codec.http.HttpResponse.getStatus.

Deprecated

Annotations
@Override
@Deprecated
hashCodeback to summary
public int hashCode()

Overrides io.netty.handler.codec.http.DefaultHttpMessage.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
setProtocolVersionback to summary
public HttpResponse setProtocolVersion(HttpVersion version)

Overrides io.netty.handler.codec.http.DefaultHttpMessage.setProtocolVersion.

Implements io.netty.handler.codec.http.HttpResponse.setProtocolVersion, io.netty.handler.codec.http.HttpMessage.setProtocolVersion.

Doc from io.netty.handler.codec.http.HttpMessage.setProtocolVersion.

Set the protocol version of this HttpMessage

Annotations
@Override
setStatusback to summary
public HttpResponse setStatus(HttpResponseStatus status)

Implements io.netty.handler.codec.http.HttpResponse.setStatus.

Doc from io.netty.handler.codec.http.HttpResponse.setStatus.

Set the status of this HttpResponse.

Annotations
@Override
statusback to summary
public HttpResponseStatus status()

Implements io.netty.handler.codec.http.HttpResponse.status.

Doc from io.netty.handler.codec.http.HttpResponse.status.

Returns the status of this HttpResponse.

Returns:HttpResponseStatus

The HttpResponseStatus of this HttpResponse

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override