org.apache.juneau.rest.annotation

Annotation Type Query

@Documented
 @Target(value=PARAMETER)
 @Retention(value=RUNTIME)
 @Inherited
public @interface Query

Identical to @FormData, but only retrieves the parameter from the URL string, not URL-encoded form posts.

Unlike @FormData, using this annotation does not result in the servlet reading the contents of URL-encoded form posts. Therefore, this annotation can be used in conjunction with the @Body annotation or RestRequest.getBody() method for application/x-www-form-urlencoded POST calls.

Example:

@RestMethod(name=GET) public void doGet(RestRequest req, RestResponse res, @Query("p1") int p1, @Query("p2") String p2, @Query("p3") UUID p3) { ... }

This is functionally equivalent to the following code...

@RestMethod(name=GET) public void doGet(RestRequest req, RestResponse res) { int p1 = req.getQueryParameter(int.class, "p1", 0); String p2 = req.getQueryParameter(String.class, "p2"); UUID p3 = req.getQueryParameter(UUID.class, "p3"); ... }

See Also:

• Overview > juneau-rest-server > @Query

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	def The default value for this query parameter if it's not present in the request.
boolean	multipart Specify true if using multi-part parameters to represent collections and arrays.
String	name URL query parameter name.
Class<? extends HttpPartParser>	parser Specifies the HttpPartParser class used for parsing values from strings.
String	value A synonym for name().

Element Detail

def

public abstract String def

The default value for this query parameter if it's not present in the request.

Default:

""

multipart

public abstract boolean multipart

Specify true if using multi-part parameters to represent collections and arrays.

Normally, we expect single parameters to be specified in UON notation for representing collections of values (e.g. "&key=(1,2,3)". This annotation allows the use of multi-part parameters to represent collections (e.g. "&key=1&key=2&key=3".

This setting should only be applied to Java parameters of type array or Collection.

Default:

false

name

public abstract String name

URL query parameter name.

Default:

""

parser

public abstract Class<? extends HttpPartParser> parser

Specifies the HttpPartParser class used for parsing values from strings.

The default value for this parser is inherited from the servlet/method which defaults to UonPartParser.
You can use SimplePartParser to parse POJOs that are directly convertible from Strings.

Default:

org.apache.juneau.httppart.HttpPartParser.Null.class

value

public abstract String value

A synonym for name().

Allows you to use shortened notation if you're only specifying the name.

Default:

""