The Spring Framework

org.springframework.web.bind.annotation
Annotation Type RequestParam


@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 RequestMapping annotated handler methods in Servlet and Portlet environments.

Since:
2.5
Author:
Arjen Poutsma, Juergen Hoeller
See Also:
RequestMapping, AnnotationMethodHandlerAdapter, AnnotationMethodHandlerAdapter

Optional Element Summary
 boolean required
          Whether the parameter is required.
 String value
          The request parameter to bind to.
 

value

public abstract String value
The request parameter to bind to.

Default:
""

required

public abstract boolean required
Whether the parameter is required.

Default is 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.

Default:
true

The Spring Framework

Copyright © 2002-2008 The Spring Framework.