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;
18  
19  import org.apache.commons.lang3.ArrayUtils;
20  
21  /**
22   * Exception constants.
23   *
24   * @since 6.0 (intended to replace the InstructionConstant interface)
25   */
26  public final class ExceptionConst {
27  
28      /**
29       * Enum corresponding to the various Exception Class arrays, used by
30       * {@link ExceptionConst#createExceptions(EXCS, Class...)}
31       */
32      public enum EXCS {
33          EXCS_CLASS_AND_INTERFACE_RESOLUTION, EXCS_FIELD_AND_METHOD_RESOLUTION, EXCS_INTERFACE_METHOD_RESOLUTION, EXCS_STRING_RESOLUTION, EXCS_ARRAY_EXCEPTION,
34      }
35  
36      /**
37       * The mother of all exceptions
38       */
39      public static final Class<Throwable> THROWABLE = Throwable.class;
40  
41      /**
42       * Super class of any run-time exception
43       */
44      public static final Class<RuntimeException> RUNTIME_EXCEPTION = RuntimeException.class;
45  
46      /**
47       * Super class of any linking exception (aka Linkage Error)
48       */
49      public static final Class<LinkageError> LINKING_EXCEPTION = LinkageError.class;
50      /**
51       * Linking Exceptions
52       */
53      public static final Class<ClassCircularityError> CLASS_CIRCULARITY_ERROR = ClassCircularityError.class;
54      public static final Class<ClassFormatError> CLASS_FORMAT_ERROR = ClassFormatError.class;
55      public static final Class<ExceptionInInitializerError> EXCEPTION_IN_INITIALIZER_ERROR = ExceptionInInitializerError.class;
56      public static final Class<IncompatibleClassChangeError> INCOMPATIBLE_CLASS_CHANGE_ERROR = IncompatibleClassChangeError.class;
57      public static final Class<AbstractMethodError> ABSTRACT_METHOD_ERROR = AbstractMethodError.class;
58      public static final Class<IllegalAccessError> ILLEGAL_ACCESS_ERROR = IllegalAccessError.class;
59      public static final Class<InstantiationError> INSTANTIATION_ERROR = InstantiationError.class;
60      public static final Class<NoSuchFieldError> NO_SUCH_FIELD_ERROR = NoSuchFieldError.class;
61      public static final Class<NoSuchMethodError> NO_SUCH_METHOD_ERROR = NoSuchMethodError.class;
62      public static final Class<NoClassDefFoundError> NO_CLASS_DEF_FOUND_ERROR = NoClassDefFoundError.class;
63      public static final Class<UnsatisfiedLinkError> UNSATISFIED_LINK_ERROR = UnsatisfiedLinkError.class;
64  
65      public static final Class<VerifyError> VERIFY_ERROR = VerifyError.class;
66      /* UnsupportedClassVersionError is new in JDK 1.2 */
67  //    public static final Class UnsupportedClassVersionError = UnsupportedClassVersionError.class;
68      /**
69       * Run-Time Exceptions
70       */
71      public static final Class<NullPointerException> NULL_POINTER_EXCEPTION = NullPointerException.class;
72      public static final Class<ArrayIndexOutOfBoundsException> ARRAY_INDEX_OUT_OF_BOUNDS_EXCEPTION = ArrayIndexOutOfBoundsException.class;
73      public static final Class<ArithmeticException> ARITHMETIC_EXCEPTION = ArithmeticException.class;
74      public static final Class<NegativeArraySizeException> NEGATIVE_ARRAY_SIZE_EXCEPTION = NegativeArraySizeException.class;
75      public static final Class<ClassCastException> CLASS_CAST_EXCEPTION = ClassCastException.class;
76  
77      public static final Class<IllegalMonitorStateException> ILLEGAL_MONITOR_STATE = IllegalMonitorStateException.class;
78      /**
79       * Pre-defined exception arrays according to chapters 5.1-5.4 of the Java Virtual Machine Specification
80       */
81      private static final Class<?>[] EXCS_CLASS_AND_INTERFACE_RESOLUTION = {NO_CLASS_DEF_FOUND_ERROR, CLASS_FORMAT_ERROR, VERIFY_ERROR, ABSTRACT_METHOD_ERROR,
82          EXCEPTION_IN_INITIALIZER_ERROR, ILLEGAL_ACCESS_ERROR}; // Chapter 5.1
83  
84      private static final Class<?>[] EXCS_FIELD_AND_METHOD_RESOLUTION = {NO_SUCH_FIELD_ERROR, ILLEGAL_ACCESS_ERROR, NO_SUCH_METHOD_ERROR}; // Chapter 5.2
85  
86      /**
87       * Empty array.
88       */
89      private static final Class<?>[] EXCS_INTERFACE_METHOD_RESOLUTION = new Class[0]; // Chapter 5.3 (as below)
90  
91      /**
92       * Empty array.
93       */
94      private static final Class<?>[] EXCS_STRING_RESOLUTION = new Class[0];
95  
96      // Chapter 5.4 (no errors but the ones that _always_ could happen! How stupid.)
97      private static final Class<?>[] EXCS_ARRAY_EXCEPTION = {NULL_POINTER_EXCEPTION, ARRAY_INDEX_OUT_OF_BOUNDS_EXCEPTION};
98  
99      /**
100      * Creates a copy of the specified Exception Class array combined with any additional Exception classes.
101      *
102      * @param type the basic array type
103      * @param extraClasses additional classes, if any
104      * @return the merged array
105      */
106     public static Class<?>[] createExceptions(final EXCS type, final Class<?>... extraClasses) {
107         switch (type) {
108         case EXCS_CLASS_AND_INTERFACE_RESOLUTION:
109             return mergeExceptions(EXCS_CLASS_AND_INTERFACE_RESOLUTION, extraClasses);
110         case EXCS_ARRAY_EXCEPTION:
111             return mergeExceptions(EXCS_ARRAY_EXCEPTION, extraClasses);
112         case EXCS_FIELD_AND_METHOD_RESOLUTION:
113             return mergeExceptions(EXCS_FIELD_AND_METHOD_RESOLUTION, extraClasses);
114         case EXCS_INTERFACE_METHOD_RESOLUTION:
115             return mergeExceptions(EXCS_INTERFACE_METHOD_RESOLUTION, extraClasses);
116         case EXCS_STRING_RESOLUTION:
117             return mergeExceptions(EXCS_STRING_RESOLUTION, extraClasses);
118         default:
119             throw new AssertionError("Cannot happen; unexpected enum value: " + type);
120         }
121     }
122 
123     // helper method to merge exception class arrays
124     private static Class<?>[] mergeExceptions(final Class<?>[] input, final Class<?>... extraClasses) {
125         return ArrayUtils.addAll(input, extraClasses);
126     }
127 
128 }