-
Notifications
You must be signed in to change notification settings - Fork 16
/
QueryParams.java
executable file
·68 lines (64 loc) · 2.15 KB
/
QueryParams.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
package com.lonepulse.robozombie.annotation;
/*
* #%L
* RoboZombie
* %%
* Copyright (C) 2013 - 2014 Lonepulse
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.Map;
/**
* <p>Identifies multiple static or dynamic <b>query parameters</b> which are to be included in
* a <a href="http://en.wikipedia.org/wiki/Query_string">query string</a>.</p>
*
* <p>This annotation can be used on the request definition to identify static query parameters
* as well as on a request parameter of type {@link Map}<String, String> to identify a set
* of dynamic query parameters.</p>
* <br>
* <b>Usage:</b>
* <br>
* <br>
* <p>
* <code><pre>@GET("/users/{user}/repos")
*<b>@QueryParams</b>({@Param(name = "per_page", value = "5")})
*List<Repo> getReposPaginated(<b>@QueryParams</b> Map<String, String> pageParams, ...);
* </code></pre>
* </p>
* <br>
* @version 1.1.0
* <br><br>
* @since 1.3.0
* <br><br>
* @author <a href="http://sahan.me">Lahiru Sahan Jayasinghe</a>
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.PARAMETER})
public @interface QueryParams {
/**
* <p>An array of {@link Param}s which identifies a set of query parameters which are constant
* for every invocation of this request.</p>
*
* @return an array of static query {@link Param}s for every invocation of this request
* <br><br>
* @since 1.3.0
*/
Param[] value() default {};
}