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

Field Summary

Modifier and Type	Field and Description
private final byte[]	bytes
public static final HttpVersion	HTTP_1_0 HTTP/1.0
private static final String	HTTP_1_0_STRING
public static final HttpVersion	HTTP_1_1 HTTP/1.1
private static final String	HTTP_1_1_STRING
private final boolean	keepAliveDefault
private final int	majorVersion
private final int	minorVersion
private final String	protocolName
private final String	text
private static final Pattern	VERSION_PATTERN

Constructor Summary

Access	Constructor and Description
public	HttpVersion(String text, boolean `true` if and only if the connection is kept alive unless the `"Connection"` header is set to `"close"` explicitly. keepAliveDefault) Creates a new HTTP version with the specified version string.
public	HttpVersion(String protocolName, int majorVersion, int minorVersion, boolean `true` if and only if the connection is kept alive unless the `"Connection"` header is set to `"close"` explicitly. keepAliveDefault) Creates a new HTTP version with the specified protocol name and version numbers.
private	HttpVersion(String protocolName, int majorVersion, int minorVersion, boolean keepAliveDefault, boolean bytes)

Method Summary

Modifier and Type	Method and Description
public int	compareTo(HttpVersion the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
pack-priv void	encode(Buffer buf)
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	isKeepAliveDefault() Returns `true` if and only if the connection is kept alive unless the `"Connection"` header is set to `"close"` explicitly.
public int	majorVersion() Returns the name of the protocol such as `1` in `"HTTP/1.0"`.
public int	minorVersion() Returns the name of the protocol such as `0` in `"HTTP/1.0"`.
public String	protocolName() Returns the name of the protocol such as `"HTTP"` in `"HTTP/1.0"`.
public String	text() Returns the full protocol version text such as `"HTTP/1.0"`.
public String	toString() Overrides java.lang.Object.toString. Returns the full protocol version text such as `"HTTP/1.0"`.
public static HttpVersion	valueOf(String text) Returns an existing or new `HttpVersion` instance which matches to the specified protocol version string.
private static HttpVersion	version0(String text)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

bytes	back to summary
private final byte[] bytes

HTTP_1_0	back to summary
public static final HttpVersion HTTP_1_0 HTTP/1.0

HTTP_1_0_STRING	back to summary
private static final String HTTP_1_0_STRING

HTTP_1_1	back to summary
public static final HttpVersion HTTP_1_1 HTTP/1.1

HTTP_1_1_STRING	back to summary
private static final String HTTP_1_1_STRING

keepAliveDefault	back to summary
private final boolean keepAliveDefault

majorVersion	back to summary
private final int majorVersion

minorVersion	back to summary
private final int minorVersion

protocolName	back to summary
private final String protocolName

text	back to summary
private final String text

VERSION_PATTERN	back to summary
private static final Pattern VERSION_PATTERN

Constructor Detail

HttpVersion back to summary

HttpVersion	back to summary
public HttpVersion(String text, boolean keepAliveDefault) Creates a new HTTP version with the specified version string. You will not need to create a new instance unless you are implementing a protocol derived from HTTP, such as RTSP and ICAP. Parameters keepAliveDefault:boolean `true` if and only if the connection is kept alive unless the `"Connection"` header is set to `"close"` explicitly.

public HttpVersion(String text, boolean keepAliveDefault)

Creates a new HTTP version with the specified version string. You will not need to create a new instance unless you are implementing a protocol derived from HTTP, such as RTSP and ICAP.

Parameters

keepAliveDefault:boolean: true if and only if the connection is kept alive unless the "Connection" header is set to "close" explicitly.

HttpVersion back to summary

HttpVersion	back to summary
public HttpVersion(String protocolName, int majorVersion, int minorVersion, boolean keepAliveDefault) Creates a new HTTP version with the specified protocol name and version numbers. You will not need to create a new instance unless you are implementing a protocol derived from HTTP, such as RTSP and ICAP Parameters keepAliveDefault:boolean `true` if and only if the connection is kept alive unless the `"Connection"` header is set to `"close"` explicitly.

public HttpVersion(String protocolName, int majorVersion, int minorVersion, boolean keepAliveDefault)

Creates a new HTTP version with the specified protocol name and version numbers. You will not need to create a new instance unless you are implementing a protocol derived from HTTP, such as RTSP and ICAP

Parameters

keepAliveDefault:boolean: true if and only if the connection is kept alive unless the "Connection" header is set to "close" explicitly.

HttpVersion	back to summary
private HttpVersion(String protocolName, int majorVersion, int minorVersion, boolean keepAliveDefault, boolean bytes)

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(HttpVersion o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters o:HttpVersion the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(HttpVersion o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:HttpVersion: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

encode	back to summary
pack-priv void encode(Buffer buf)

equals back to summary

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

isKeepAliveDefault	back to summary
public boolean isKeepAliveDefault() Returns `true` if and only if the connection is kept alive unless the `"Connection"` header is set to `"close"` explicitly.

majorVersion	back to summary
public int majorVersion() Returns the name of the protocol such as `1` in `"HTTP/1.0"`.

minorVersion	back to summary
public int minorVersion() Returns the name of the protocol such as `0` in `"HTTP/1.0"`.

protocolName	back to summary
public String protocolName() Returns the name of the protocol such as `"HTTP"` in `"HTTP/1.0"`.

text	back to summary
public String text() Returns the full protocol version text such as `"HTTP/1.0"`.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns the full protocol version text such as `"HTTP/1.0"`. Returns:String Doc from java.lang.Object.toString. a string representation of the object. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns the full protocol version text such as "HTTP/1.0".

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override

valueOf	back to summary
public static HttpVersion valueOf(String text) Returns an existing or new `HttpVersion` instance which matches to the specified protocol version string. If the specified `text` is equal to `"HTTP/1.0"`, `HTTP_1_0` will be returned. If the specified `text` is equal to `"HTTP/1.1"`, `HTTP_1_1` will be returned. Otherwise, a new `HttpVersion` instance will be returned.

version0	back to summary
private static HttpVersion version0(String text)

public Class HttpVersion

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail