Package io.servicetalk.http.api

Class HttpRequestMethod

java.lang.Object

io.servicetalk.http.api.HttpRequestMethod

All Implemented Interfaces:

Comparable<HttpRequestMethod>

public final class HttpRequestMethod
extends Object
implements Comparable<HttpRequestMethod>

HTTP Request Methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpRequestMethod.Properties	Common HTTP Method Properties.

Field Summary

Fields

Modifier and Type	Field	Description
static final HttpRequestMethod	CONNECT	HTTP CONNECT method.
static final HttpRequestMethod	DELETE	HTTP DELETE method.
static final HttpRequestMethod	GET	HTTP GET method.
static final HttpRequestMethod	HEAD	HTTP HEAD method.
static final HttpRequestMethod	OPTIONS	HTTP OPTIONS method.
static final HttpRequestMethod	PATCH	HTTP PATCH method.
static final HttpRequestMethod	POST	HTTP POST method.
static final HttpRequestMethod	PUT	HTTP PUT method.
static final HttpRequestMethod	TRACE	HTTP TRACE method.

Method Summary

Modifier and Type	Method	Description
int	compareTo(HttpRequestMethod anotherMethod)
boolean	equals(Object o)
int	hashCode()
String	name()	Get the method name.
static HttpRequestMethod	of(String name)	Returns an HttpRequestMethod for the specified method name.
static HttpRequestMethod	of(String name, HttpRequestMethod.Properties properties)	Returns an HttpRequestMethod for the specified String representation of method name and HttpRequestMethod.Properties.
HttpRequestMethod.Properties	properties()	Get the HttpRequestMethod.Properties associated with this method.
String	toString()
void	writeTo(Buffer buffer)	Write the equivalent of this HttpRequestMethod to a Buffer.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

GET

public static final HttpRequestMethod GET

HTTP GET method.

HEAD

public static final HttpRequestMethod HEAD

HTTP HEAD method.

POST

public static final HttpRequestMethod POST

HTTP POST method.

PUT

public static final HttpRequestMethod PUT

HTTP PUT method.

DELETE

public static final HttpRequestMethod DELETE

HTTP DELETE method.

CONNECT

public static final HttpRequestMethod CONNECT

HTTP CONNECT method.

OPTIONS

public static final HttpRequestMethod OPTIONS

HTTP OPTIONS method.

TRACE

public static final HttpRequestMethod TRACE

HTTP TRACE method.

PATCH

public static final HttpRequestMethod PATCH

HTTP PATCH method.

Method Details

of

public static HttpRequestMethod of(String name,
 HttpRequestMethod.Properties properties)

Returns an HttpRequestMethod for the specified String representation of method name and HttpRequestMethod.Properties. Generally, the constants in HttpRequestMethod should be used.

Parameters:

name - a method name

properties - Common HTTP Method Properties

Returns:

an HttpRequestMethod

Throws:

IllegalArgumentException - if name does not follow the valid token format

of

@Nullable
public static HttpRequestMethod of(String name)

Returns an HttpRequestMethod for the specified method name.

Parameters:

name - a method name

Returns:

an HttpRequestMethod or null if the method name is unknown

writeTo

public void writeTo(Buffer buffer)

Write the equivalent of this HttpRequestMethod to a Buffer.

Parameters:

buffer - the Buffer to write to

name

public String name()

Get the method name.

Returns:

The method name

properties

public HttpRequestMethod.Properties properties()

Get the HttpRequestMethod.Properties associated with this method.

Returns:

the HttpRequestMethod.Properties associated with this method

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(HttpRequestMethod anotherMethod)

Specified by:

compareTo in interface Comparable<HttpRequestMethod>

toString

public String toString()

Overrides:

toString in class Object