View Javadoc

1   /*
2    * Zemucan: A Syntax Assistant for DB2
3    * Copyright (C) 2009, 2010 Andres Gomez Casanova
4    *
5    * This file is part of Zemucan.
6    *
7    * Zemucan is free software: you can redistribute it and/or modify
8    * it under the terms of the GNU Lesser General Public License as published by
9    * the Free Software Foundation; either version 3 of the License, or
10   * (at your option) any later version.
11   *
12   * Zemucan is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   * GNU Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public License
18   * along with this library; if not, see <http://www.gnu.org/licenses/>.
19   *
20   * Contact:
21   * a n g o c a  at  y a h o o  dot  c o m
22   * Cra. 45 No 61 - 31, Bogota, Colombia.
23   *
24   * Author:   $LastChangedBy: angoca $:
25   * Date:     $LastChangedDate: 2011-03-06 09:19:05 -0500 (dom, 06 mar 2011) $:
26   * Revision: $LastChangedRevision: 1910 $:
27   * URL:      $HeadURL: https://zemucan.svn.sourceforge.net/svnroot/zemucan/branches/zemucan_v1/source-code/executerImpl/src/main/java/name/angoca/zemucan/executer/impl/CommandNotFoundException.java $:
28   */
29  package name.angoca.zemucan.executer.impl;
30  
31  import name.angoca.zemucan.executer.api.AbstractExecuterException;
32  import name.angoca.zemucan.tools.messages.executer.Messages;
33  
34  import org.slf4j.Logger;
35  import org.slf4j.LoggerFactory;
36  
37  /**
38   * Exception when a commandNotFound is not found.
39   * <p>
40   * Note: This exception has not been tested because it depends on the execution
41   * of a commandNotFound.
42   * <p>
43   * <b>Control Version</b>
44   * <p>
45   * <ul>
46   * <li>1.0.0 Class creation.</li>
47   * <li>1.0.1 Error code.</li>
48   * <li>1.0.2 Logger and final.</li>
49   * <li>1.0.3 Asserts.</li>
50   * <li>1.0.4 New id.</li>
51   * <li>1.1.0 Get id.</li>
52   * </ul>
53   *
54   * @author Andres Gomez Casanova <a
55   *         href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
56   * @version 1.1.0 2009-11-22
57   */
58  public final class CommandNotFoundException extends AbstractExecuterException {
59  
60      /**
61       * Logger.
62       */
63      private static final Logger LOGGER = LoggerFactory
64              .getLogger(CommandNotFoundException.class);
65  
66      /**
67       * ID of the exception.
68       */
69      private static final long serialVersionUID = -4511934411417949427L;
70  
71      /**
72       * Command not found to execute.
73       */
74      private final String commandNotFound;
75  
76      /**
77       * Creates the exception wrapping the exception cause.
78       *
79       * @param command
80       *            Command not found to execute.
81       */
82      public CommandNotFoundException(final String/* ! */command) {
83          super();
84          assert command != null;
85  
86          this.commandNotFound = command;
87          CommandNotFoundException.LOGGER.trace(CommandNotFoundException.class
88                  .getName()
89                  + " created."); //$NON-NLS-1$
90      }
91  
92      /**
93       * Retrieves the problematic commandNotFound.
94       *
95       * @return The commandNotFound.
96       */
97      public String getCommand() {
98          return this.commandNotFound;
99      }
100 
101     /**
102      * Returns a message indicating the commandNotFound that could not be found.
103      *
104      * @return Message.
105      */
106     @Override
107     public String/* ! */getMessage() {
108         return Messages.getString("CommandNotFoundException." //$NON-NLS-1$
109                 + "EXEC1-CommandNotFound") + this.commandNotFound; //$NON-NLS-1$
110     }
111 }