org.mattressframework.api.annotations.PathParam Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mattress-api Show documentation

Public API to the Mattress framework. This is essentially what JSR 311 should be.

There is a newer version: 1.0.0-ALPHA4

/*
 * Copyright 2007-2008, Josh Devins.
 *
 * 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.mattressframework.api.annotations;

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

/**
 * Annotation marking that the parameter value will come from a segment of the
 * HTTP URI path. The {@link #value()} is the key of the segment as defined in
 * the corresponding {@link Path} annotation on the method or enclosing class.
 * 
 * @author Josh Devins ([email protected])
 */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
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.
     */
    String value();
}