org.apache.juneau.rest.annotation.Path Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you 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.apache.juneau.rest.annotation;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
import java.lang.annotation.*;
/**
* Annotation that can be applied to a parameter of a {@link RestMethod} annotated method to identify it as a variable
* in a URL path pattern converted to a POJO.
*
* Example:
*
* @RestMethod (name=GET , path="/myurl/{foo}/{bar}/{baz}/*" )
* public void doGet(RestRequest req, RestResponse res,
* @Path String foo, @Path int bar, @Path UUID baz) {
* ...
* }
*
*
*
* The @Path annotation is optional if the parameters are specified immediately following the
* RestRequest and RestResponse parameters, and are specified in the same order as the
* variables in the URL path pattern.
* The following example is equivalent to the previous example.
*
* @RestMethod (name=GET , path="/myurl/{foo}/{bar}/{baz}/*" )
* public void doGet(RestRequest req, RestResponse res,
* String foo, int bar, UUID baz) {
* ...
* }
*
*
*
* If the order of parameters is not the default order shown above, the attribute names must be specified (since
* parameter names are lost during compilation).
* The following example is equivalent to the previous example, except the parameter order has been switched, requiring
* the use of the @Path annotations.
*
* @RestMethod (name=GET , path="/myurl/{foo}/{bar}/{baz}/*" )
* public void doGet(RestRequest req, RestResponse res,
* @Path ("baz" ) UUID baz, @Path ("foo" ) String foo, @Path ("bar" ) int bar) {
* ...
* }
*
*
*
* You can also use {#} notation to specify path parameters without specifying names.
*
* @RestMethod (name=GET , path="/myurl/{0}/{1}/{2}/*" )
* public void doGet(RestRequest req, RestResponse res,
* @Path String foo, @Path int bar, @Path UUID baz) {
* ...
* }
*
*/
@Documented
@Target(PARAMETER)
@Retention(RUNTIME)
@Inherited
public @interface Path {
/**
* URL path variable name.
*
*
* Optional if the attributes are specified in the same order as in the URL path pattern.
*/
String name() default "";
/**
* A synonym for {@link #name()}.
*
*
* Allows you to use shortened notation if you're only specifying the name.
*/
String value() default "";
}