Package org.restlet.resource

Annotation Interface Options

@Documented
@Retention(RUNTIME)
@Target(METHOD)
public @interface Options

Annotation for methods that describe a resource. Its semantics is equivalent to an HTTP OPTIONS method.

Example:

 @Options
 public ApplicationInfo describe();
 
 @Options("wadl|html")
 public Representation describe();
 
 @Options("wadl?param=val")
 public Representation describeWithParam();
 
 @Options("wadl?param")
 public Representation describeWithParam();
 
 @Options("?param")
 public Representation describeWithParam();
 

Author:

Jerome Louvel

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	value	Specifies the media type extension of the response entity.

Element Details

value

String value

Specifies the media type extension of the response entity. 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 MetadataService. For a list of all predefined extensions, please check MetadataService.addCommonExtensions(). New extension can be registered using MetadataService.addExtension(String, org.restlet.data.Metadata) method.

Returns:

The result media types.

Default:

""