修复更多的warning,尤其是导致打包warning的不规范或不必要的javadoc

This commit is contained in:
BinaryWang
2016-07-12 10:02:26 +08:00
parent 5d957582e3
commit 55e0653521
19 changed files with 77 additions and 181 deletions

View File

@@ -9,8 +9,6 @@ public interface WxCpMessageMatcher {
/**
* 消息是否匹配某种模式
* @param message
* @return
*/
public boolean match(WxCpXmlMessage message);

View File

@@ -124,7 +124,6 @@ public class WxCpMessageRouter {
/**
* 开始一个新的Route规则
* @return
*/
public WxCpMessageRouterRule rule() {
return new WxCpMessageRouterRule(this);

View File

@@ -48,7 +48,6 @@ public class WxCpMessageRouterRule {
* 设置是否异步执行默认是true
*
* @param async
* @return
*/
public WxCpMessageRouterRule async(boolean async) {
this.async = async;
@@ -59,7 +58,6 @@ public class WxCpMessageRouterRule {
* 如果agentId匹配
*
* @param agentId
* @return
*/
public WxCpMessageRouterRule agentId(Integer agentId) {
this.agentId = agentId;
@@ -70,7 +68,6 @@ public class WxCpMessageRouterRule {
* 如果msgType等于某值
*
* @param msgType
* @return
*/
public WxCpMessageRouterRule msgType(String msgType) {
this.msgType = msgType;
@@ -81,7 +78,6 @@ public class WxCpMessageRouterRule {
* 如果event等于某值
*
* @param event
* @return
*/
public WxCpMessageRouterRule event(String event) {
this.event = event;
@@ -92,7 +88,6 @@ public class WxCpMessageRouterRule {
* 如果eventKey等于某值
*
* @param eventKey
* @return
*/
public WxCpMessageRouterRule eventKey(String eventKey) {
this.eventKey = eventKey;
@@ -103,7 +98,6 @@ public class WxCpMessageRouterRule {
* 如果content等于某值
*
* @param content
* @return
*/
public WxCpMessageRouterRule content(String content) {
this.content = content;
@@ -114,7 +108,6 @@ public class WxCpMessageRouterRule {
* 如果content匹配该正则表达式
*
* @param regex
* @return
*/
public WxCpMessageRouterRule rContent(String regex) {
this.rContent = regex;
@@ -125,7 +118,6 @@ public class WxCpMessageRouterRule {
* 如果fromUser等于某值
*
* @param fromUser
* @return
*/
public WxCpMessageRouterRule fromUser(String fromUser) {
this.fromUser = fromUser;
@@ -136,7 +128,6 @@ public class WxCpMessageRouterRule {
* 如果消息匹配某个matcher用在用户需要自定义更复杂的匹配规则的时候
*
* @param matcher
* @return
*/
public WxCpMessageRouterRule matcher(WxCpMessageMatcher matcher) {
this.matcher = matcher;
@@ -147,7 +138,6 @@ public class WxCpMessageRouterRule {
* 设置微信消息拦截器
*
* @param interceptor
* @return
*/
public WxCpMessageRouterRule interceptor(WxCpMessageInterceptor interceptor) {
return interceptor(interceptor, (WxCpMessageInterceptor[]) null);
@@ -158,7 +148,6 @@ public class WxCpMessageRouterRule {
*
* @param interceptor
* @param otherInterceptors
* @return
*/
public WxCpMessageRouterRule interceptor(WxCpMessageInterceptor interceptor, WxCpMessageInterceptor... otherInterceptors) {
this.interceptors.add(interceptor);
@@ -174,7 +163,6 @@ public class WxCpMessageRouterRule {
* 设置微信消息处理器
*
* @param handler
* @return
*/
public WxCpMessageRouterRule handler(WxCpMessageHandler handler) {
return handler(handler, (WxCpMessageHandler[]) null);
@@ -185,7 +173,6 @@ public class WxCpMessageRouterRule {
*
* @param handler
* @param otherHandlers
* @return
*/
public WxCpMessageRouterRule handler(WxCpMessageHandler handler, WxCpMessageHandler... otherHandlers) {
this.handlers.add(handler);
@@ -200,7 +187,6 @@ public class WxCpMessageRouterRule {
/**
* 规则结束,代表如果一个消息匹配该规则,那么它将不再会进入其他规则
*
* @return
*/
public WxCpMessageRouter end() {
this.routerBuilder.getRules().add(this);
@@ -210,7 +196,6 @@ public class WxCpMessageRouterRule {
/**
* 规则结束,但是消息还会进入其他规则
*
* @return
*/
public WxCpMessageRouter next() {
this.reEnter = true;

View File

@@ -32,7 +32,6 @@ public interface WxCpService {
* @param timestamp
* @param nonce
* @param data 微信传输过来的数据有可能是echoStr有可能是xml消息
* @return
*/
boolean checkSignature(String msgSignature, String timestamp, String nonce, String data);
@@ -49,7 +48,6 @@ public interface WxCpService {
/**
* 获取access_token, 不强制刷新access_token
* @see #getAccessToken(boolean)
* @return
* @throws WxErrorException
*/
String getAccessToken() throws WxErrorException;
@@ -63,7 +61,6 @@ public interface WxCpService {
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取access_token
* </pre>
* @param forceRefresh 强制刷新
* @return
* @throws me.chanjar.weixin.common.exception.WxErrorException
*/
String getAccessToken(boolean forceRefresh) throws WxErrorException;
@@ -71,7 +68,6 @@ public interface WxCpService {
/**
* 获得jsapi_ticket,不强制刷新jsapi_ticket
* @see #getJsapiTicket(boolean)
* @return
* @throws WxErrorException
*/
public String getJsapiTicket() throws WxErrorException;
@@ -84,7 +80,6 @@ public interface WxCpService {
* 详情请见http://qydev.weixin.qq.com/wiki/index.php?title=微信JS接口#.E9.99.84.E5.BD.951-JS-SDK.E4.BD.BF.E7.94.A8.E6.9D.83.E9.99.90.E7.AD.BE.E5.90.8D.E7.AE.97.E6.B3.95
* </pre>
* @param forceRefresh 强制刷新
* @return
* @throws WxErrorException
*/
public String getJsapiTicket(boolean forceRefresh) throws WxErrorException;
@@ -96,7 +91,6 @@ public interface WxCpService {
* 详情请见http://qydev.weixin.qq.com/wiki/index.php?title=微信JS接口#.E9.99.84.E5.BD.951-JS-SDK.E4.BD.BF.E7.94.A8.E6.9D.83.E9.99.90.E7.AD.BE.E5.90.8D.E7.AE.97.E6.B3.95
* </pre>
* @param url url
* @return
*/
public WxJsapiSignature createJsapiSignature(String url) throws WxErrorException;
@@ -136,7 +130,7 @@ public interface WxCpService {
*
* @return 保存到本地的临时文件
* @throws WxErrorException
* @params media_id
* @param media_id
*/
File mediaDownload(String media_id) throws WxErrorException;
@@ -216,7 +210,6 @@ public interface WxCpService {
* </pre>
* @see #menuGet(String)
*
* @return
* @throws WxErrorException
*/
WxMenu menuGet() throws WxErrorException;
@@ -231,7 +224,6 @@ public interface WxCpService {
* @see #menuGet()
*
* @param agentId 企业号应用的id
* @return
* @throws WxErrorException
*/
WxMenu menuGet(String agentId) throws WxErrorException;
@@ -255,7 +247,6 @@ public interface WxCpService {
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=部门管理接口
* </pre>
*
* @return
* @throws WxErrorException
*/
List<WxCpDepart> departGet() throws WxErrorException;
@@ -291,7 +282,6 @@ public interface WxCpService {
* @param departId 必填。部门id
* @param fetchChild 非必填。1/0是否递归获取子部门下面的成员
* @param status 非必填。0获取全部员工1获取已关注成员列表2获取禁用成员列表4获取未关注成员列表。status可叠加
* @return
* @throws WxErrorException
*/
List<WxCpUser> userList(Integer departId, Boolean fetchChild, Integer status) throws WxErrorException;
@@ -306,7 +296,6 @@ public interface WxCpService {
* @param departId 必填。部门id
* @param fetchChild 非必填。1/0是否递归获取子部门下面的成员
* @param status 非必填。0获取全部员工1获取已关注成员列表2获取禁用成员列表4获取未关注成员列表。status可叠加
* @return
* @throws WxErrorException
*/
List<WxCpUser> departGetUsers(Integer departId, Boolean fetchChild, Integer status) throws WxErrorException;
@@ -350,7 +339,6 @@ public interface WxCpService {
* 获取用户
*
* @param userid
* @return
* @throws WxErrorException
*/
WxCpUser userGet(String userid) throws WxErrorException;
@@ -359,7 +347,6 @@ public interface WxCpService {
* 创建标签
*
* @param tagName
* @return
*/
String tagCreate(String tagName) throws WxErrorException;
@@ -381,7 +368,6 @@ public interface WxCpService {
/**
* 获得标签列表
*
* @return
*/
List<WxCpTag> tagGet() throws WxErrorException;
@@ -389,7 +375,6 @@ public interface WxCpService {
* 获取标签成员
*
* @param tagId
* @return
*/
List<WxCpUser> tagGetUsers(String tagId) throws WxErrorException;
@@ -478,7 +463,6 @@ public interface WxCpService {
* 当本Service没有实现某个API的时候可以用这个针对所有微信API中的GET请求
* @param url
* @param queryParam
* @return
* @throws WxErrorException
*/
String get(String url, String queryParam) throws WxErrorException;
@@ -487,7 +471,6 @@ public interface WxCpService {
* 当本Service没有实现某个API的时候可以用这个针对所有微信API中的POST请求
* @param url
* @param postData
* @return
* @throws WxErrorException
*/
String post(String url, String postData) throws WxErrorException;
@@ -503,7 +486,6 @@ public interface WxCpService {
* @param data
* @param <T>
* @param <E>
* @return
* @throws WxErrorException
*/
<T, E> T execute(RequestExecutor<T, E> executor, String uri, E data) throws WxErrorException;
@@ -536,7 +518,6 @@ public interface WxCpService {
/**
* 获取某个sessionId对应的session,如果sessionId没有对应的session则新建一个并返回。
* @param id id可以为任意字符串建议使用FromUserName作为id
* @return
*/
WxSession getSession(String id);
@@ -544,7 +525,6 @@ public interface WxCpService {
* 获取某个sessionId对应的session,如果sessionId没有对应的session若create为true则新建一个否则返回null。
* @param id id可以为任意字符串建议使用FromUserName作为id
* @param create
* @return
*/
WxSession getSession(String id, boolean create);
@@ -556,25 +536,24 @@ public interface WxCpService {
* @param sessionManager
*/
void setSessionManager(WxSessionManager sessionManager);
/**
* 上传部门列表覆盖企业号上的部门信息
* @param mediaId
* @throws WxErrorException
*/
String replaceParty(String mediaId) throws WxErrorException;
/**
* 上传用户列表覆盖企业号上的用户信息
* @param mediaId
* @throws WxErrorException
*/
String replaceUser(String mediaId) throws WxErrorException;
/**
* 获取异步任务结果
* @param joinId
* @return
* @throws WxErrorException
*/
String getTaskResult(String joinId) throws WxErrorException;

View File

@@ -510,12 +510,6 @@ public class WxCpServiceImpl implements WxCpService {
/**
* 向微信端发送请求在这里执行的策略是当发生access_token过期时才去刷新然后重新执行请求而不是全局定时请求
*
* @param executor
* @param uri
* @param data
* @return
* @throws WxErrorException
*/
public <T, E> T execute(RequestExecutor<T, E> executor, String uri, E data) throws WxErrorException {
int retryTimes = 0;

View File

@@ -28,7 +28,7 @@ public class WxCpMessage implements Serializable {
private String hqMusicUrl;
private String safe;
private List<WxArticle> articles = new ArrayList<WxArticle>();
public String getToUser() {
return toUser;
}
@@ -63,7 +63,7 @@ public class WxCpMessage implements Serializable {
public String getMsgType() {
return msgType;
}
public String getSafe() {
return safe;
}
@@ -135,18 +135,18 @@ public class WxCpMessage implements Serializable {
public void setArticles(List<WxArticle> articles) {
this.articles = articles;
}
public String toJson() {
return WxCpGsonBuilder.INSTANCE.create().toJson(this);
}
public static class WxArticle {
private String title;
private String description;
private String url;
private String picUrl;
public String getTitle() {
return title;
}
@@ -171,12 +171,11 @@ public class WxCpMessage implements Serializable {
public void setPicUrl(String picUrl) {
this.picUrl = picUrl;
}
}
/**
* 获得文本消息builder
* @return
*/
public static TextBuilder TEXT() {
return new TextBuilder();
@@ -184,7 +183,6 @@ public class WxCpMessage implements Serializable {
/**
* 获得图片消息builder
* @return
*/
public static ImageBuilder IMAGE() {
return new ImageBuilder();
@@ -192,23 +190,20 @@ public class WxCpMessage implements Serializable {
/**
* 获得语音消息builder
* @return
*/
public static VoiceBuilder VOICE() {
return new VoiceBuilder();
}
/**
* 获得视频消息builder
* @return
*/
public static VideoBuilder VIDEO() {
return new VideoBuilder();
}
/**
* 获得图文消息builder
* @return
*/
public static NewsBuilder NEWS() {
return new NewsBuilder();
@@ -216,10 +211,9 @@ public class WxCpMessage implements Serializable {
/**
* 获得文件消息builder
* @return
*/
public static FileBuilder FILE() {
return new FileBuilder();
}
}

View File

@@ -198,7 +198,6 @@ public class WxCpXmlMessage implements Serializable {
* {@link me.chanjar.weixin.common.api.WxConsts#XML_MSG_EVENT}
* </pre>
*
* @return
*/
public String getMsgType() {
return msgType;
@@ -404,7 +403,6 @@ public class WxCpXmlMessage implements Serializable {
* @param timestamp
* @param nonce
* @param msgSignature
* @return
*/
public static WxCpXmlMessage fromEncryptedXml(
String encryptedXml,
@@ -542,7 +540,6 @@ public class WxCpXmlMessage implements Serializable {
/**
* 扫描类型一般是qrcode
* @return
*/
public String getScanType() {
@@ -555,7 +552,6 @@ public class WxCpXmlMessage implements Serializable {
/**
* 扫描结果,即二维码对应的字符串信息
* @return
*/
public String getScanResult() {
return scanResult;

View File

@@ -14,14 +14,14 @@ public abstract class WxCpXmlOutMessage {
@XStreamAlias("ToUserName")
@XStreamConverter(value=XStreamCDataConverter.class)
protected String toUserName;
@XStreamAlias("FromUserName")
@XStreamConverter(value=XStreamCDataConverter.class)
protected String fromUserName;
@XStreamAlias("CreateTime")
protected Long createTime;
@XStreamAlias("MsgType")
@XStreamConverter(value=XStreamCDataConverter.class)
protected String msgType;
@@ -57,14 +57,13 @@ public abstract class WxCpXmlOutMessage {
public void setMsgType(String msgType) {
this.msgType = msgType;
}
protected String toXml() {
return XStreamTransformer.toXml((Class)this.getClass(), this);
}
/**
* 转换成加密的xml格式
* @return
*/
public String toEncryptedXml(WxCpConfigStorage wxCpConfigStorage) {
String plainXml = toXml();
@@ -74,7 +73,6 @@ public abstract class WxCpXmlOutMessage {
/**
* 获得文本消息builder
* @return
*/
public static TextBuilder TEXT() {
return new TextBuilder();
@@ -82,7 +80,6 @@ public abstract class WxCpXmlOutMessage {
/**
* 获得图片消息builder
* @return
*/
public static ImageBuilder IMAGE() {
return new ImageBuilder();
@@ -90,23 +87,20 @@ public abstract class WxCpXmlOutMessage {
/**
* 获得语音消息builder
* @return
*/
public static VoiceBuilder VOICE() {
return new VoiceBuilder();
}
/**
* 获得视频消息builder
* @return
*/
public static VideoBuilder VIDEO() {
return new VideoBuilder();
}
/**
* 获得图文消息builder
* @return
*/
public static NewsBuilder NEWS() {
return new NewsBuilder();