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