NickAlreadyInUseEvent.java

/**
 * Copyright (C) 2010-2014 Leon Blakey <lord.quackstar at gmail.com>
 *
 * 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 <http://www.gnu.org/licenses/>.
 */
package org.pircbotx.hooks.events;

import javax.annotation.Nullable;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NonNull;
import org.pircbotx.PircBotX;
import org.pircbotx.hooks.Event;

/**
 * A nick is already in use error from server. If auto nick change isn't
 * enabled, must send a nick before server disconnects us.
 *
 * @author Leon Blakey
 */
@Data
@EqualsAndHashCode(callSuper = true)
public class NickAlreadyInUseEvent extends Event {
	/**
	 * The nick already in use.
	 */
	protected final String usedNick;
	/**
	 * The auto changed nick, if any.
	 */
	protected final String autoNewNick;
	/**
	 * If auto nick change is enabled
	 */
	protected final boolean autoNickChange;

	public NickAlreadyInUseEvent(PircBotX bot, @NonNull String usedNick, @Nullable String autoNewNick, boolean autoNickChange) {
		super(bot);
		this.usedNick = usedNick;
		this.autoNewNick = autoNewNick;
		this.autoNickChange = autoNickChange;
	}

	/**
	 * Respond by sending a <i>NICK</i> change
	 *
	 * @param newNick The nick to set
	 */
	@Override
	public void respond(@Nullable String newNick) {
		getBot().sendIRC().changeNick(newNick);
	}
}