org.jsondoc.core.annotation

Annotation Type ApiQueryParam

@Documented
@Target(value={PARAMETER,ANNOTATION_TYPE})
@Retention(value=RUNTIME)
@ApiPathParam
public @interface ApiQueryParam

This annotation is to be used inside an annotation of type ApiParams

Author:

Fabio Maffioletti

See Also:

ApiParams

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of the url parameter, as expected by the server

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	allowedvalues An array representing the allowed values this parameter can have.
Class<?>	clazz Specify this element if you need to use the ApiParam annotation on the method declaration and not inside the method's signature.
String	defaultvalue The default value for this parameter, if it is not passed in the query string
String	description A description of what the parameter is needed for
String	format The format from the parameter (ex.
boolean	required Whether this parameter is required or not.

Element Detail

name

public abstract String name

The name of the url parameter, as expected by the server

Returns:

description

public abstract String description

A description of what the parameter is needed for

Returns:

Default:

""

required

public abstract boolean required

Whether this parameter is required or not. Default value is true

Returns:

Default:

true

allowedvalues

public abstract String[] allowedvalues

An array representing the allowed values this parameter can have. Default value is *

Returns:

Default:

{}

format

public abstract String format

The format from the parameter (ex. yyyy-MM-dd HH:mm:ss, ...)

Returns:

Default:

""

defaultvalue

public abstract String defaultvalue

The default value for this parameter, if it is not passed in the query string

Returns:

Default:

""

clazz

public abstract Class<?> clazz

Specify this element if you need to use the ApiParam annotation on the method declaration and not inside the method's signature. This is to be able to document old style servlets' methods like doGet and doPost. This element, even if specified, is not taken into account when the annotation is put inside the method's signature.

Returns:

Default:

org.jsondoc.core.util.JSONDocDefaultType.class