View Javadoc
1   /*
2    * This file is part of Waarp Project (named also Waarp or GG).
3    *
4    *  Copyright (c) 2019, Waarp SAS, and individual contributors by the @author
5    *  tags. See the COPYRIGHT.txt in the distribution for a full listing of
6    * individual contributors.
7    *
8    *  All Waarp Project is free software: you can redistribute it and/or
9    * modify it under the terms of the GNU General Public License as published by
10   * the Free Software Foundation, either version 3 of the License, or (at your
11   * option) any later version.
12   *
13   * Waarp is distributed in the hope that it will be useful, but WITHOUT ANY
14   * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15   * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16   *
17   *  You should have received a copy of the GNU General Public License along with
18   * Waarp . If not, see <http://www.gnu.org/licenses/>.
19   */
20  package org.waarp.common.command.exception;
21  
22  import org.waarp.common.command.ReplyCode;
23  
24  /**
25   * Abstract class for exception in commands
26   */
27  public abstract class CommandAbstractException extends Exception {
28    /**
29     *
30     */
31    private static final long serialVersionUID = 9118222235805967061L;
32  
33    /**
34     * Associated code
35     */
36    public final ReplyCode code;
37  
38    /**
39     * Associated Message if any
40     */
41    public final String message;
42  
43    /**
44     * Simplest constructor
45     *
46     * @param code
47     * @param message
48     */
49    protected CommandAbstractException(final ReplyCode code,
50                                       final String message) {
51      super(code.getMesg());
52      this.code = code;
53      this.message = message;
54    }
55  
56    /**
57     * Constructor with Throwable
58     *
59     * @param code
60     * @param message
61     * @param e
62     */
63    protected CommandAbstractException(final ReplyCode code, final String message,
64                                       final Throwable e) {
65      super(code.getMesg(), e);
66      this.code = code;
67      this.message = message;
68    }
69  
70    /**
71     *
72     */
73    @Override
74    public final String toString() {
75      return "Code: " + code.name() + " Mesg: " +
76             (message != null? message : "no specific message");
77    }
78  
79    @Override
80    public final String getMessage() {
81      return toString();
82    }
83  }