DMDirc-Plugins/src/com/dmdirc/addons/parser_twitter/api/TwitterMessage.java

/*
 *  Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in
 *  all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 *  SOFTWARE.
 */

package com.dmdirc.addons.parser_twitter.api;

import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * Used for direct messages.
 *
 * @author shane
 */
public class TwitterMessage implements Comparable<TwitterMessage> {
    /** ID of this message. */
    final long id;

    /** Contents of this message. */
    final String message;

    /** Owner of this message. */
    final String sender;
    
    /** Target of this message. */
    final String target;

    /** API Object that owns this. */
    private final TwitterAPI myAPI;

    /** Time this message was sent. */
    private final long time;

    /**
     * Create a new TwitterMessage
     *
     * @param api
     * @param message Message contents
     */
    protected TwitterMessage(final TwitterAPI api, final String message) {
        this(api, message, -1, "", "", System.currentTimeMillis());
    }

    /**
     * Create a new TwitterMessage
     *
     * @param api
     * @param message Message contents
     * @param id ID of message
     * @param sender User who send this.
     * @param time Time this message was sent
     */
    protected TwitterMessage(final TwitterAPI api, final String message, final long id, final String sender, final String target, final Long time) {
        this.myAPI = api;
        this.id = id;
        this.message = message;
        this.sender = sender;
        this.target = target;
        this.time = time;
    }

    /**
     * Create a twitter status from a node!
     *
     * @param api API that owns this.
     * @param node Node to use.
     */
    protected TwitterMessage(final TwitterAPI api, final Node node) {
        if (!(node instanceof Element)) { throw new TwitterRuntimeException("Can only use Element type nodes for message creation."); }
        this.myAPI = api;
        final Element element = (Element) node;

        this.message = TwitterAPI.getElementContents(element, "text", "");

        final TwitterUser senderUser;

        final NodeList senderNodes = element.getElementsByTagName("sender");
        if (senderNodes != null && senderNodes.getLength() > 0) {
            senderUser = new TwitterUser(api, senderNodes.item(0), null);
            this.sender = senderUser.getScreenName();
            myAPI.updateUser(senderUser);
        } else {
            senderUser = new TwitterUser(api, "unknown", -1, "realname", false);
            this.sender = senderUser.getScreenName();
        }

        final TwitterUser targetUser;
        final NodeList recipientNodes = element.getElementsByTagName("recipient");
        if (recipientNodes != null && recipientNodes.getLength() > 0) {
            targetUser = new TwitterUser(api, recipientNodes.item(0), null);
            this.target = targetUser.getScreenName();
            myAPI.updateUser(targetUser);
        } else {
            targetUser = new TwitterUser(api, "unknown", -1, "realname", false);
            this.target = targetUser.getScreenName();
        }

        this.id = TwitterAPI.parseLong(TwitterAPI.getElementContents(element, "id", ""), -1);
        this.time = TwitterAPI.timeStringToLong(TwitterAPI.getElementContents(element, "created_at", ""), 0);
    }

    /**
     * Get the screen name of the user who sent this message.
     *
     * @return Screen name of the user who sent this message.
     */
    public String getSenderScreenName() {
        return sender;
    }

    /**
     * Get the user who sent this message.
     *
     * @return The user who sent this message.
     */
    public TwitterUser getSender() {
        return myAPI.getCachedUser(sender);
    }

    /**
     * Get the screen name of the user who received this message.
     *
     * @return Screen name of the user who received this message.
     */
    public String getTargetScreenName() {
        return target;
    }

    /**
     * Get the user who received this message.
     *
     * @return The user who received this message.
     */
    public TwitterUser getTarget() {
        return myAPI.getCachedUser(target);
    }
    
    /**
     * Get the ID of this message.
     *
     * @return ID of this message.
     */
    public long getID() {
        return id;
    }

    /**
     * What time was this message sent?
     *
     * @return Time this message was sent.
     */
    public long getTime() {
        return this.time;
    }

    /**
     * Get the contents of this message.
     *
     * @return contents of this message.
     */
    public String getText() {
        return message;
    }

    /**
     * Is this equal to the given Status?
     * @param message
     * @return
     */
    @Override
    public boolean equals(final Object message) {
        if (message instanceof TwitterMessage) {
            return ((TwitterMessage)message).getID() == this.id;
        } else {
            return false;
        }
    }

    /**
     * Generate hashCode for this object.
     * @return
     */
    @Override
    public int hashCode() {
        int hash = 5;
        hash = 53 * hash + (int) (this.id ^ (this.id >>> 32));
        return hash;
    }

    /**
     * Compare the given object to this one.
     *
     * @param arg0
     * @return Comparison
     */
    @Override
    public int compareTo(final TwitterMessage arg0) {
        if (this.time < arg0.getTime()) {
            return -1;
        } else if (this.time > arg0.getTime()) {
            return 1;
        } else {
            return 0;
        }
    }
}