Spring Framework 6.1.4 · org.springframework.http.HttpMethod

Modifier and Type	Field and Description
public static final HttpMethod	DELETE The HTTP method `DELETE`.
public static final HttpMethod	GET The HTTP method `GET`.
public static final HttpMethod	HEAD The HTTP method `HEAD`.
private final String	name
public static final HttpMethod	OPTIONS The HTTP method `OPTIONS`.
public static final HttpMethod	PATCH The HTTP method `PATCH`.
public static final HttpMethod	POST The HTTP method `POST`.
public static final HttpMethod	PUT The HTTP method `PUT`.
private static final long	serialVersionUID
public static final HttpMethod	TRACE The HTTP method `TRACE`.
private static final HttpMethod[]	values

Access	Constructor and Description
private	HttpMethod(String name)

Modifier and Type	Method and Description
public int	compareTo(HttpMethod the object to be compared. other) 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. other) 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 boolean	Returns: `true` if it matches, `false` otherwise matches(String the HTTP method as a String method) Determine whether this `HttpMethod` matches the given method value.
public String	name() Return the name of this method, e.g. "GET", "POST".
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public static HttpMethod	Returns: the corresponding `HttpMethod` valueOf(String the method value as a String method) Return an `HttpMethod` object for the given value.
public static HttpMethod[]	values() Returns an array containing the standard HTTP methods.

DELETE	back to summary
public static final HttpMethod DELETE The HTTP method `DELETE`. See Also HTTP 1.1, section 9.7

GET	back to summary
public static final HttpMethod GET The HTTP method `GET`. See Also HTTP 1.1, section 9.3

HEAD	back to summary
public static final HttpMethod HEAD The HTTP method `HEAD`. See Also HTTP 1.1, section 9.4

name	back to summary
private final String name

OPTIONS	back to summary
public static final HttpMethod OPTIONS The HTTP method `OPTIONS`. See Also HTTP 1.1, section 9.2

PATCH	back to summary
public static final HttpMethod PATCH The HTTP method `PATCH`. See Also RFC 5789

POST	back to summary
public static final HttpMethod POST The HTTP method `POST`. See Also HTTP 1.1, section 9.5

PUT	back to summary
public static final HttpMethod PUT The HTTP method `PUT`. See Also HTTP 1.1, section 9.6

serialVersionUID	back to summary
private static final long serialVersionUID

TRACE	back to summary
public static final HttpMethod TRACE The HTTP method `TRACE`. See Also HTTP 1.1, section 9.8

values	back to summary
private static final HttpMethod[] values

HttpMethod	back to summary
private HttpMethod(String name)

Method Detail

compareTo back to summary

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

public int compareTo(HttpMethod other)

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

other: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

equals back to summary

equals	back to summary
public boolean equals(Object other) 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 other: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 other)

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

other: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 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

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

matches back to summary

matches	back to summary
public boolean matches(String method) Determine whether this `HttpMethod` matches the given method value. Parameters method:String the HTTP method as a String Returns:boolean `true` if it matches, `false` otherwise Since 4.2.4

public boolean matches(String method)

Determine whether this HttpMethod matches the given method value.

Parameters

method:String: the HTTP method as a String

Returns:boolean

true if it matches, false otherwise

Since

4.2.4

name	back to summary
public String name() Return the name of this method, e.g. "GET", "POST".

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

valueOf back to summary

valueOf	back to summary
public static HttpMethod valueOf(String method) Return an `HttpMethod` object for the given value. Parameters method:String the method value as a String Returns:HttpMethod the corresponding `HttpMethod`

public static HttpMethod valueOf(String method)

Return an HttpMethod object for the given value.

Parameters

method:String: the method value as a String

Returns:HttpMethod

the corresponding HttpMethod

values back to summary

values	back to summary
public static HttpMethod[] values() Returns an array containing the standard HTTP methods. Specifically, this method returns an array containing `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE`, `OPTIONS`, and `TRACE`. Note that the returned value does not include any HTTP methods defined in WebDav.

public static HttpMethod[] values()

Returns an array containing the standard HTTP methods. Specifically, this method returns an array containing GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, and TRACE.

Note that the returned value does not include any HTTP methods defined in WebDav.

public final Class HttpMethod

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail