View Javadoc

1   /*
2    * Copyright 2006-2016 The JGUIraffe Team.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License")
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package net.sf.jguiraffe.locators;
17  
18  
19  /**
20   * <p>
21   * An exception class for reporting error conditions related to
22   * <code>{@link Locator}</code> objects.
23   * </p>
24   * <p>
25   * Exceptions of this type can be thrown by the methods of the
26   * <code>{@link Locator}</code> interface if the resources they should
27   * represent are invalid or cannot be found. Note that this is a runtime
28   * exception because error conditions of this type are usually caused by
29   * programming errors and cannot be recovered from.
30   * </p>
31   *
32   * @author Oliver Heger
33   * @version $Id: LocatorException.java 205 2012-01-29 18:29:57Z oheger $
34   */
35  public class LocatorException extends RuntimeException
36  {
37      /**
38       * The serial version UID.
39       */
40      private static final long serialVersionUID = -2259033559671621966L;
41  
42      /**
43       * Creates a new instance of <code>LocatorException</code>.
44       */
45      public LocatorException()
46      {
47          super();
48      }
49  
50      /**
51       * Creates a new instance of <code>LocatorException</code> and sets an
52       * error message.
53       *
54       * @param msg the error message
55       */
56      public LocatorException(String msg)
57      {
58          super(msg);
59      }
60  
61      /**
62       * Creates a new instance of <code>LocatorException</code> and sets an
63       * error message and a root cause.
64       *
65       * @param msg the error message
66       * @param cause the root cause
67       */
68      public LocatorException(String msg, Throwable cause)
69      {
70          super(msg, cause);
71      }
72  
73      /**
74       * Creates a new instance of <code>LocatorException</code> and sets the
75       * root cause.
76       *
77       * @param cause the root cause
78       */
79      public LocatorException(Throwable cause)
80      {
81          super(cause);
82      }
83  }