Open Source Repository

Home /spring/spring-web-3.0.5 | Repository Home


org/springframework/web/bind/annotation/RequestParam.java
/*
 * Copyright 2002-2010 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 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.
 
 @author Arjen Poutsma
 @author Juergen Hoeller
 @since 2.5
 @see RequestMapping
 @see RequestHeader
 @see CookieValue
 @see org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter
 @see org.springframework.web.portlet.mvc.annotation.AnnotationMethodHandlerAdapter
 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestParam {

  /**
   * The name of the request parameter to bind to.
   */
  String value() default "";

  /**
   * Whether the parameter is required.
   <p>Default is <code>true</code>, leading to an exception thrown in case
   * of the parameter missing in the request. Switch this to <code>false</code>
   * if you prefer a <code>null</value> in case of the parameter missing.
   <p>Alternatively, provide a {@link #defaultValue() defaultValue},
   * which implicitly sets this flag to <code>false</code>.
   */
  boolean required() default true;

  /**
   * The default value to use as a fallback. Supplying a default value implicitly
   * sets {@link #required()} to false.
   */
  String defaultValue() default ValueConstants.DEFAULT_NONE;

}