org.androidannotations.rest.spring.annotations.Accept 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
 * Copyright (C) 2016-2020 the AndroidAnnotations project
 *
 * 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 {@link Get}, {@link Post}, … annotated methods to negotiate the
 * response format expected, and so the converter to use.
 * 
 * 
 * The annotation {@link #value()} is mandatory and define the
 * media type to
 * accept. We provide a {@link org.androidannotations.rest.spring.api.MediaType
 * MediaType} class to help you.
 * 
 * 
 * 
 * Example :
 * 
 *  * @Rest(rootUrl = "http://myserver", converters = { MappingJacksonHttpMessageConverter.class, SimpleXmlHttpMessageConverter.class })
 * public interface MyRestClient {
 * 
 * 	@Get("/events/{id}")
 * 	@Accept(MediaType.APPLICATION_JSON)
 * 	Event getEvent(long id);
 * 
 * 	@Post("/entity")
 * 	@Accept(MediaType.APPLICATION_XML)
 * 	Event addEvent(@Body Event event);
 * }
 * 
 * 
 * 
 * 
 * @see Rest
 * @see Get
 * @see Post
 * @see Put
 * @see Delete
 * @see Head
 * @see Options
 */
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.METHOD, ElementType.TYPE })
public @interface Accept {

	/**
	 * The accepted media type.
	 *
	 * @see org.androidannotations.rest.spring.api.MediaType
	 *
	 * @return the media type
	 */
	String value();
}