/**
* Copyright 2005-2014 Restlet
*
* The contents of this file are subject to the terms of one of the following
* open source licenses: Apache 2.0 or or EPL 1.0 (the "Licenses"). You can
* select the license that you prefer but you may not use this file except in
* compliance with one of these Licenses.
*
* You can obtain a copy of the Apache 2.0 license at
* http://www.opensource.org/licenses/apache-2.0
*
* You can obtain a copy of the EPL 1.0 license at
* http://www.opensource.org/licenses/eclipse-1.0
*
* See the Licenses for the specific language governing permissions and
* limitations under the Licenses.
*
* Alternatively, you can obtain a royalty free commercial license with less
* limitations, transferable or non-transferable, directly at
* http://restlet.com/products/restlet-framework
*
* Restlet is a registered trademark of Restlet S.A.S.
*/
package org.restlet.resource;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.restlet.engine.connector.Method;
import org.restlet.service.MetadataService;
/**
* Annotation for methods that store submitted representations. Its semantics is
* equivalent to an HTTP PUT method. Note that your method must have one input
* parameter if you want it to be selected for requests containing an entity.<br>
* <br>
* Example:
*
* <pre>
* @Put
* public MyOutputBean store(MyInputBean input);
*
* @Put("json")
* public String storeJson(String value);
*
* @Put("json|xml:xml|json")
* public Representation store(Representation value);
*
* @Put("json?param=val")
* public Representation storeWithParam(String value);
*
* @Put("json?param")
* public Representation storeWithParam(String value);
*
* @Put("?param")
* public Representation storeWithParam(String value);
* </pre>
*
* @author Jerome Louvel
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Method("PUT")
public @interface Put {
/**
* Specifies the media type of the request and response entities as
* extensions. If only one extension is provided, the extension applies to
* both request and response entities. If two extensions are provided,
* separated by a colon, then the first one is for the request entity and
* the second one for the response entity.<br>
* <br>
* If several media types are supported, their extension can be specified
* separated by "|" characters. Note that this isn't the full MIME type
* value, just the extension name declared in {@link MetadataService}. For a
* list of all predefined extensions, please check
* {@link MetadataService#addCommonExtensions()}. New extension can be
* registered using
* {@link MetadataService#addExtension(String, org.restlet.data.Metadata)}
* method.
*
* @return The media types of request and/or response entities.
*/
String value() default "";
}