Skip to content

Commit 04e115c

Browse files
binarywangbinarywang
committed
优化javadoc
1 parent b12a7a8 commit 04e115c

File tree

1 file changed

+134
-126
lines changed

1 file changed

+134
-126
lines changed

‎weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxPayOrderNotifyResult.java‎

Lines changed: 134 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -25,170 +25,178 @@ public class WxPayOrderNotifyResult extends WxPayBaseResult implements Serializa
2525

2626
/**
2727
* <pre>
28-
* 设备号
29-
* device_info
30-
* 否
31-
* String(32)
32-
* 013467007045764
33-
* 微信支付分配的终端设备号，
28+
* 字段名：设备号
29+
* 变量名：device_info
30+
* 是否必填：否
31+
* 类型：String(32)
32+
* 示例值：013467007045764
33+
* 描述：微信支付分配的终端设备号，
3434
* </pre>
3535
*/
3636
@XStreamAlias("device_info")
3737
private String deviceInfo;
3838

3939
/**
4040
* <pre>
41-
* 用户标识
42-
* openid
43-
* 是
44-
* String(128)
45-
* wxd930ea5d5a258f4f
46-
* 用户在商户appid下的唯一标识
41+
* 字段名：用户标识
42+
* 变量名：openid
43+
* 是否必填：是
44+
* 类型：String(128)
45+
* 示例值：wxd930ea5d5a258f4f
46+
* 描述：用户在商户appid下的唯一标识
4747
* </pre>
4848
*/
4949
@XStreamAlias("openid")
5050
private String openid;
5151

5252
/**
5353
* <pre>
54-
* 是否关注公众账号
55-
* is_subscribe
56-
* 否
57-
* String(1)
58-
* Y
59-
* 用户是否关注公众账号，Y-关注，N-未关注，仅在公众账号类型支付有效
54+
* 字段名：是否关注公众账号
55+
* 变量名：is_subscribe
56+
* 是否必填：否
57+
* 类型：String(1)
58+
* 示例值：Y
59+
* 描述：用户是否关注公众账号，Y-关注，N-未关注，仅在公众账号类型支付有效
6060
* </pre>
6161
*/
6262
@XStreamAlias("is_subscribe")
6363
private String isSubscribe;
6464

65-
6665
/**
6766
* <pre>
68-
* 交易类型
69-
* trade_type
70-
* 是
71-
* String(16)
72-
* JSAPI JSAPI、NATIVE、APP
67+
* 字段名：用户子标识
68+
* 变量名：sub_openid
69+
* 是否必填：是
70+
* 类型：String(128)
71+
* 示例值：wxd930ea5d5a258f4f
72+
* 描述：用户在子商户appid下的唯一标识
7373
* </pre>
7474
*/
75-
@XStreamAlias("trade_type")
76-
private String tradeType;
77-
75+
@XStreamAlias("sub_openid")
76+
private String subOpenid;
7877

7978
/**
8079
* <pre>
81-
* 付款银行
82-
* bank_type
83-
* 是
84-
* String(16)
85-
* CMC
86-
* 银行类型，采用字符串类型的银行标识，银行类型见银行列表
80+
* 字段名：是否关注子公众账号
81+
* 变量名：sub_is_subscribe
82+
* 是否必填：否
83+
* 类型：String(1)
84+
* 示例值：Y
85+
* 描述：用户是否关注子公众账号，Y-关注，N-未关注，仅在公众账号类型支付有效
8786
* </pre>
8887
*/
89-
@XStreamAlias("bank_type")
90-
private String bankType;
88+
@XStreamAlias("sub_is_subscribe")
89+
private String subIsSubscribe;
90+
9191

9292
/**
9393
* <pre>
94-
* 用户是否关注子公众账号
95-
* String(1)
96-
* Y-关注，N-未关注，仅在公众账号类型支付有效
94+
* 字段名：交易类型
95+
* 变量名：trade_type
96+
* 是否必填：是
97+
* 类型：String(16)
98+
* 示例值：JSAPI
99+
* JSA描述：PI、NATIVE、APP
97100
* </pre>
98101
*/
99-
@XStreamAlias("sub_is_subscribe")
100-
private String subIsSubscribe;
102+
@XStreamAlias("trade_type")
103+
private String tradeType;
104+
101105

102106
/**
103107
* <pre>
104-
* 用户在子商户appid下的唯一标识
105-
* String(128)
108+
* 字段名：付款银行
109+
* 变量名：bank_type
110+
* 是否必填：是
111+
* 类型：String(16)
112+
* 示例值：CMC
113+
* 描述：银行类型，采用字符串类型的银行标识，银行类型见银行列表
106114
* </pre>
107115
*/
108-
@XStreamAlias("sub_openid")
109-
private String subOpenId;
116+
@XStreamAlias("bank_type")
117+
private String bankType;
110118

111119
/**
112120
* <pre>
113-
* 订单金额
114-
* total_fee
115-
* 是
116-
* Int
117-
* 100
118-
* 订单总金额，单位为分
121+
* 字段名：订单金额
122+
* 变量名：total_fee
123+
* 是否必填：是
124+
* 类型：Int
125+
* 示例值：100
126+
* 描述：订单总金额，单位为分
119127
* </pre>
120128
*/
121129
@XStreamAlias("total_fee")
122130
private Integer totalFee;
123131
/**
124132
* <pre>
125-
* 应结订单金额
126-
* settlement_total_fee
127-
* 否
128-
* Int
129-
* 100
130-
* 应结订单金额=订单金额-非充值代金券金额，应结订单金额<=订单金额。
133+
* 字段名：应结订单金额
134+
* 变量名：settlement_total_fee
135+
* 是否必填：否
136+
* 类型：Int
137+
* 示例值：100
138+
* 描述：应结订单金额=订单金额-非充值代金券金额，应结订单金额<=订单金额。
131139
* </pre>
132140
*/
133141
@XStreamAlias("settlement_total_fee")
134142
private Integer settlementTotalFee;
135143
/**
136144
* <pre>
137-
* 货币种类
138-
* fee_type
139-
* 否
140-
* String(8)
141-
* CNY
142-
* 货币类型，符合ISO4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
145+
* 字段名：货币种类
146+
* 变量名：fee_type
147+
* 是否必填：否
148+
* 类型：String(8)
149+
* 示例值：CNY
150+
* 描述：货币类型，符合ISO4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
143151
* </pre>
144152
*/
145153
@XStreamAlias("fee_type")
146154
private String feeType;
147155
/**
148156
* <pre>
149-
* 现金支付金额
150-
* cash_fee
151-
* 是
152-
* Int
153-
* 100
154-
* 现金支付金额订单现金支付金额，详见支付金额
157+
* 字段名：现金支付金额
158+
* 变量名：cash_fee
159+
* 是否必填：是
160+
* 类型：Int
161+
* 示例值：100
162+
* 描述：现金支付金额订单现金支付金额，详见支付金额
155163
* </pre>
156164
*/
157165
@XStreamAlias("cash_fee")
158166
private Integer cashFee;
159167
/**
160168
* <pre>
161-
* 现金支付货币类型
162-
* cash_fee_type
163-
* 否
164-
* String(16)
165-
* CNY
166-
* 货币类型，符合ISO4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
169+
* 字段名：现金支付货币类型
170+
* 变量名：cash_fee_type
171+
* 是否必填：否
172+
* 类型：String(16)
173+
* 示例值：CNY
174+
* 描述：货币类型，符合ISO4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
167175
* </pre>
168176
*/
169177
@XStreamAlias("cash_fee_type")
170178
private String cashFeeType;
171179
/**
172180
* <pre>
173-
* 总代金券金额
174-
* coupon_fee
175-
* 否
176-
* Int
177-
* 10
178-
* 代金券金额<=订单金额，订单金额-代金券金额=现金支付金额，详见支付金额
181+
* 字段名：总代金券金额
182+
* 变量名：coupon_fee
183+
* 是否必填：否
184+
* 类型：Int
185+
* 示例值：10
186+
* 描述：代金券金额<=订单金额，订单金额-代金券金额=现金支付金额，详见支付金额
179187
* </pre>
180188
*/
181189
@XStreamAlias("coupon_fee")
182190
private Integer couponFee;
183191

184192
/**
185193
* <pre>
186-
* 代金券使用数量
187-
* coupon_count
188-
* 否
189-
* Int
190-
* 1
191-
* 代金券使用数量
194+
* 字段名：代金券使用数量
195+
* 变量名：coupon_count
196+
* 是否必填：否
197+
* 类型：Int
198+
* 示例值：1
199+
* 描述：代金券使用数量
192200
* </pre>
193201
*/
194202
@XStreamAlias("coupon_count")
@@ -198,49 +206,49 @@ public class WxPayOrderNotifyResult extends WxPayBaseResult implements Serializa
198206

199207
/**
200208
* <pre>
201-
* 微信支付订单号
202-
* transaction_id
203-
* 是
204-
* String(32)
205-
* 1217752501201407033233368018
206-
* 微信支付订单号
209+
* 字段名：微信支付订单号
210+
* 变量名：transaction_id
211+
* 是否必填：是
212+
* 类型：String(32)
213+
* 示例值：1217752501201407033233368018
214+
* 描述：微信支付订单号
207215
* </pre>
208216
*/
209217
@XStreamAlias("transaction_id")
210218
private String transactionId;
211219

212220
/**
213221
* <pre>
214-
* 商户订单号
215-
* out_trade_no
216-
* 是
217-
* String(32)
218-
* 1212321211201407033568112322
219-
* 商户系统的订单号，与请求一致。
222+
* 字段名：商户订单号
223+
* 变量名：out_trade_no
224+
* 是否必填：是
225+
* 类型：String(32)
226+
* 示例值：1212321211201407033568112322
227+
* 描述：商户系统的订单号，与请求一致。
220228
* </pre>
221229
*/
222230
@XStreamAlias("out_trade_no")
223231
private String outTradeNo;
224232
/**
225233
* <pre>
226-
* 商家数据包
227-
* attach
228-
* 否
229-
* String(128)
230-
* 123456
231-
* 商家数据包，原样返回
234+
* 字段名：商家数据包
235+
* 变量名：attach
236+
* 是否必填：否
237+
* 类型：String(128)
238+
* 示例值：123456
239+
* 描述：商家数据包，原样返回
232240
* </pre>
233241
*/
234242
@XStreamAlias("attach")
235243
private String attach;
236244
/**
237245
* <pre>
238-
* 支付完成时间
239-
* time_end
240-
* 是
241-
* String(14)
242-
* 20141030133525
243-
* 支付完成时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
246+
* 字段名：支付完成时间
247+
* 变量名：time_end
248+
* 是否必填：是
249+
* 类型：String(14)
250+
* 示例值：20141030133525
251+
* 描述：支付完成时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
244252
* </pre>
245253
*/
246254
@XStreamAlias("time_end")
@@ -311,22 +319,6 @@ public void setBankType(String bankType) {
311319
this.bankType = bankType;
312320
}
313321

314-
public String getSubIsSubscribe() {
315-
return subIsSubscribe;
316-
}
317-
318-
public void setSubIsSubscribe(String subIsSubscribe) {
319-
this.subIsSubscribe = subIsSubscribe;
320-
}
321-
322-
public String getSubOpenId() {
323-
return subOpenId;
324-
}
325-
326-
public void setSubOpenId(String subOpenId) {
327-
this.subOpenId = subOpenId;
328-
}
329-
330322
public Integer getTotalFee() {
331323
return totalFee;
332324
}
@@ -407,6 +399,22 @@ public void setTimeEnd(String timeEnd) {
407399
this.timeEnd = timeEnd;
408400
}
409401

402+
public String getSubOpenid() {
403+
return this.subOpenid;
404+
}
405+
406+
public void setSubOpenid(String subOpenid) {
407+
this.subOpenid = subOpenid;
408+
}
409+
410+
public String getSubIsSubscribe() {
411+
return this.subIsSubscribe;
412+
}
413+
414+
public void setSubIsSubscribe(String subIsSubscribe) {
415+
this.subIsSubscribe = subIsSubscribe;
416+
}
417+
410418
@Override
411419
public Map<String, String> toMap() {
412420
Map<String, String> resultMap = BeanUtils.xmlBean2Map(this);

0 commit comments

Comments
 (0)