fr.dudie.nominatim.client.request.paramhelper

Annotation Type QueryParameter

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface QueryParameter

Declare a field as an URL query parameter.

Since:

3.0

Author:

Jeremie Huchet

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	encode Defines whether or not the output of the field value serialization should be URL encoded.
Class<? extends QueryParameterSerializer>	serializer Defines the serializer to use to convert the field value into a string value.
String	value A format string (see Formatter) in whish the output of the serialization of the field value will be merged.

Element Detail

value

public abstract String value

A format string (see Formatter) in whish the output of the serialization of the field value will be merged.

Default is "%s"

Returns:

the format string where to merge the field value

Default:

"%s"

encode

public abstract boolean encode

Defines whether or not the output of the field value serialization should be URL encoded.

Default is true.

Returns:

whether or not the output of the field value serialization should be URL encoded

Default:

true

serializer

public abstract Class<? extends QueryParameterSerializer> serializer

Defines the serializer to use to convert the field value into a string value.

Default is ToStringSerializer.

Returns:

the serializer class to use

Default:

fr.dudie.nominatim.client.request.paramhelper.ToStringSerializer.class