View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.jxpath;
19  
20  /**
21   * Thrown in various situations by JXPath; may contain a nested exception.
22   */
23  public class JXPathException extends RuntimeException {
24  
25      private static final long serialVersionUID = 2L;
26  
27      /**
28       * Constructs a new {@code JXPathException} with no detail mesage.
29       */
30      public JXPathException() {
31      }
32  
33      /**
34       * Constructs a new {@code JXPathException} with the {@code String } specified as an error message.
35       *
36       * @param msg The error message for the exception.
37       */
38      public JXPathException(final String msg) {
39          super(msg);
40      }
41  
42      /**
43       * Constructs a new {@code JXPathException} with the given {@code Exception} base cause and detail message.
44       *
45       * @param msg The detail message.
46       * @param cause   The exception to be encapsulated in a JXPathException
47       */
48      public JXPathException(final String msg, final Throwable cause) {
49          super(msg, cause);
50      }
51  
52      /**
53       * Constructs a new {@code JXPathException} with a given {@code Throwable} base cause of the error.
54       *
55       * @param cause The exception to be encapsulated in a JXPathException.
56       */
57      public JXPathException(final Throwable cause) {
58          super(cause);
59      }
60  
61      /**
62       * Gets the actual exception (if any) that caused this exception to be raised.
63       *
64       * @return The encapsulated exception, or null if there is none.
65       */
66      public Throwable getException() {
67          return super.getCause();
68      }
69  
70  }