001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.rest.annotation;
018
019import static java.lang.annotation.ElementType.*;
020import static java.lang.annotation.RetentionPolicy.*;
021
022import java.lang.annotation.*;
023
024/**
025 * Annotation that can be applied to a parameter of a {@link RestOp @RestOp} annotated method to identify it as the HTTP
026 * method.
027 *
028 * <p>
029 * Typically used for HTTP method handlers of type <js>"*"</js> (i.e. handle all requests).
030 *
031 * <h5 class='section'>Example:</h5>
032 * <p class='bjava'>
033 *    <ja>@RestOp</ja>(method=<js>"*"</js>)
034 *    <jk>public void</jk> doAnything(RestRequest <jv>req</jv>, RestResponse <jv>res</jv>, <ja>@Method</ja> String <jv>method</jv>) {
035 *       ...
036 *    }
037 * </p>
038 *
039 * <p>
040 * This is functionally equivalent to the following code...
041 * <p class='bjava'>
042 *    <ja>@RestOp</ja>(method=<js>"*"</js>)
043 *    <jk>public void</jk> doAnything(RestRequest <jv>req</jv>, RestResponse <jv>res</jv>) {
044 *       String <jv>method</jv> = <jv>req</jv>.getMethod();
045 *       ...
046 *    }
047 * </p>
048 *
049 * <h5 class='section'>See Also:</h5><ul>
050 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/RestOpAnnotatedMethodBasics">@RestOp-Annotated Method Basics</a>
051
052 * </ul>
053 */
054@Target(PARAMETER)
055@Retention(RUNTIME)
056@Inherited
057public @interface Method {
058}