OutgoingMessage.java

package pl.radical.open.gg;

import java.util.ArrayList;
import java.util.List;
import java.util.Random;

/**
 * The class that represents message that will be sent to the Gadu-Gadu server.
 * <p>
 * Created on 2004-11-21
 * 
 * @author <a href="mailto:mati@sz.home.pl">Mateusz Szczap</a>
 */
public final class OutgoingMessage extends AbstractMessage implements IOutgoingMessage {

	private static final Random RANDOM = new Random();

	private final List<Integer> additionalRecipients = new ArrayList<Integer>();

	// private constructor
	private OutgoingMessage(final int uin, final String text, final MessageClass messageClass) {
		super(uin, text, messageClass);
		m_messageID = RANDOM.nextInt(99999);
	}

	/**
	 * Creates an outgoing message that will be poped up in a new window.
	 * 
	 * @param uin
	 *            Gadu-Gadu number to of the user to whom this message is addressed.
	 * @param messageBody
	 *            the body of the message.
	 * @return OutgoingMessage outgoing message.
	 */
	public static OutgoingMessage createNewMessage(final int uin, final String messageBody) {
		return new OutgoingMessage(uin, messageBody, MessageClass.MESSAGE);
	}

	/**
	 * Creates an outgoing message that is a part of a previous conversation
	 * 
	 * @param uin
	 *            Gadu-Gadu number to of the user to whom this message is addressed.
	 * @param messageBody
	 *            the body of the message.
	 * @return OutgoingMessage outgoing message.
	 */
	public static OutgoingMessage createChatMessage(final int uin, final String messageBody) {
		return new OutgoingMessage(uin, messageBody, MessageClass.CHAT);
	}

	/**
	 * Creates an outgoing message that only pings the user.
	 * 
	 * @param uin
	 *            Gadu-Gadu number to of the user to whom this ping is addressed.
	 * @return OutgoingMessage outgoing message.
	 */
	public static OutgoingMessage createPingMessage(final int uin) {
		return new OutgoingMessage(uin, "", MessageClass.PING);
	}

	/**
	 * Creates an outgoing message and sets a special flag that will notify Gadu-Gadu server that we do not want to
	 * receive the confirmation from the server that this message was delivered to the user it is addressed.
	 * 
	 * @param uin
	 *            Gadu-Gadu number to of the user to whom this message is addressed.
	 * @param messageBody
	 *            the body of the message.
	 * @return OutgoingMessage outgoing message.
	 */
	public static OutgoingMessage createMessageWithoutConfirmation(final int uin, final String messageBody) {
		return new OutgoingMessage(uin, messageBody, MessageClass.DO_NOT_CONFIRM);
	}

	/**
	 * Use this method if you want to set new message body on this message.
	 * 
	 * @param messageBody
	 *            the new message body.
	 * @throws NullPointerException
	 *             if the messageBody object is null.
	 */
	public void setMessageBody(final String messageBody) {
		if (messageBody.isEmpty()) {
			throw new IllegalArgumentException("messageBody cannot be null");
		}
		m_messageBody = messageBody;
	}

	/**
	 * Use this method if you want to set new uin on this message.
	 * 
	 * @param uin
	 *            the new Gadu-Gadu number to whom this message will be addressed.
	 * @throws IllegalArgumentException
	 *             if the uin is a negative value.
	 */
	public void setRecipientUin(final int recipientUin) {
		if (recipientUin < 0) {
			throw new IllegalArgumentException("uin cannot be less than 0");
		}
		super.recipientUin = recipientUin;
	}

	public void addAdditionalRecipient(final int recipientUin) {
		if (recipientUin < 0) {
			throw new IllegalArgumentException("uin cannot be less than 0");
		}
		additionalRecipients.add(Integer.valueOf(recipientUin));
	}

	public void removeAdditionalRecipient(final int recipientUin) {
		if (recipientUin < 0) {
			throw new IllegalArgumentException("uin cannot be less than 0");
		}
		additionalRecipients.remove(Integer.valueOf(recipientUin));
	}

	public int[] getAdditionalRecipients() {
		final int[] result = new int[additionalRecipients.size()];

		int i = 0;
		for (final Integer element : additionalRecipients) {
			result[i++] = element.intValue();
		}

		return result;
	}

	public int[] getAllRecipients() {
		final int[] allRecipients = new int[additionalRecipients.size() + 1];
		allRecipients[0] = super.recipientUin;

		int i = 1;
		for (final Object element : additionalRecipients) {
			allRecipients[i++] = ((Integer) element).intValue();
		}

		return allRecipients;
	}

}