@Target(value=PARAMETER)
@Retention(value=RUNTIME)
@Documented
public @interface CookieValue
Supported for annotated handler methods in Servlet and Portlet environments.
The method parameter may be declared as type Cookie
or as cookie value type (String, int, etc.).
RequestMapping,
RequestParam,
RequestHeader,
RequestMapping,
RequestMappingHandlerAdapter,
AnnotationMethodHandlerAdapter,
AnnotationMethodHandlerAdapter| Modifier and Type | Optional Element and Description |
|---|---|
java.lang.String |
defaultValue
The default value to use as a fallback.
|
java.lang.String |
name
The name of the cookie to bind to.
|
boolean |
required
Whether the cookie is required.
|
java.lang.String |
value
Alias for
name(). |
public abstract boolean required
Defaults to true, leading to an exception being thrown
if the cookie is missing in the request. Switch this to
false if you prefer a null value if the cookie is
not present in the request.
Alternatively, provide a defaultValue(), which implicitly
sets this flag to false.
public abstract java.lang.String defaultValue
Supplying a default value implicitly sets required() to
false.