View Javadoc

1   /*
2   Karma core - Core of the Karma application
3   Copyright (C) 2004  Toolforge <www.toolforge.nl>
4   
5   This library is free software; you can redistribute it and/or
6   modify it under the terms of the GNU Lesser General Public
7   License as published by the Free Software Foundation; either
8   version 2.1 of the License, or (at your option) any later version.
9   
10  This library 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 GNU
13  Lesser General Public License for more details.
14  
15  You should have received a copy of the GNU Lesser General Public
16  License along with this library; if not, write to the Free Software
17  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19  package nl.toolforge.karma.core.cmd;
20  
21  import nl.toolforge.karma.core.cmd.event.CommandResponseEvent;
22  import nl.toolforge.karma.core.cmd.event.CommandResponseListener;
23  
24  /***
25   * <p>A <code>CompositeCommand</code> is suited for executing multiple commands and at the same time, act as a
26   * <code>CommandResponseListener</code>. A good example is a command traversing all modules in a manifest and calling
27   * some command on each of them.
28   *
29   * <p>When a <code>CompositeCommand</code> is registered as a listener to other commands, the composite command is
30   * responsible .
31   *
32   * @author D.A. Smedes
33   * @version $Id: CompositeCommand.java,v 1.11 2004/11/02 23:57:05 asmedes Exp $
34   */
35  public abstract class CompositeCommand extends DefaultCommand implements CommandResponseListener {
36  
37    public CompositeCommand(CommandDescriptor commandDescriptor) {
38      super(commandDescriptor);
39    }
40  
41    /***
42     * Implemenattion of {@link CommandResponseListener#commandStarted}. Made <code>final</code> because in Karma R1.0
43     * we don't use this feature that much for <code>CompositeCommand</code>s.
44     */
45    public final void commandStarted(CommandResponseEvent event) { }
46  
47    /***
48     * Implemenattion of {@link CommandResponseListener#commandFinished}. Made <code>final</code> because in Karma R1.0
49     * we don't use this feature that much for <code>CompositeCommand</code>s.
50     */
51    public final void commandFinished(CommandResponseEvent event) { }
52  
53    /***
54     * Implemenattion of {@link CommandResponseListener#messageLogged}. Made <code>final</code> because in Karma R1.0
55     * we don't use this feature that much for <code>CompositeCommand</code>s.
56     */
57    public final void messageLogged(CommandResponseEvent event) { }
58  
59  }