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.net.ftp.parser;
19  
20  /**
21   * This class encapsulates all errors that may be thrown by
22   * the process of an FTPFileEntryParserFactory creating and
23   * instantiating an FTPFileEntryParser.
24   */
25  public class ParserInitializationException extends RuntimeException {
26  
27      /**
28       * Root exception that caused this to be thrown
29       */
30      private final Throwable rootCause;
31  
32      /**
33       * Constucts a ParserInitializationException with just a message
34       *
35       * @param message Exception message
36       */
37      public ParserInitializationException(String message) {
38          super(message);
39          this.rootCause = null;
40      }
41  
42      /**
43       * Constucts a ParserInitializationException with a message
44       * and a root cause.
45       *
46       * @param message   Exception message
47       * @param rootCause root cause throwable that caused
48       * this to be thrown
49       */
50      public ParserInitializationException(String message, Throwable rootCause) {
51          super(message);
52          this.rootCause = rootCause;
53      }
54  
55      /**
56       * returns the root cause of this exception or null
57       * if no root cause was specified.
58       *
59       * @return the root cause of this exception being thrown
60       */
61      public Throwable getRootCause() {
62          return this.rootCause;
63      }
64  
65  }