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;
18  
19  /**
20   * Exception thrown when the Serialization process fails.
21   *
22   * <p>
23   * The original error is wrapped within this one.
24   * </p>
25   *
26   * <p>
27   * #NotThreadSafe# because Throwable is not thread-safe
28   * </p>
29   *
30   * @since 1.0
31   */
32  public class SerializationException extends RuntimeException {
33  
34      /**
35       * Required for serialization support.
36       *
37       * @see java.io.Serializable
38       */
39      private static final long serialVersionUID = 4029025366392702726L;
40  
41      /**
42       * Constructs a new {@link SerializationException} without specified
43       * detail message.
44       */
45      public SerializationException() {
46      }
47  
48      /**
49       * Constructs a new {@link SerializationException} with specified
50       * detail message.
51       *
52       * @param msg  The error message.
53       */
54      public SerializationException(final String msg) {
55          super(msg);
56      }
57  
58      /**
59       * Constructs a new {@link SerializationException} with specified
60       * detail message and nested {@link Throwable}.
61       *
62       * @param msg    The error message.
63       * @param cause  The {@link Exception} or {@link Error}
64       *  that caused this exception to be thrown.
65       */
66      public SerializationException(final String msg, final Throwable cause) {
67          super(msg, cause);
68      }
69  
70      /**
71       * Constructs a new {@link SerializationException} with specified
72       * nested {@link Throwable}.
73       *
74       * @param cause  The {@link Exception} or {@link Error}
75       *  that caused this exception to be thrown.
76       */
77      public SerializationException(final Throwable cause) {
78          super(cause);
79      }
80  
81  }