forked from Tencent/APIJSON
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathJSONRequest.java
More file actions
executable file
·197 lines (167 loc) · 5.09 KB
/
JSONRequest.java
File metadata and controls
executable file
·197 lines (167 loc) · 5.09 KB
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved.
This source code is licensed under the Apache License Version 2.0.*/
package apijson;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
/**wrapper for request
* @author Lemon
* @see #puts
* @see #toArray
* @use JSONRequest request = new JSONRequest(...);
* <br> request.puts(...);//not a must
* <br> request.toArray(...);//not a must
*/
public class JSONRequest extends JSONObject {
private static final long serialVersionUID = 1L;
public JSONRequest() {
super();
}
/**
* @param object must be annotated by {@link MethodAccess}
* @see {@link #JSONRequest(String, Object)}
*/
public JSONRequest(Object object) {
this(null, object);
}
/**
* @param name
* @param object
* @see {@link #puts(String, Object)}
*/
public JSONRequest(String name, Object object) {
this();
puts(name, object);
}
public static final String KEY_TAG = "tag";//只在最外层，最外层用JSONRequest
public static final String KEY_VERSION = "version";//只在最外层，最外层用JSONRequest
public static final String KEY_FORMAT = "format";//只在最外层，最外层用JSONRequest
/**set "tag":tag in outermost layer
* for write operations
* @param tag
* @return
*/
public JSONRequest setTag(String tag) {
return puts(KEY_TAG, tag);
}
/**set "version":version in outermost layer
* for target version of request
* @param version
* @return
*/
public JSONRequest setVersion(Integer version) {
return puts(KEY_VERSION, version);
}
/**set "format":format in outermost layer
* for format APIJSON special keys to normal keys of response
* @param format
* @return
*/
public JSONRequest setFormat(Boolean format) {
return puts(KEY_FORMAT, format);
}
//array object <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
public static final int QUERY_TABLE = 0;
public static final int QUERY_TOTAL = 1;
public static final int QUERY_ALL = 2;
public static final String QUERY_TABLE_STRING = "TABLE";
public static final String QUERY_TOTAL_STRING = "TOTAL";
public static final String QUERY_ALL_STRING = "ALL";
public static final String SUBQUERY_RANGE_ALL = "ALL";
public static final String SUBQUERY_RANGE_ANY = "ANY";
public static final String KEY_QUERY = "query";
public static final String KEY_COUNT = "count";
public static final String KEY_PAGE = "page";
public static final String KEY_JOIN = "join";
public static final String KEY_SUBQUERY_RANGE = "range";
public static final String KEY_SUBQUERY_FROM = "from";
public static final List<String> ARRAY_KEY_LIST;
static {
ARRAY_KEY_LIST = new ArrayList<String>();
ARRAY_KEY_LIST.add(KEY_QUERY);
ARRAY_KEY_LIST.add(KEY_COUNT);
ARRAY_KEY_LIST.add(KEY_PAGE);
ARRAY_KEY_LIST.add(KEY_JOIN);
ARRAY_KEY_LIST.add(KEY_SUBQUERY_RANGE);
ARRAY_KEY_LIST.add(KEY_SUBQUERY_FROM);
}
/**set what to query in Array layer
* @param query what need to query, Table,total,ALL?
* @return
* @see {@link #QUERY_TABLE}
* @see {@link #QUERY_TOTAL}
* @see {@link #QUERY_ALL}
*/
public JSONRequest setQuery(int query) {
return puts(KEY_QUERY, query);
}
/**set maximum count of Tables to query in Array layer
* @param count <= 0 || >= max ? max : count
* @return
*/
public JSONRequest setCount(int count) {
return puts(KEY_COUNT, count);
}
/**set page of Tables to query in Array layer
* @param page <= 0 ? 0 : page
* @return
*/
public JSONRequest setPage(int page) {
return puts(KEY_PAGE, page);
}
/**set joins of Main Table and it's Vice Tables in Array layer
* @param joins "@/User/id@", "&/User/id@,>/Comment/momentId@" ...
* @return
*/
public JSONRequest setJoin(String... joins) {
return puts(KEY_JOIN, StringUtil.getString(joins));
}
/**set range for Subquery
* @param range
* @return
* @see {@link #SUBQUERY_RANGE_ALL}
* @see {@link #SUBQUERY_RANGE_ANY}
*/
public JSONRequest setSubqueryRange(String range) {
return puts(KEY_SUBQUERY_RANGE, range);
}
/**set from for Subquery
* @param range
* @return
*/
public JSONRequest setSubqueryFrom(String from) {
return puts(KEY_SUBQUERY_FROM, from);
}
//array object >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
/**create a parent JSONObject named KEY_ARRAY
* @param count
* @param page
* @return {@link #toArray(int, int)}
*/
public JSONRequest toArray(int count, int page) {
return toArray(count, page, null);
}
/**create a parent JSONObject named name+KEY_ARRAY.
* @param count
* @param page
* @param name
* @return {name+KEY_ARRAY : this}. if needs to be put, use {@link #putsAll(Map<? extends String, ? extends Object>)} instead
*/
public JSONRequest toArray(int count, int page, String name) {
return new JSONRequest(StringUtil.getString(name) + KEY_ARRAY, this.setCount(count).setPage(page));
}
@Override
public JSONObject putsAll(Map<? extends String, ? extends Object> map) {
super.putsAll(map);
return this;
}
@Override
public JSONRequest puts(Object value) {
return puts(null, value);
}
@Override
public JSONRequest puts(String key, Object value) {
super.puts(key, value);
return this;
}
}