| /* |
| * The contents of this file are subject to the terms |
| * of the Common Development and Distribution License |
| * (the "License"). You may not use this file except |
| * in compliance with the License. |
| * |
| * You can obtain a copy of the license at |
| * http://www.opensource.org/licenses/cddl1.php |
| * See the License for the specific language governing |
| * permissions and limitations under the License. |
| */ |
| |
| /* |
| * PathParam.java |
| * |
| * Created on November 16, 2006, 2:04 PM |
| * |
| */ |
| package javax.ws.rs; |
| |
| import java.lang.annotation.ElementType; |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.RetentionPolicy; |
| import java.lang.annotation.Target; |
| |
| /** |
| * Binds the value of a URI template parameter or a path segment |
| * containing the template parameter to a resource method parameter, resource |
| * class field, or resource class |
| * bean property. The value is URL decoded unless this |
| * is disabled using the {@link Encoded} annotation. |
| * A default value can be specified using the {@link DefaultValue} |
| * annotation. |
| * |
| * The type of the annotated parameter, field or property must either: |
| * <ul> |
| * <li>Be {@link javax.ws.rs.core.PathSegment}, the value will be the final |
| * segment of the matching part of the path. |
| * See {@link javax.ws.rs.core.UriInfo} for a means of retrieving all request |
| * path segments.</li> |
| * <li>Be {@code List<}{@link javax.ws.rs.core.PathSegment}{@code >}, the |
| * value will be a list of {@code PathSegment} corresponding to the path |
| * segment(s) that matched the named template parameter. |
| * See {@link javax.ws.rs.core.UriInfo} for a means of retrieving all request |
| * path segments.</li> |
| * <li>Be a primitive type.</li> |
| * <li>Have a constructor that accepts a single String argument.</li> |
| * <li>Have a static method named <code>valueOf</code> or <code>fromString</code> |
| * that accepts a single |
| * String argument (see, for example, {@link Integer#valueOf(String)}). |
| * </ul> |
| * |
| * <p>The injected value corresponds to the latest use (in terms of scope) of |
| * the path parameter. E.g. if a class and a sub-resource method are both |
| * annotated with a {@link Path} containing the same URI template parameter, use |
| * of {@code PathParam} on a subresource method parameter will bind the value |
| * matching URI template parameter in the method's {@link Path} annotation.</p> |
| * |
| * <p>Because injection occurs at object creation time, use of this annotation |
| * on resource class fields and bean properties is only supported for the |
| * default per-request resource class lifecycle. Resource classes using |
| * other lifecycles should only use this annotation on resource method |
| * parameters.</p> |
| * |
| * @see Encoded |
| * @see DefaultValue |
| * @see javax.ws.rs.core.PathSegment |
| * @see javax.ws.rs.core.UriInfo |
| */ |
| @Target({ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD}) |
| @Retention(RetentionPolicy.RUNTIME) |
| public @interface PathParam { |
| /** |
| * Defines the name of the URI template parameter whose value will be used |
| * to initialize the value of the annotated method parameter, class field or |
| * property. See {@link Path#value()} for a description of the syntax of |
| * template parameters. |
| * |
| * <p>E.g. a class annotated with: <code>@Path("widgets/{id}")</code> |
| * can have methods annotated whose arguments are annotated |
| * with <code>@PathParam("id")</code>. |
| */ |
| String value(); |
| } |