WeixinMessage.java

package com.foxinmy.weixin4j.request;

import java.io.Serializable;
import java.util.Date;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElements;
import javax.xml.bind.annotation.XmlTransient;

import com.foxinmy.weixin4j.type.MessageType;

/**
 * 微信消息基类
 * 
 * @className WeixinMessage
 * @author jinyu(foxinmy@gmail.com)
 * @date 2015年5月6日
 * @since JDK 1.6
 * @see com.foxinmy.weixin4j.message.ImageMessage
 * @see com.foxinmy.weixin4j.message.LinkMessage
 * @see com.foxinmy.weixin4j.message.LocationMessage
 * @see com.foxinmy.weixin4j.message.TextMessage
 * @see com.foxinmy.weixin4j.message.VideoMessage
 * @see com.foxinmy.weixin4j.message.VoiceMessage
 * @see com.foxinmy.weixin4j.message.event.EventMessage
 * @see com.foxinmy.weixin4j.message.event.LocationEventMessage
 * @see com.foxinmy.weixin4j.message.event.MenuEventMessage
 * @see com.foxinmy.weixin4j.message.event.MenuLocationEventMessage
 * @see com.foxinmy.weixin4j.message.event.MenuPhotoEventMessage
 * @see com.foxinmy.weixin4j.message.event.MenuScanEventMessage
 * @see com.foxinmy.weixin4j.mp.event.KfCloseEventMessage
 * @see com.foxinmy.weixin4j.mp.event.KfCreateEventMessage
 * @see com.foxinmy.weixin4j.mp.event.KfSwitchEventMessage
 * @see com.foxinmy.weixin4j.mp.event.MassEventMessage
 * @see com.foxinmy.weixin4j.mp.event.ScanEventMessage
 * @see com.foxinmy.weixin4j.mp.event.ScribeEventMessage
 * @see com.foxinmy.weixin4j.mp.event.TemplatesendjobfinishMessage
 * @see com.foxinmy.weixin4j.qy.event.BatchjobresultMessage
 * @see com.foxinmy.weixin4j.qy.event.EnterAgentEventMessage
 * @see com.foxinmy.weixin4j.qy.event.ScribeEventMessage
 */
public class WeixinMessage implements Serializable {

	private static final long serialVersionUID = 7761192742840031607L;

	/**
	 * 开发者微信号
	 */
	@XmlElement(name = "ToUserName")
	private String toUserName;
	/**
	 * 发送方账号 即用户的openid
	 */
	@XmlElement(name = "FromUserName")
	private String fromUserName;
	/**
	 * 消息创建时间 系统毫秒数
	 */
	@XmlElement(name = "CreateTime")
	private long createTime;
	/**
	 * 消息类型
	 */
	@XmlElement(name = "MsgType")
	private String msgType;
	/**
	 * 消息ID 可用于排重
	 */
	@XmlElements({ @XmlElement(name = "MsgId"), @XmlElement(name = "MsgID") })
	private long msgId;
	/**
	 * 企业号独有的应用ID
	 */
	@XmlElements({ @XmlElement(name = "AgentId"), @XmlElement(name = "AgentID") })
	private String agentId;

	public WeixinMessage() {
		// jaxb required
	}

	public WeixinMessage(String msgType) {
		this.msgType = msgType;
	}

	public String getToUserName() {
		return toUserName;
	}

	public String getFromUserName() {
		return fromUserName;
	}

	public long getCreateTime() {
		return createTime;
	}

	@XmlTransient
	public Date getFormatCreateTime() {
		return new Date(createTime * 1000l);
	}

	public String getMsgType() {
		return msgType;
	}

	@XmlTransient
	public MessageType getFormatMsgType() {
		return MessageType.valueOf(msgType);
	}

	public long getMsgId() {
		return msgId;
	}

	public String getAgentId() {
		return agentId;
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((agentId == null) ? 0 : agentId.hashCode());
		result = prime * result + (int) (createTime ^ (createTime >>> 32));
		result = prime * result
				+ ((fromUserName == null) ? 0 : fromUserName.hashCode());
		result = prime * result + (int) (msgId ^ (msgId >>> 32));
		result = prime * result + ((msgType == null) ? 0 : msgType.hashCode());
		result = prime * result
				+ ((toUserName == null) ? 0 : toUserName.hashCode());
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		WeixinMessage other = (WeixinMessage) obj;
		if (msgId > 0l && other.getMsgId() > 0l) {
			return msgId == other.getMsgId();
		}
		return fromUserName.equals(other.getFromUserName())
				&& createTime == other.getCreateTime();
	}

	@Override
	public String toString() {
		String toString = " toUserName=" + toUserName + ", fromUserName="
				+ fromUserName + ", createTime=" + createTime + ", msgType="
				+ msgType;
		if (msgId > 0l) {
			toString += ", msgId=" + msgId;
		}
		if (agentId != null) {
			toString += ", agentId=" + agentId;
		}
		return toString;
	}
}