Netty5/Codec/HTTP 5.0.0.Alpha5 · io.netty5.handler.codec.http.DefaultFullHttpResponse

Modifier and Type	Field and Description
private int	hash Used to cache the value of the hash code and avoid `BufferClosedException`.
private final Buffer	payload
private final HttpHeaders	trailingHeaders

Access	Constructor and Description
public	DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, Buffer payload)
public	DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, Buffer payload, boolean validateHeaders)
public	DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, Buffer payload, HttpHeaders headers, HttpHeaders trailingHeaders)

Modifier and Type	Method and Description
public void	close() Implements io.netty5.util.Resource.close. Close the resource, making it inaccessible.
public DefaultFullHttpResponse	copy() Implements io.netty5.handler.codec.http.HttpContent.copy. Create a copy of this HTTP content instance, and return it.
public boolean	equals(Object the reference object with which to compare. o) Overrides io.netty5.handler.codec.http.DefaultHttpResponse.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides io.netty5.handler.codec.http.DefaultHttpResponse.hashCode. Returns a hash code value for the object.
public boolean	isAccessible() Implements io.netty5.util.Resource.isAccessible. Check if this object is accessible.
public Buffer	payload() Implements io.netty5.handler.codec.http.HttpContent.payload. Returns the `Buffer` representing the payload of the HTTP message.
public Send<FullHttpResponse>	send() Implements io.netty5.util.Resource.send. Send this object instance to another Thread, transferring the ownership to the recipient.
public FullHttpResponse	setProtocolVersion(HttpVersion version) Overrides io.netty5.handler.codec.http.DefaultHttpResponse.setProtocolVersion. Implements io.netty5.handler.codec.http.FullHttpResponse.setProtocolVersion, io.netty5.handler.codec.http.HttpResponse.setProtocolVersion, io.netty5.handler.codec.http.HttpMessage.setProtocolVersion. Set the protocol version of this `HttpMessage`
public FullHttpResponse	setStatus(HttpResponseStatus status) Overrides io.netty5.handler.codec.http.DefaultHttpResponse.setStatus. Implements io.netty5.handler.codec.http.FullHttpResponse.setStatus, io.netty5.handler.codec.http.HttpResponse.setStatus. Set the status of this `HttpResponse`.
public String	toString() Overrides io.netty5.handler.codec.http.DefaultHttpResponse.toString. Returns a string representation of the object.
public FullHttpResponse	touch(Object An optional hint about this access and its context. May be `null`. hint) Overrides default io.netty5.util.Resource.touch. Record the current access location for debugging purposes.
public HttpHeaders	trailingHeaders() Implements io.netty5.handler.codec.http.LastHttpContent.trailingHeaders.

hash	back to summary
private int hash Used to cache the value of the hash code and avoid `BufferClosedException`.

payload	back to summary
private final Buffer payload

trailingHeaders	back to summary
private final HttpHeaders trailingHeaders

DefaultFullHttpResponse	back to summary
public DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, Buffer payload)

DefaultFullHttpResponse	back to summary
public DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, Buffer payload, boolean validateHeaders)

DefaultFullHttpResponse	back to summary
public DefaultFullHttpResponse(HttpVersion version, HttpResponseStatus status, Buffer payload, HttpHeaders headers, HttpHeaders trailingHeaders)

Method Detail

close	back to summary
public void close() Implements io.netty5.util.Resource.close. Doc from io.netty5.util.Resource.close. Close the resource, making it inaccessible. Note, this method is not thread-safe unless otherwise specified. Annotations @Override

back to summary

public void close()

Implements io.netty5.util.Resource.close.

Doc from io.netty5.util.Resource.close.

Close the resource, making it inaccessible.

Note, this method is not thread-safe unless otherwise specified.

Annotations

@Override

copy	back to summary
public DefaultFullHttpResponse copy() Implements io.netty5.handler.codec.http.HttpContent.copy. Doc from io.netty5.handler.codec.http.HttpContent.copy. Create a copy of this HTTP content instance, and return it. Returns:DefaultFullHttpResponse A copy of this HTTP content object. Annotations @Override

copy

back to summary

public DefaultFullHttpResponse copy()

Implements io.netty5.handler.codec.http.HttpContent.copy.

Doc from io.netty5.handler.codec.http.HttpContent.copy.

Create a copy of this HTTP content instance, and return it.

Returns:DefaultFullHttpResponse

A copy of this HTTP content object.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides io.netty5.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

public boolean equals(Object o)

Overrides io.netty5.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

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides io.netty5.handler.codec.http.DefaultHttpResponse.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the 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

public int hashCode()

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

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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

isAccessible back to summary

isAccessible	back to summary
public boolean isAccessible() Implements io.netty5.util.Resource.isAccessible. Doc from io.netty5.util.Resource.isAccessible. Check if this object is accessible. Returns:boolean `true` if this object is still valid and can be accessed, otherwise `false` if, for instance, this object has been dropped/deallocated, or been sent elsewhere. Annotations @Override

public boolean isAccessible()

Implements io.netty5.util.Resource.isAccessible.

Doc from io.netty5.util.Resource.isAccessible.

Check if this object is accessible.

Returns:boolean

true if this object is still valid and can be accessed, otherwise false if, for instance, this object has been dropped/deallocated, or been sent elsewhere.

Annotations

@Override

payload back to summary

payload	back to summary
public Buffer payload() Implements io.netty5.handler.codec.http.HttpContent.payload. Doc from io.netty5.handler.codec.http.HttpContent.payload. Returns the `Buffer` representing the payload of the HTTP message. Returns:Buffer The `Buffer` representing the payload of the HTTP message. Annotations @Override

public Buffer payload()

Implements io.netty5.handler.codec.http.HttpContent.payload.

Doc from io.netty5.handler.codec.http.HttpContent.payload.

Returns the Buffer representing the payload of the HTTP message.

Returns:Buffer

The Buffer representing the payload of the HTTP message.

Annotations

@Override

send back to summary

send	back to summary
public Send<FullHttpResponse> send() Implements io.netty5.util.Resource.send. Doc from io.netty5.util.Resource.send. Send this object instance to another Thread, transferring the ownership to the recipient. The object must be in a state where it can be sent, which includes at least being accessible. When sent, this instance will immediately become inaccessible, as if by closing it. All attempts at accessing an object that has been sent, even if that object has not yet been received, should cause an exception to be thrown. Calling `close()` on an object that has been sent will have no effect, so this method is safe to call within a try-with-resources statement. Annotations @Override

public Send<FullHttpResponse> send()

Implements io.netty5.util.Resource.send.

Doc from io.netty5.util.Resource.send.

Send this object instance to another Thread, transferring the ownership to the recipient.

The object must be in a state where it can be sent, which includes at least being accessible.

When sent, this instance will immediately become inaccessible, as if by closing it. All attempts at accessing an object that has been sent, even if that object has not yet been received, should cause an exception to be thrown.

Calling close() on an object that has been sent will have no effect, so this method is safe to call within a try-with-resources statement.

Annotations

@Override

setProtocolVersion back to summary

setProtocolVersion	back to summary
public FullHttpResponse setProtocolVersion(HttpVersion version) Overrides io.netty5.handler.codec.http.DefaultHttpResponse.setProtocolVersion. Implements io.netty5.handler.codec.http.FullHttpResponse.setProtocolVersion, io.netty5.handler.codec.http.HttpResponse.setProtocolVersion, io.netty5.handler.codec.http.HttpMessage.setProtocolVersion. Doc from io.netty5.handler.codec.http.HttpMessage.setProtocolVersion. Set the protocol version of this `HttpMessage` Annotations @Override

public FullHttpResponse setProtocolVersion(HttpVersion version)

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

Implements io.netty5.handler.codec.http.FullHttpResponse.setProtocolVersion, io.netty5.handler.codec.http.HttpResponse.setProtocolVersion, io.netty5.handler.codec.http.HttpMessage.setProtocolVersion.

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

Set the protocol version of this HttpMessage

Annotations

@Override

setStatus back to summary

setStatus	back to summary
public FullHttpResponse setStatus(HttpResponseStatus status) Overrides io.netty5.handler.codec.http.DefaultHttpResponse.setStatus. Implements io.netty5.handler.codec.http.FullHttpResponse.setStatus, io.netty5.handler.codec.http.HttpResponse.setStatus. Doc from io.netty5.handler.codec.http.HttpResponse.setStatus. Set the status of this `HttpResponse`. Annotations @Override

public FullHttpResponse setStatus(HttpResponseStatus status)

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

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

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

Set the status of this HttpResponse.

Annotations

@Override

toString	back to summary
public String toString() Overrides io.netty5.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

toString

back to summary

public String toString()

Overrides io.netty5.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

touch back to summary

touch	back to summary
public FullHttpResponse touch(Object hint) Overrides default io.netty5.util.Resource.touch. Doc from io.netty5.util.Resource.touch. Record the current access location for debugging purposes. This information may be included if the resource throws a life-cycle related exception, or if it leaks. If this resource has already been closed, then this method has no effect. Parameters hint:Object An optional hint about this access and its context. May be `null`. Returns:FullHttpResponse This resource instance. Annotations @Override

public FullHttpResponse touch(Object hint)

Overrides default io.netty5.util.Resource.touch.

Doc from io.netty5.util.Resource.touch.

Record the current access location for debugging purposes. This information may be included if the resource throws a life-cycle related exception, or if it leaks. If this resource has already been closed, then this method has no effect.

Parameters