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  package org.apache.commons.collections4;
18  
19  /**
20   * Runtime exception thrown from functors.
21   * If required, a root cause error can be wrapped within this one.
22   *
23   * @since 3.0
24   */
25  public class FunctorException extends RuntimeException {
26  
27      /** Serialization version */
28      private static final long serialVersionUID = -4704772662059351193L;
29  
30      /**
31       * Constructs a new {@code FunctorException} without specified
32       * detail message.
33       */
34      public FunctorException() {
35      }
36  
37      /**
38       * Constructs a new {@code FunctorException} with specified
39       * detail message.
40       *
41       * @param msg  the error message.
42       */
43      public FunctorException(final String msg) {
44          super(msg);
45      }
46  
47      /**
48       * Constructs a new {@code FunctorException} with specified
49       * detail message and nested {@code Throwable} root cause.
50       *
51       * @param msg        the error message.
52       * @param rootCause  the exception or error that caused this exception
53       *                   to be thrown.
54       */
55      public FunctorException(final String msg, final Throwable rootCause) {
56          super(msg, rootCause);
57      }
58  
59      /**
60       * Constructs a new {@code FunctorException} with specified
61       * nested {@code Throwable} root cause.
62       *
63       * @param rootCause  the exception or error that caused this exception
64       *                   to be thrown.
65       */
66      public FunctorException(final Throwable rootCause) {
67          super(rootCause);
68      }
69  
70  }