retrofit2.http.Path Maven / Gradle / Ivy

/*
 * Copyright (C) 2013 Square, Inc.
 *
 * 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 retrofit2.http;

import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.lang.reflect.Type;
import retrofit2.Retrofit;

/**
 * Named replacement in a URL path segment. Values are converted to strings using {@link
 * Retrofit#stringConverter(Type, Annotation[])} (or {@link Object#toString()}, if no matching
 * string converter is installed) and then URL encoded.
 *
 * Simple example:
 *
 * 

 * @GET("/image/{id}")
 * Call<ResponseBody> example(@Path("id") int id);
 * 
 *
 * Calling with {@code foo.example(1)} yields {@code /image/1}.
 *
 * Values are URL encoded by default. Disable with {@code encoded=true}.
 *
 * 

 * @GET("/user/{name}")
 * Call<ResponseBody> encoded(@Path("name") String name);
 *
 * @GET("/user/{name}")
 * Call<ResponseBody> notEncoded(@Path(value="name", encoded=true) String name);
 * 
 *
 * Calling {@code foo.encoded("John+Doe")} yields {@code /user/John%2BDoe} whereas {@code
 * foo.notEncoded("John+Doe")} yields {@code /user/John+Doe}.
 *
 * Path parameters may not be {@code null}.
 */
@Documented
@Retention(RUNTIME)
@Target(PARAMETER)
public @interface Path {
  String value();

  /**
   * Specifies whether the argument value to the annotated method parameter is already URL encoded.
   */
  boolean encoded() default false;
}