TestClientMessageReceiver.java

/***************************************************************************
 *   Copyright 2006-2016 by Christian Ihle                                 *
 *   contact@kouchat.net                                                   *
 *                                                                         *
 *   This file is part of KouChat.                                         *
 *                                                                         *
 *   KouChat is free software; you can redistribute it and/or modify       *
 *   it under the terms of the GNU Lesser General Public License as        *
 *   published by the Free Software Foundation, either version 3 of        *
 *   the License, or (at your option) any later version.                   *
 *                                                                         *
 *   KouChat is distributed in the hope that it will be useful,            *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with KouChat.                                           *
 *   If not, see <http://www.gnu.org/licenses/>.                           *
 ***************************************************************************/

package net.usikkert.kouchat.testclient;

import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * Stores and queries messages.
 *
 * @author Christian Ihle
 */
public class TestClientMessageReceiver {

    private final List<TestClientMessage> receivedMessages;
    private final Pattern messagePattern;

    public TestClientMessageReceiver() {
        receivedMessages = new ArrayList<TestClientMessage>();
        messagePattern = Pattern.compile("\\[\\d{2}:\\d{2}:\\d{2}\\] <(\\w+)>: (.+)");
    }

    public void addMessage(final String message, final int color) {
        receivedMessages.add(new TestClientMessage(message, color));
    }

    /**
     * Checks if the specified message has arrived from the specified user.
     *
     * <p>Expects messages in this format: <code>[14:29:21] <Christian>: hello there</code>.</p>
     *
     * <p>Only the actual nick name and the actual message is checked. The rest is ignored.</p>
     *
     * @param nickName The nick name of the user who sent the message.
     * @param message The message the user sent.
     * @return If the message has arrived.
     */
    public boolean gotMessage(final String nickName, final String message) {
        final TestClientMessage testClientMessage = getMessage(nickName, message);

        return testClientMessage != null;
    }

    /**
     * Returns the color of the specified message from the specified user.
     *
     * <p>Expects messages in this format: <code>[14:29:21] <Christian>: hello there</code>.</p>
     *
     * @param nickName The nick name of the user who sent the message.
     * @param message The message the user sent.
     * @return The color of the message, or <code>-1</code> if the message was not found.
     */
    public int getColorOfMessage(final String nickName, final String message) {
        final TestClientMessage testClientMessage = getMessage(nickName, message);

        if (testClientMessage == null) {
            return -1;
        } else {
            return testClientMessage.getColor();
        }
    }

    private TestClientMessage getMessage(final String nickName, final String message) {
        for (final TestClientMessage receivedMessage : receivedMessages) {
            final Matcher matcher = messagePattern.matcher(receivedMessage.getMessage());

            if (matcher.matches()) {
                final String nickNameMatch = matcher.group(1);
                final String messageMatch = matcher.group(2);

                if (nickNameMatch.equals(nickName) && messageMatch.equals(message)) {
                    return receivedMessage;
                }
            }
        }

        return null;
    }

    public boolean gotAnyMessages() {
        return !receivedMessages.isEmpty();
    }

    public List<String> getMessages() {
        final List<String> messages = new ArrayList<String>();

        for (final TestClientMessage receivedMessage : receivedMessages) {
            messages.add(receivedMessage.getMessage());
        }

        return messages;
    }

    public void resetMessages() {
        receivedMessages.clear();
    }
}