001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 *  Unless required by applicable law or agreed to in writing, software
012 *  distributed under the License is distributed on an "AS IS" BASIS,
013 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 *  See the License for the specific language governing permissions and
015 *  limitations under the License.
016 */
017package org.apache.bcel.verifier.exc;
018
019import java.util.Arrays;
020
021/**
022 * Instances of this class should never be thrown. When such an instance is thrown, this is due to an INTERNAL ERROR of
023 * BCEL's class file verifier "JustIce".
024 */
025public final class AssertionViolatedException extends RuntimeException {
026    private static final long serialVersionUID = -129822266349567409L;
027
028    /**
029     * DO NOT USE. It's for experimental testing during development only.
030     */
031    public static void main(final String[] args) {
032        final AssertionViolatedException ave = new AssertionViolatedException(Arrays.toString(args));
033        ave.extendMessage("\nFOUND:\n\t", "\nExiting!!\n");
034        throw ave;
035    }
036
037    /** The error message. */
038    private String detailMessage;
039
040    /** Constructs a new AssertionViolatedException with null as its error message string. */
041    public AssertionViolatedException() {
042    }
043
044    /**
045     * Constructs a new AssertionViolatedException with the specified error message preceded by "INTERNAL ERROR:
046     * ".
047     */
048    public AssertionViolatedException(String message) {
049        super(message = "INTERNAL ERROR: " + message); // Thanks to Java, the constructor call here must be first.
050        detailMessage = message;
051    }
052
053    /**
054     * Constructs a new AssertionViolationException with the specified error message and initial cause
055     *
056     * @since 6.0
057     */
058    public AssertionViolatedException(String message, final Throwable initCause) {
059        super(message = "INTERNAL ERROR: " + message, initCause);
060        detailMessage = message;
061    }
062
063    /**
064     * Extends the error message with a string before ("pre") and after ("post") the 'old' error message. All of these three
065     * strings are allowed to be null, and null is always replaced by the empty string (""). In particular, after invoking
066     * this method, the error message of this object can no longer be null.
067     */
068    public void extendMessage(String pre, String post) {
069        if (pre == null) {
070            pre = "";
071        }
072        if (detailMessage == null) {
073            detailMessage = "";
074        }
075        if (post == null) {
076            post = "";
077        }
078        detailMessage = pre + detailMessage + post;
079    }
080
081    /**
082     * Returns the error message string of this AssertionViolatedException object.
083     *
084     * @return the error message string of this AssertionViolatedException.
085     */
086    @Override
087    public String getMessage() {
088        return detailMessage;
089    }
090
091}