org.springframework.hateoas

Class QueryParameter

java.lang.Object

org.springframework.hateoas.QueryParameter

public class QueryParameter
extends Object

Representation of a web request's query parameter (https://example.com?name=foo) => {"name", "foo", true}.

Author:

Greg Turnquist, Oliver Drotbohm

Constructor Summary

Constructors

Constructor and Description
QueryParameter()

Method Summary

Modifier and Type	Method and Description
static QueryParameter	of(MethodParameter parameter) Creates a new QueryParameter from the given MethodParameter.
static QueryParameter	optional(String name) Creates a new optional QueryParameter with the given name;
static QueryParameter	required(String name) Creates a new required QueryParameter with the given name;

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryParameter

public QueryParameter()

Method Detail

of

public static QueryParameter of(MethodParameter parameter)

Creates a new QueryParameter from the given MethodParameter.

Parameters:

parameter - must not be null.

Returns:

will never be null.

required

public static QueryParameter required(String name)

Creates a new required QueryParameter with the given name;

Parameters:

name - must not be null or empty.

Returns:

optional

public static QueryParameter optional(String name)

Creates a new optional QueryParameter with the given name;

Parameters:

name - must not be null or empty.

Returns: