Package io.fluxcapacitor.javaclient.web

Enum Class WebParameterSource

java.lang.Object

java.lang.Enum<WebParameterSource>

io.fluxcapacitor.javaclient.web.WebParameterSource

All Implemented Interfaces:

Serializable, Comparable<WebParameterSource>, Constable

public enum WebParameterSource
extends Enum<WebParameterSource>

Enumerates the sources of parameter values in an HTTP or WebSocket request.

This enum is used by WebParam and its derived annotations (e.g. PathParam, QueryParam) to specify where the value should be extracted from.

• PATH – Extracted from URI template variables (e.g., /user/{id})
• QUERY – Extracted from the query string (e.g., ?id=123)
• HEADER – Extracted from HTTP headers
• COOKIE – Extracted from cookies
• FORM – Extracted from form fields (URL-encoded or multipart)

See Also:

• WebParam

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
COOKIE	Cookies sent in the request
FORM	Form fields (application/x-www-form-urlencoded or multipart/form-data)
HEADER	HTTP request headers
PATH	URI path parameters (e.g.
QUERY	HTTP query string parameters (e.g. ?

Method Summary

Modifier and Type	Method	Description
static WebParameterSource	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WebParameterSource[]	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

PATH

public static final WebParameterSource PATH

URI path parameters (e.g. /items/{id})

QUERY

public static final WebParameterSource QUERY

HTTP query string parameters (e.g. ?search=abc)

HEADER

public static final WebParameterSource HEADER

HTTP request headers

COOKIE

public static final WebParameterSource COOKIE

Cookies sent in the request

FORM

public static final WebParameterSource FORM

Form fields (application/x-www-form-urlencoded or multipart/form-data)

Method Details

values

public static WebParameterSource[] 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 WebParameterSource 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