Open Source Repository

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


org/springframework/web/bind/annotation/PathVariable.java
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 URI template variable. Supported for {@link
 * RequestMapping} annotated handler methods in Servlet environments.
 *
 @author Arjen Poutsma
 @see RequestMapping
 @see org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter
 @since 3.0
 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface PathVariable {

  /** The URI template variable to bind to. */
  String value() default "";

}