NullCommand.java

/*
 *  Copyright (C) 2010 Marc A. Paradise
 * 
 *  This program 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 2
 *  of the License, or (at your option) any later version.
 * 
 *  This program 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

package org.bbssh.command;
import org.bbssh.keybinding.ExecutableCommand;
import org.bbssh.session.RemoteSessionInstance;

/**
 * A non-useable commadn instance, intended to provide an emmpty command
 * id for use in lists.
 */
public class NullCommand extends ExecutableCommand {
	public int getId() { 
		return CommandConstants.NONE; 
	}
	public boolean execute(RemoteSessionInstance rsi, Object parameter) {
		return true;
	}

	public int getNameResId() {
		return CMD_NAME_NONE;
	}

	public int getDescriptionResId() {
		return CMD_DESC_NONE;
	}

	public boolean isKeyBindable() {
		return true;
	}
	public boolean isParameterRequired() {
		return false;
	}
	public boolean isMacroAction() {
		return true;
	}
	public boolean isConnectionRequired() {
		return false;
	}

}