CommandFilter.java

/*
This file is part of leafdigital leafChat.

leafChat 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.

leafChat 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 leafChat. If not, see <http://www.gnu.org/licenses/>.

Copyright 2011 Samuel Marshall.
*/
package com.leafdigital.irc.api;

import leafchat.core.api.*;

/** Filters user command messages based on the command */
public class CommandFilter implements MessageFilter
{
	private String command;

	/**
	 * @param command Desired command (not case-sensitive)
	 */
	public CommandFilter(String command)
	{
		this.command=command;
	}

	@Override
	public boolean accept(Msg m)
	{
		if(!(m instanceof UserCommandMsg)) return false;
		return command.equalsIgnoreCase(((UserCommandMsg)m).getCommand());
	}

	/** Scripting filter information. */
	public static FilterInfo info=new FilterInfo(CommandFilter.class)
	{
		@Override
		public FilterInfo.Parameter[] getScriptingParameters()
		{
			return new FilterInfo.Parameter[] {
				new FilterInfo.Parameter(String.class,"Command",
					"IRC command, not including the /")
			};
		}
	};
}