org.pircbotx.hooks.events.MessageEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pircbotx Show documentation

PircBotX is a simple, easy to use, Java IRC Bot Framework based off of a fork of the popular PircBot? framework, bringing many new up-to-date features and bug fixes in an official alternative distribution.

There is a newer version: 2.1

Show newest version

/**
 * Copyright (C) 2010 Leon Blakey 
 *
 * This file is part of PircBotX.
 *
 * PircBotX is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * PircBotX 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with PircBotX.  If not, see .
 */
package org.pircbotx.hooks.events;

import org.pircbotx.Channel;
import org.pircbotx.User;
import lombok.Data;
import lombok.EqualsAndHashCode;
import org.pircbotx.hooks.Event;
import org.pircbotx.PircBotX;
import org.pircbotx.hooks.types.GenericMessageEvent;

/**
 * Used whenever a message is sent to a channel.
 * @author Leon Blakey 
 */
@Data
@EqualsAndHashCode(callSuper = true)
public class MessageEvent extends Event implements GenericMessageEvent {
	protected final Channel channel;
	protected final User user;
	protected final String message;

	/**
	 * Default constructor to setup object. Timestamp is automatically set
	 * to current time as reported by {@link System#currentTimeMillis() }
	 * @param channel The channel to which the message was sent.
	 * @param user The user who sent the message.
	 * @param message The actual message sent to the channel.
	 */
	public MessageEvent(T bot, Channel channel, User user, String message) {
		super(bot);
		this.channel = channel;
		this.user = user;
		this.message = message;
	}

	/**
	 * Respond with a channel message in user: message format to
	 * the user that sent the message
	 * @param response The response to send 
	 */
	@Override
	public void respond(String response) {
		getBot().sendMessage(getChannel(), getUser(), response);
	}
}