View Javadoc

1   /*
2    *  XNap - A P2P framework and client.
3    *
4    *  See the file AUTHORS for copyright information.
5    *
6    *  This program is free software; you can redistribute it and/or modify
7    *  it under the terms of the GNU General Public License as published by
8    *  the Free Software Foundation.
9    *
10   *  This program is distributed in the hope that it will be useful,
11   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   *  GNU General Public License for more details.
14   *
15   *  You should have received a copy of the GNU General Public License
16   *  along with this program; if not, write to the Free Software
17   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   */
19  
20  package org.xnap.chat.command;
21  
22  import java.util.StringTokenizer;
23  
24  import org.xnap.XNap;
25  import org.xnap.cmdl.AbstractCommand;
26  import org.xnap.cmdl.Console;
27  import org.xnap.cmdl.SyntaxException;
28  
29  /***
30   * Provides the default part command.
31   */
32  public abstract class AbstractPartChannelCommand extends AbstractCommand
33  {
34      
35      //--- Constant(s) ---
36      
37      //--- Data field(s) ---
38  
39  	//--- Constructor(s) ---
40      
41      public AbstractPartChannelCommand()
42      {
43  		putValue(CMD, "part");
44  		putValue(ALIASES, new String[] { "p" });
45  		putValue(PARAMETER, "[channel]");
46  		putValue(SHORT_HELP, XNap.tr("Parts the channel."));
47  	}
48  
49  	//--- Method(s) ---
50  
51  	public void execute(String command, Console console)
52  		throws SyntaxException
53  	{
54  		StringTokenizer t = new StringTokenizer(command);
55  		
56  		// skip command
57  		t.nextToken();
58  		
59  		part(t.hasMoreTokens() ? t.nextToken() : null);
60  	}
61  
62  	/***
63  	 * @param channel null, if no channel was passed; the channel, otherwise
64  	 */
65  	public abstract void part(String channel);
66  
67  }
68  
69