View Javadoc
1   /**
2    * This file Copyright (c) 2014-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.dam.api;
35  
36  /**
37   * An abstract exception class that all DAM exceptions should extend. It is abstract to enforce usage of specific
38   * exceptions for specific cases. Implementations should provide useful constructor (e.g with typed arguments, e.g. Asset)
39   * and construct consistent messages, rather that let client code generate arbitrary messages.
40   *
41   * It is not *named* AbstractDamException to make it slightly more elegant to handle in client code.
42   *
43   * It is a RuntimeException because when thrown, subclasses of this exception are actually not meant to be dealt with by
44   * client code (other than, perhaps, presenting the user with an error message of sorts)
45   */
46  public abstract class DamException extends RuntimeException {
47      protected DamException(String message) {
48          super(message);
49      }
50  
51      protected DamException(String message, Throwable cause) {
52          super(message, cause);
53      }
54  }