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    *      https://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.lang3.test;
18  
19  /**
20   * Allows for testing an exception that is not visible to {@link org.apache.commons.lang3.exception.ExceptionUtils}
21   */
22  public class NotVisibleExceptionFactory {
23  
24      private static final class NotVisibleException extends Exception {
25  
26          private static final long serialVersionUID = 1L; // avoid warning
27  
28          private final Throwable cause;
29  
30          private NotVisibleException(final Throwable cause) {
31              this.cause = cause;
32          }
33  
34          @Override
35          public synchronized Throwable getCause() {
36              return cause;
37          }
38      }
39  
40      /**
41       * Create a new Exception whose getCause method returns the provided cause.
42       *
43       * @param cause the cause of the exception
44       * @return a new {@link Exception}
45       */
46      public static Exception createException(final Throwable cause) {
47          return new NotVisibleException(cause);
48      }
49  
50      private NotVisibleExceptionFactory() {
51      }
52  }