Top Description Inners Fields Constructors Methods
io.netty5.handler.codec.http

public Class HttpMethod

extends Object
implements Comparable<HttpMethod>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Imports
io.netty5.util.AsciiString

The request method of HTTP or its derived protocols, such as RTSP and ICAP.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
public static final HttpMethod
CONNECT

This specification reserves the method name CONNECT for use with a proxy that can dynamically switch to being a tunnel

public static final HttpMethod
DELETE

The DELETE method requests that the origin server delete the resource identified by the Request-URI.

public static final HttpMethod
GET

The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI.

public static final HttpMethod
HEAD

The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response.

private static final HttpMethod.EnumNameMap<HttpMethod>
private final AsciiString
public static final HttpMethod
OPTIONS

The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI.

public static final HttpMethod
PATCH

The PATCH method requests that a set of changes described in the request entity be applied to the resource identified by the Request-URI.

public static final HttpMethod
POST

The POST method is used to request that the origin server accept the entity enclosed in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line.

public static final HttpMethod
PUT

The PUT method requests that the enclosed entity be stored under the supplied Request-URI.

public static final HttpMethod
TRACE

The TRACE method is used to invoke a remote, application-layer loop- back of the request message.

Constructor Summary

AccessConstructor and Description
public
HttpMethod(String name)

Creates a new HTTP method with the specified name.

Method Summary

Modifier and TypeMethod and Description
public AsciiString
asciiName()

Returns the name of this method.

public int
compareTo(HttpMethod
the object to be compared.
o
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
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 this object.
public String
name()

Returns the name of this method.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public static HttpMethod
valueOf(String name)

Returns the HttpMethod represented by the specified name.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

CONNECTback to summary
public static final HttpMethod CONNECT

This specification reserves the method name CONNECT for use with a proxy that can dynamically switch to being a tunnel

DELETEback to summary
public static final HttpMethod DELETE

The DELETE method requests that the origin server delete the resource identified by the Request-URI.

GETback to summary
public static final HttpMethod GET

The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. If the Request-URI refers to a data-producing process, it is the produced data which shall be returned as the entity in the response and not the source text of the process, unless that text happens to be the output of the process.

methodMapback to summary
private static final HttpMethod.EnumNameMap<HttpMethod> methodMap
nameback to summary
private final AsciiString name
OPTIONSback to summary
public static final HttpMethod OPTIONS

The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI. This method allows the client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval.

PATCHback to summary
public static final HttpMethod PATCH

The PATCH method requests that a set of changes described in the request entity be applied to the resource identified by the Request-URI.

POSTback to summary
public static final HttpMethod POST

The POST method is used to request that the origin server accept the entity enclosed in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line.

PUTback to summary
public static final HttpMethod PUT

The PUT method requests that the enclosed entity be stored under the supplied Request-URI.

TRACEback to summary
public static final HttpMethod TRACE

The TRACE method is used to invoke a remote, application-layer loop- back of the request message.

Constructor Detail

HttpMethodback to summary
public HttpMethod(String name)

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

Method Detail

asciiNameback to summary
public AsciiString asciiName()

Returns the name of this method.

compareToback to summary
public int compareTo(HttpMethod 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:HttpMethod

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
equalsback 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
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.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
nameback to summary
public String name()

Returns the name of this method.

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
valueOfback to summary
public static HttpMethod valueOf(String name)

Returns the HttpMethod represented by the specified name. If the specified name is a standard HTTP method name, a cached instance will be returned. Otherwise, a new instance will be returned.

io.netty5.handler.codec.http back to summary

private final Class HttpMethod.EnumNameMap<T>

extends Object
Class Inheritance

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private final HttpMethod.EnumNameMap.Node<T>[]
private final int

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
pack-priv T
get(String name)

private static int
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

valuesback to summary
private final HttpMethod.EnumNameMap.Node<T>[] values
valuesMaskback to summary
private final int valuesMask

Constructor Detail

EnumNameMapback to summary
pack-priv EnumNameMap(HttpMethod.EnumNameMap.Node<T>... nodes)
Annotations
@SuppressWarnings:unchecked
@SafeVarargs

Method Detail

getback to summary
pack-priv T get(String name)
hashCodeback to summary
private static int hashCode(String name)
io.netty5.handler.codec.http back to summary

private final Class HttpMethod.EnumNameMap.Node<T>

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv final String
pack-priv final T

Constructor Summary

AccessConstructor and Description
pack-priv
Node(String key, T value)

Field Detail

keyback to summary
pack-priv final String key
valueback to summary
pack-priv final T value

Constructor Detail

Nodeback to summary
pack-priv Node(String key, T value)