com.landawn.abacus.http

Annotation Type PathParam

@Documented
 @Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface PathParam

Named replacement in the URL path. Values are converted to string using String.valueOf(Object) and URL encoded.

Simple example:

 @GET("/image/{id}")
 void example(@Path("id") int id);
 

Calling with foo.example(1) yields /image/1.

Values are URL encoded by default. Disable with encode=false.

 @GET("/user/{name}")
 void encoded(@PathParam("name") String name);

 @GET("/user/{name}")
 void notEncoded(@PathParam(value="name", encode=false) String name);
 

Calling foo.encoded("John+Doe") yields /user/John%2BDoe whereas foo.notEncoded("John+Doe") yields /user/John+Doe.

Path parameters may not be null.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	encode Specifies whether the argument value to the annotated method parameter is URL encoded.

Element Detail

value

public abstract String value

encode

public abstract boolean encode

Specifies whether the argument value to the annotated method parameter is URL encoded.

Returns:

true, if successful

Default:

true