org.opencastproject.util.doc.rest

Annotation Type RestParameter

@Retention(value=RUNTIME)
public @interface RestParameter

This annotation type is used for annotating parameters for RESTful query. This annotation type needs to be kept until runtime.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description
boolean	isRequired
String	name
RestParameter.Type	type

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	defaultValue
Class<?>	jaxbClass

Element Detail

name

public abstract String name

Returns:

a name of the parameter.

description

public abstract String description

Returns:

a description of the parameter.

type

public abstract RestParameter.Type type

Returns:

a RestParameter.Type enum specifying the type of the parameter.

isRequired

public abstract boolean isRequired

Returns:

a boolean indicating whether this parameter is required.

defaultValue

public abstract String defaultValue

Returns:

a default value of the parameter.

Default:

""

jaxbClass

public abstract Class<?> jaxbClass

Returns:

the XmlType or XmlRootElement annotated class that models this parameter.

Default:

java.lang.Object.class