org.androidannotations.rest.spring.annotations

Annotation Type Path

@Retention(value=CLASS)
 @Target(value=PARAMETER)
public @interface Path

This annotation can be used to mark a method parameter to be an url variable. This annotation is optional, because method parameters which are not annotated with any annotation or not correspond to the request entity, implicitly interpreted as url variables. However with this annotation you can explicitly mark them. Also, with the annotation value, you can add another name to the url variable. If an url variable method parameter does not have the Path annotation, or the annotation value is not specified, the method parameter name will be used as the url variable name. The url in the Get etc. annotation must contain an url variable, which the corresponding method variable will be substituted into.

Example :

 @Rest(converters = MappingJacksonHttpMessageConverter.class)
 public interface MyRestClient {

        @Get("/event/{id}")
        Event getEvent(String id);

        @Get("/event/{id}")
        Event getEventWithPathAnnotation(@Path String id);

        @Get("/event/{id}")
        Event getEventWithPathAnnotationValue(@Path("id") String identifier);
 }
 

See Also:

Rest

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	value Name of the url variable.

Element Detail

value

public abstract String value

Name of the url variable.

Returns:

the url variable name

Default:

""