pay模块批量添加缺失的javadoc文档

Author: binarywang

weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/WxPayApiData.java

@@ -35,6 +35,8 @@ public class WxPayApiData {
   private String exceptionMsg;
 
   /**
+   * Instantiates a new Wx pay api data.
+   *
    * @param url          接口请求地址
    * @param requestData  请求数据
    * @param responseData 响应数据

weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/coupon/WxPayCouponSendRequest.java

@@ -13,7 +13,6 @@
  *
  * @author <a href="https://github.com/binarywang">Binary Wang</a>
  */
-
 @Data
 @EqualsAndHashCode(callSuper = true)
 @Builder(builderMethodName = "newBuilder")

weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/coupon/WxPayCouponStockQueryRequest.java

@@ -13,7 +13,6 @@
  *
  * @author <a href="https://github.com/binarywang">Binary Wang</a>
  */
-
 @Data
 @EqualsAndHashCode(callSuper = true)
 @Builder(builderMethodName = "newBuilder")

weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/entpay/EntPayRequest.java

@@ -20,7 +20,6 @@
  *
  * @author <a href="https://github.com/binarywang">Binary Wang</a>
  */
-
 @Data
 @EqualsAndHashCode(callSuper = true)
 @Builder(builderMethodName = "newBuilder")

weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayNotifyResponse.java

@@ -32,13 +32,25 @@ public class WxPayNotifyResponse {
   @XStreamAlias("return_msg")
   private String returnMsg;
 
+  /**
+   * Fail string.
+   *
+   * @param msg the msg
+   * @return the string
+   */
   public static String fail(String msg) {
     WxPayNotifyResponse response = new WxPayNotifyResponse(FAIL, msg);
     XStream xstream = XStreamInitializer.getInstance();
     xstream.autodetectAnnotations(true);
     return xstream.toXML(response);
   }
 
+  /**
+   * Success string.
+   *
+   * @param msg the msg
+   * @return the string
+   */
   public static String success(String msg) {
     WxPayNotifyResponse response = new WxPayNotifyResponse(SUCCESS, msg);
     XStream xstream = XStreamInitializer.getInstance();

weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayOrderNotifyCoupon.java

@@ -12,6 +12,7 @@
 
 /**
  * 支付异步通知代金券详细.
+ *
  * @author aimilin
  */
 @Data
@@ -23,6 +24,12 @@ public class WxPayOrderNotifyCoupon implements Serializable {
   private String couponType;
   private Integer couponFee;
 
+  /**
+   * To map map.
+   *
+   * @param index the index
+   * @return the map
+   */
   public Map<String, String> toMap(int index) {
     Map<String, String> map = new HashMap<>();
     map.put("coupon_id_" + index, this.getCouponId());

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

@@ -285,6 +285,12 @@ public class WxPayOrderNotifyResult extends BaseWxPayResult {
   @XStreamAlias("version")
   private String version;
 
+  /**
+   * From xml wx pay order notify result.
+   *
+   * @param xmlString the xml string
+   * @return the wx pay order notify result
+   */
   public static WxPayOrderNotifyResult fromXML(String xmlString) {
     XStream xstream = XStreamInitializer.getInstance();
     xstream.processAnnotations(WxPayOrderNotifyResult.class);

weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayRefundNotifyResult.java

@@ -40,6 +40,8 @@ public class WxPayRefundNotifyResult extends BaseWxPayResult implements Serializ
    *
    * @param xmlString xml字符串
    * @param mchKey    商户密钥
+   * @return the wx pay refund notify result
+   * @throws WxPayException the wx pay exception
    */
   public static WxPayRefundNotifyResult fromXML(String xmlString, String mchKey) throws WxPayException {
     WxPayRefundNotifyResult result = BaseWxPayResult.fromXML(xmlString, WxPayRefundNotifyResult.class);
@@ -252,6 +254,12 @@ public String toString() {
     @XStreamAlias("refund_request_source")
     private String refundRequestSource;
 
+    /**
+     * From xml req info.
+     *
+     * @param xmlString the xml string
+     * @return the req info
+     */
     public static ReqInfo fromXML(String xmlString) {
       XStream xstream = XStreamInitializer.getInstance();
       xstream.processAnnotations(ReqInfo.class);

weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/BaseWxPayRequest.java

@@ -121,6 +121,7 @@ public abstract class BaseWxPayRequest implements Serializable {
    * 将单位为元转换为单位为分.
    *
    * @param yuan 将要转换的元的数值字符串
+   * @return the integer
    */
   public static Integer yuanToFen(String yuan) {
     return new BigDecimal(yuan).setScale(2, BigDecimal.ROUND_HALF_UP).multiply(new BigDecimal(100)).intValue();
@@ -143,6 +144,8 @@ private void checkFields() throws WxPayException {
 
   /**
    * 检查约束情况.
+   *
+   * @throws WxPayException the wx pay exception
    */
   protected abstract void checkConstraints() throws WxPayException;
 
@@ -178,6 +181,11 @@ public String toString() {
     return ToStringBuilder.reflectionToString(this, ToStringStyle.JSON_STYLE);
   }
 
+  /**
+   * To xml string.
+   *
+   * @return the string
+   */
   public String toXML() {
     XStream xstream = XStreamInitializer.getInstance();
     //涉及到服务商模式的两个参数，在为空值时置为null，以免在请求时将空值传给微信服务器
@@ -189,13 +197,17 @@ public String toXML() {
 
   /**
    * 签名时，是否忽略appid.
+   *
+   * @return the boolean
    */
   protected boolean ignoreAppid() {
     return false;
   }
 
   /**
    * 签名时，忽略的参数.
+   *
+   * @return the string [ ]
    */
   protected String[] getIgnoredParamsForSign() {
     return new String[0];
@@ -210,6 +222,7 @@ protected String[] getIgnoredParamsForSign() {
    * </pre>
    *
    * @param config 支付配置对象，用于读取相应系统配置信息
+   * @throws WxPayException the wx pay exception
    */
   public void checkAndSign(WxPayConfig config) throws WxPayException {
     this.checkFields();

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

@@ -116,13 +116,19 @@ public abstract class BaseWxPayResult implements Serializable {
    * 将单位分转换成单位圆.
    *
    * @param fen 将要被转换为元的分的数值
+   * @return the string
    */
   public static String fenToYuan(Integer fen) {
     return BigDecimal.valueOf(Double.valueOf(fen) / 100).setScale(2, BigDecimal.ROUND_HALF_UP).toPlainString();
   }
 
   /**
    * 从xml字符串创建bean对象.
+   *
+   * @param <T>       the type parameter
+   * @param xmlString the xml string
+   * @param clz       the clz
+   * @return the t
    */
   public static <T extends BaseWxPayResult> T fromXML(String xmlString, Class<T> clz) {
     XStream xstream = XStreamInitializer.getInstance();
@@ -132,6 +138,11 @@ public static <T extends BaseWxPayResult> T fromXML(String xmlString, Class<T> c
     return result;
   }
 
+  /**
+   * Gets logger.
+   *
+   * @return the logger
+   */
   protected Logger getLogger() {
     return LoggerFactory.getLogger(this.getClass());
   }
@@ -143,6 +154,8 @@ public String toString() {
 
   /**
    * 将bean通过保存的xml字符串转换成map.
+   *
+   * @return the map
    */
   public Map<String, String> toMap() {
     if (StringUtils.isBlank(this.xmlString)) {
@@ -189,6 +202,9 @@ private Document getXmlDoc() {
 
   /**
    * 获取xml中元素的值.
+   *
+   * @param path the path
+   * @return the xml value
    */
   String getXmlValue(String... path) {
     Document doc = this.getXmlDoc();
@@ -206,6 +222,9 @@ String getXmlValue(String... path) {
 
   /**
    * 获取xml中元素的值，作为int值返回.
+   *
+   * @param path the path
+   * @return the xml value as int
    */
   Integer getXmlValueAsInt(String... path) {
     String result = this.getXmlValue(path);
@@ -219,8 +238,10 @@ Integer getXmlValueAsInt(String... path) {
   /**
    * 校验返回结果签名.
    *
+   * @param wxPayService the wx pay service
    * @param signType     签名类型
    * @param checkSuccess 是否同时检查结果是否成功
+   * @throws WxPayException the wx pay exception
    */
   public void checkResult(WxPayService wxPayService, String signType, boolean checkSuccess) throws WxPayException {
     //校验返回结果签名