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.bcel.classfile;
18  
19  /**
20   * Thrown when the BCEL attempts to read a class file and determines that a class is malformed or otherwise cannot be interpreted as a class file.
21   */
22  public class ClassFormatException extends RuntimeException {
23  
24      private static final long serialVersionUID = -3569097343160139969L;
25  
26      /**
27       * Constructs a new instance with {@code null} as its detail message. The cause is not initialized, and may subsequently be initialized by a call to
28       * {@link #initCause}.
29       */
30      public ClassFormatException() {
31      }
32  
33      /**
34       * Constructs a new instance with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to
35       * {@link #initCause}.
36       *
37       * @param message the detail message. The detail message is saved for later retrieval by the {@link #getMessage()} method.
38       */
39      public ClassFormatException(final String message) {
40          super(message);
41      }
42  
43      /**
44       * Constructs a new instance with the specified detail message and cause.
45       *
46       * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
47       * @param cause   the cause (which is saved for later retrieval by the {@link #getCause()} method). A {@code null} value is permitted, and indicates that
48       *                the cause is nonexistent or unknown.
49       * @since 6.0
50       */
51      public ClassFormatException(final String message, final Throwable cause) {
52          super(message, cause);
53      }
54  
55      /**
56       * Constructs a new instance with the specified cause and a detail message of {@code (cause==null ? null : cause.toString())} (which typically contains the
57       * class and detail message of {@code cause}). This constructor is useful for runtime exceptions that are little more than wrappers for other throwables.
58       *
59       * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). A {@code null} value is permitted, and indicates that the
60       *              cause is nonexistent or unknown.
61       * @since 6.7.0
62       */
63      public ClassFormatException(final Throwable cause) {
64          super(cause);
65      }
66  }