Package ca.uhn.fhir.rest.api

Enum Class PagingHttpMethodEnum

java.lang.Object

java.lang.Enum<PagingHttpMethodEnum>

ca.uhn.fhir.rest.api.PagingHttpMethodEnum

All Implemented Interfaces:

Serializable, Comparable<PagingHttpMethodEnum>, Constable

public enum PagingHttpMethodEnum
extends Enum<PagingHttpMethodEnum>

Enumerated type to represent allowable HTTP methods for a paging request.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GET	This is the most common default behaviour.
POST	Performs the paging using POST HTTP method.

Method Summary

Modifier and Type	Method	Description
RequestTypeEnum	getRequestType()
static PagingHttpMethodEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PagingHttpMethodEnum[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GET

public static final PagingHttpMethodEnum GET

This is the most common default behaviour. Performs the paging using GET HTTP method.

POST

public static final PagingHttpMethodEnum POST

Performs the paging using POST HTTP method. Note that this style is less commonly supported in servers, so it should not be used unless there is a specific reason for needing to.

Method Details

values

public static PagingHttpMethodEnum[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PagingHttpMethodEnum valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getRequestType

public RequestTypeEnum getRequestType()