|
Spring Framework | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Target(value=PARAMETER) @Retention(value=RUNTIME) @Documented public @interface RequestParam
Annotation which indicates that a method parameter should be bound to a web request parameter. Supported for annotated handler methods in Servlet and Portlet environments.
If the method parameter type is Map
and a request parameter name
is specified, then the request parameter value is converted to a Map
assuming an appropriate conversion strategy is available.
If the method parameter is Map<String, String>
or
MultiValueMap<String, String>
and a parameter name is not specified, then the map parameter is populated
with all request parameter names and values.
RequestMapping
,
RequestHeader
,
CookieValue
,
RequestMappingHandlerAdapter
,
AnnotationMethodHandlerAdapter
,
AnnotationMethodHandlerAdapter
Optional Element Summary | |
---|---|
java.lang.String |
defaultValue
The default value to use as a fallback. |
boolean |
required
Whether the parameter is required. |
java.lang.String |
value
The name of the request parameter to bind to. |
public abstract java.lang.String value
public abstract boolean required
Default is Alternatively, provide a
true
, leading to an exception thrown in case
of the parameter missing in the request. Switch this to false
if you prefer a null in case of the parameter missing.
defaultValue
,
which implicitly sets this flag to false
.
public abstract java.lang.String defaultValue
required()
to false.
|
Spring Framework | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |