Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT

## org.springframework.web.bind.annotation
Annotation Type CookieValue

    @Target(value=PARAMETER)
    @Retention(value=RUNTIME)
    @Documented
    public @interface CookieValue

Annotation which indicates that a method parameter should be bound to an HTTP cookie. 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).

Since:
  3.0
Author:
  Juergen Hoeller
See Also:
  `RequestMapping`, `RequestParam`, `RequestHeader`, `RequestMapping`, `org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMethodAdapter`, `AnnotationMethodHandlerAdapter`

Optional Element Summary
`String` | `defaultValue` The default value to use as a fallback.
`boolean` | `required` Whether the header is required.
`String` | `value` The name of the cookie to bind to.

### value

    public abstract String value

  The name of the cookie to bind to.

  Default:
    ""

### required

    public abstract boolean required

  Whether the header is required.

  Default is `true`, leading to an exception being thrown in case the header is missing in the request. Switch this to `false` if you prefer a `null in case of the missing header.`

  Alternatively, provide a `defaultValue`, which implicitly sets this flag to `false`.

  Default:
    true

### defaultValue

    public abstract String defaultValue

  The default value to use as a fallback. Supplying a default value implicitly sets `required()` to false.

  Default:
    "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n"

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT