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.event;
20  
21  import nl.toolforge.karma.core.cmd.Command;
22  import nl.toolforge.karma.core.cmd.CommandException;
23  
24  /***
25   * Generated when the command execution failed with a <code>CommandException</code>. This event is - by default -
26   * generated when the {@link nl.toolforge.karma.core.cmd.CommandContext#execute(Command)}-method caught a
27   * CommandException.
28   *
29   * @author D.A. Smedes
30   * @version $Id: CommandFailedEvent.java,v 1.2 2004/10/26 22:47:57 hippe Exp $
31   */
32  public final class CommandFailedEvent extends ExceptionEvent {
33  
34    /***
35     * Creates the event for <code>command</code>.
36     *
37     * @param command The command that has started.
38     */
39    public CommandFailedEvent(Command command, CommandException exception) {
40      super(command, exception);
41    }
42  
43    /***
44     * Returns a SimpleMessage formatted as <code>[ &lt;command-name&gt; ] Started.</code>.
45     */
46    public Message getEventMessage() {
47      return new SimpleMessage(MessageHelper.format(getCommand().getName(), "Command FAILED!"));
48    }
49  }