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

public Class DefaultFullHttpResponse

extends DefaultHttpResponse
implements FullHttpResponse
Class Inheritance
All Implemented Interfaces
io.netty.handler.codec.http.FullHttpResponse, io.netty.handler.codec.http.FullHttpMessage, io.netty.handler.codec.http.LastHttpContent, io.netty.handler.codec.http.HttpContent, io.netty.buffer.ByteBufHolder, io.netty.util.ReferenceCounted, io.netty.handler.codec.http.HttpObject, io.netty.handler.codec.DecoderResultProvider, io.netty.handler.codec.http.HttpMessage, io.netty.handler.codec.http.HttpResponse
Imports
io.netty.buffer.ByteBuf, .ByteBufUtil, .Unpooled, io.netty.util.IllegalReferenceCountException

Default implementation of a FullHttpResponse.

Field Summary

Modifier and TypeField and Description
private final ByteBuf
private int
hash

Used to cache the value of the hash code and avoid IllegalReferenceCountException.

private final HttpHeaders

Constructor Summary

AccessConstructor and Description
public
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status)

Create an empty HTTP response with the given HTTP version and status.

public
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content)

Create an HTTP response with the given HTTP version, status, and contents.

public
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, boolean validateHeaders)

Create an empty HTTP response with the given HTTP version, status, and optional header validation.
public
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, boolean validateHeaders, boolean singleFieldHeaders)

Create an empty HTTP response with the given HTTP version, status, optional header validation, and optional header combining.
public
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content, boolean validateHeaders)

Create an HTTP response with the given HTTP version, status, contents, and optional header validation.
public
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content, boolean validateHeaders, boolean singleFieldHeaders)

Create an HTTP response with the given HTTP version, status, contents, optional header validation, and optional header combining.
public
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content, HttpHeadersFactory headersFactory, HttpHeadersFactory trailersFactory)

Create an HTTP response with the given HTTP version, status, contents, and with headers and trailers created by the given header factories.

public
DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content, HttpHeaders headers, HttpHeaders trailingHeaders)

Create an HTTP response with the given HTTP version, status, contents, headers and trailers.

Method Summary

Modifier and TypeMethod and Description
public ByteBuf
content()

Implements io.netty.buffer.ByteBufHolder.content.

Return the data which is held by this ByteBufHolder.
public FullHttpResponse
copy()

Implements io.netty.handler.codec.http.FullHttpResponse.copy.

Creates a deep copy of this ByteBufHolder.
public FullHttpResponse
public boolean
equals(Object
the reference object with which to compare.
o
)

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

Indicates whether some other object is "equal to" this one.
public int
hashCode()

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

Returns a hash code value for this object.
public int
refCnt()

Implements io.netty.util.ReferenceCounted.refCnt.

Returns the reference count of this object.
public boolean
release()

Implements io.netty.util.ReferenceCounted.release.

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
public boolean
release(int decrement)

Implements io.netty.util.ReferenceCounted.release.

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
public FullHttpResponse
replace(ByteBuf content)

Implements io.netty.handler.codec.http.FullHttpResponse.replace.

Returns a new ByteBufHolder which contains the specified content.
public FullHttpResponse
retain()

Implements io.netty.handler.codec.http.FullHttpResponse.retain.

Increases the reference count by 1.
public FullHttpResponse
retain(int increment)

Implements io.netty.handler.codec.http.FullHttpResponse.retain.

Increases the reference count by the specified increment.
public FullHttpResponse
public FullHttpResponse
public FullHttpResponse
public String
toString()

Overrides io.netty.handler.codec.http.DefaultHttpResponse.toString.

Returns a string representation of the object.
public FullHttpResponse
touch()

Implements io.netty.handler.codec.http.FullHttpResponse.touch.

Records the current access location of this object for debugging purposes.
public FullHttpResponse
touch(Object hint)

Implements io.netty.handler.codec.http.FullHttpResponse.touch.

Records the current access location of this object with an additional arbitrary information for debugging purposes.
public HttpHeaders
Inherited from io.netty.handler.codec.http.DefaultHttpResponse:
getStatusstatus

Field Detail

contentback to summary
private final ByteBuf content
hashback to summary
private int hash

Used to cache the value of the hash code and avoid IllegalReferenceCountException.

trailingHeadersback to summary
private final HttpHeaders trailingHeaders

Constructor Detail

DefaultFullHttpResponseback to summary
public DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status)

Create an empty HTTP response with the given HTTP version and status.

DefaultFullHttpResponseback to summary
public DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content)

Create an HTTP response with the given HTTP version, status, and contents.

DefaultFullHttpResponseback to summary
public DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, boolean validateHeaders)

Create an empty HTTP response with the given HTTP version, status, and optional header validation.

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

Create an empty HTTP response with the given HTTP version, status, optional header validation, and optional header combining.

Annotations
@Deprecated
DefaultFullHttpResponseback to summary
public DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content, boolean validateHeaders)

Create an HTTP response with the given HTTP version, status, contents, and optional header validation.

Annotations
@Deprecated
DefaultFullHttpResponseback to summary
public DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content, boolean validateHeaders, boolean singleFieldHeaders)

Create an HTTP response with the given HTTP version, status, contents, optional header validation, and optional header combining.

Annotations
@Deprecated
DefaultFullHttpResponseback to summary
public DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content, HttpHeadersFactory headersFactory, HttpHeadersFactory trailersFactory)

Create an HTTP response with the given HTTP version, status, contents, and with headers and trailers created by the given header factories.

The recommended header factory is DefaultHttpHeadersFactory#headersFactory(), and the recommended trailer factory is DefaultHttpHeadersFactory#trailersFactory().

DefaultFullHttpResponseback to summary
public DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, ByteBuf content, HttpHeaders headers, HttpHeaders trailingHeaders)

Create an HTTP response with the given HTTP version, status, contents, headers and trailers.

Method Detail

contentback to summary
public ByteBuf content()

Implements io.netty.buffer.ByteBufHolder.content.

Doc from io.netty.buffer.ByteBufHolder.content.

Return the data which is held by this ByteBufHolder.

Annotations
@Override
copyback to summary
public FullHttpResponse copy()

Implements io.netty.handler.codec.http.FullHttpResponse.copy.

Doc from io.netty.buffer.ByteBufHolder.copy.

Creates a deep copy of this ByteBufHolder.

Annotations
@Override
duplicateback to summary
public FullHttpResponse duplicate()

Implements io.netty.handler.codec.http.FullHttpResponse.duplicate.

Doc from io.netty.buffer.ByteBufHolder.duplicate.

Duplicates this ByteBufHolder. Be aware that this will not automatically call retain().

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Overrides io.netty.handler.codec.http.DefaultHttpResponse.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
hashCodeback to summary
public int hashCode()

Overrides io.netty.handler.codec.http.DefaultHttpResponse.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
refCntback to summary
public int refCnt()

Implements io.netty.util.ReferenceCounted.refCnt.

Doc from io.netty.util.ReferenceCounted.refCnt.

Returns the reference count of this object. If 0, it means this object has been deallocated.

Annotations
@Override
releaseback to summary
public boolean release()

Implements io.netty.util.ReferenceCounted.release.

Doc from io.netty.util.ReferenceCounted.release.

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

Returns:boolean

true if and only if the reference count became 0 and this object has been deallocated

Annotations
@Override
releaseback to summary
public boolean release(int decrement)

Implements io.netty.util.ReferenceCounted.release.

Doc from io.netty.util.ReferenceCounted.release.

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Returns:boolean

true if and only if the reference count became 0 and this object has been deallocated

Annotations
@Override
replaceback to summary
public FullHttpResponse replace(ByteBuf content)

Implements io.netty.handler.codec.http.FullHttpResponse.replace.

Doc from io.netty.buffer.ByteBufHolder.replace.

Returns a new ByteBufHolder which contains the specified content.

Annotations
@Override
retainback to summary
public FullHttpResponse retain()

Implements io.netty.handler.codec.http.FullHttpResponse.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by 1.

Annotations
@Override
retainback to summary
public FullHttpResponse retain(int increment)

Implements io.netty.handler.codec.http.FullHttpResponse.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by the specified increment.

Annotations
@Override
retainedDuplicateback to summary
public FullHttpResponse retainedDuplicate()

Implements io.netty.handler.codec.http.FullHttpResponse.retainedDuplicate.

Doc from io.netty.buffer.ByteBufHolder.retainedDuplicate.

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike duplicate().

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

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

Implements io.netty.handler.codec.http.FullHttpResponse.setProtocolVersion, 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 FullHttpResponse setStatus(HttpResponseStatus status)

Overrides io.netty.handler.codec.http.DefaultHttpResponse.setStatus.

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

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

Set the status of this HttpResponse.

Annotations
@Override
toStringback to summary
public String toString()

Overrides io.netty.handler.codec.http.DefaultHttpResponse.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override
touchback to summary
public FullHttpResponse touch()

Implements io.netty.handler.codec.http.FullHttpResponse.touch.

Doc from io.netty.util.ReferenceCounted.touch.

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Annotations
@Override
touchback to summary
public FullHttpResponse touch(Object hint)

Implements io.netty.handler.codec.http.FullHttpResponse.touch.

Doc from io.netty.util.ReferenceCounted.touch.

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Annotations
@Override
trailingHeadersback to summary
public HttpHeaders trailingHeaders()

Implements io.netty.handler.codec.http.LastHttpContent.trailingHeaders.

Annotations
@Override