org.pfsw.bif.http

Enum HttpMethod

java.lang.Object

java.lang.Enum<HttpMethod>

org.pfsw.bif.http.HttpMethod

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HttpMethod>, IEnumType, HttpVerb, IStringRepresentation

public enum HttpMethod
extends java.lang.Enum<HttpMethod>
implements HttpVerb

Represents an HTTP method like GET, PUT and so on. https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECT
DELETE
GET
HEAD
OPTIONS
PATCH
POST
PUT
TRACE

Method Summary

Modifier and Type	Method and Description
java.lang.String	asString() Returns the string representation of the method (e.g.
static HttpMethod	getHttp11Method(java.lang.String methodName) Returns the corresponding HTTP/1.1 method that corresponds to the given name (case-insensitive) or null if the name does not match any HTTP/1.1 method.
java.lang.String	getName() The (upper-case) name of the HTTP method (e.g.
boolean	hasBody() Returns true if this method typically is used with a request body.
boolean	isMethod(java.lang.String method) Returns true if the given string equals (case-insensitive) this HttpMethod's name.
java.lang.String	toString()
static HttpMethod	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HttpMethod[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pfsw.bif.enums.IEnumType

getDeclaringClass, name, ordinal

Enum Constant Detail

GET

public static final HttpMethod GET

POST

public static final HttpMethod POST

PUT

public static final HttpMethod PUT

DELETE

public static final HttpMethod DELETE

HEAD

public static final HttpMethod HEAD

OPTIONS

public static final HttpMethod OPTIONS

CONNECT

public static final HttpMethod CONNECT

TRACE

public static final HttpMethod TRACE

PATCH

public static final HttpMethod PATCH

Method Detail

values

public static HttpMethod[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HttpMethod c : HttpMethod.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HttpMethod valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getHttp11Method

public static HttpMethod getHttp11Method(java.lang.String methodName)

Returns the corresponding HTTP/1.1 method that corresponds to the given name (case-insensitive) or null if the name does not match any HTTP/1.1 method.

getName

public java.lang.String getName()

The (upper-case) name of the HTTP method (e.g. "GET").

hasBody

public boolean hasBody()

Returns true if this method typically is used with a request body.

isMethod

public boolean isMethod(java.lang.String method)

Returns true if the given string equals (case-insensitive) this HttpMethod's name.

asString

public java.lang.String asString()

Returns the string representation of the method (e.g. "DELETE").

Specified by:

asString in interface IStringRepresentation

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<HttpMethod>