org.androidannotations.rest.spring.annotations.Get Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rest-spring-api Show documentation
The API jar containing the annotations
The newest version!
/**
 * Copyright (C) 2010-2016 eBusiness Information, Excilys Group
 *
 * 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 org.androidannotations.rest.spring.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 
 * Use on methods in {@link Rest} annotated class to add a new rest service of
 * type GET.
 * 
 * 
 * The annotation {@link #value()} is mandatory and define the URI or the full
 * URL of the web service. It MAY contain placeholders defined as follow :
 * {name}
 * 
 * 
 * The annotated method MAY have parameters as soon as each parameter names are
 * present as placeholders in the URI.
 * 
 * 
 * The annotated method CAN return void,
 * {@link org.springframework.http.ResponseEntity} or any concrete java classes.
 * Interfaces CAN'T be used as return type because converters have to know which
 * object to instantiate while returning result.
 * 
 * 
 * Note: Generics classes are also supported both for return type and
 * parameters.
 * 
 * 
 * 
 * Example :
 * 
 *  * @Rest(rootUrl = "http://myserver", converters = MappingJacksonHttpMessageConverter.class)
 * public interface MyRestClient {
 * 
 * 	@Get("/events")
 * 	EventList getEvents();
 * 
 * 	@Get("/events/{max}")
 * 	ResponseEntity<EventList> getEvents(@Path int max);
 * 
 * 	@Get("/events/{max}/{filter}")
 * 	ArrayList<Event> getEvents(@Path int max, @Path String filter);
 * }
 * 
 * 
 * 
 * 
 * @see Rest
 * @see Post
 * @see Put
 * @see Delete
 * @see Head
 * @see Options
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface Get {

	/**
	 * The URI or the full URL of the web service.
	 * 
	 * @return the address of the web service
	 */
	String value();
}