appserver/common/annotation-framework/src/main/java/org/glassfish/apf/AnnotationProcessorException.java

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.apf;

import com.sun.enterprise.util.LocalStringManagerImpl;

/**
 * Exception that denotes a warning or error condition in the
 * annotation procesing tool
 *
 * @author Jerome Dochez
 */
public class AnnotationProcessorException extends Exception {

    final private String message;

    transient final private AnnotationInfo locator; // TODO if this class is meant for serialization, make sure all its constituents are serializable.

    boolean isFatal = false;

    final private static LocalStringManagerImpl localStrings = new LocalStringManagerImpl(AnnotationProcessorException.class);


    /**
     * Creats a new annotation exception
     * @param message describing the exception cause
     */
    public AnnotationProcessorException(String message) {
        this.message = message;
        this.locator = null;
    }

    /**
     * Creates a new annotation exception
     * @param message describing the exception cause
     * @param locator gives information about the annotation and
     * the annotated element which caused the exception
     */
    public AnnotationProcessorException(String message, AnnotationInfo locator) {
        this.message = message;
        this.locator = locator;
    }

    /**
     * Return a meaningful string explaining the exception cause
     * @return the exception reason
     */
    public String getMessage() {
        return message;
    }

    /**
     * Return information about the annotation and annotated element
     * which caused the exception or null if it is not available.
     * @return the annotation info instance
     */
    public AnnotationInfo getLocator() {
        return locator;
    }

    /**
     * @return a meaningful description
     */
    public String toString() {
        if (locator == null) {
            return message;
        } else {
            return localStrings.getLocalString("annotationprocessorexception.with.locator", "{0}. Related annotation information: {1}", message, locator);
        }
    }

    /**
     *
     * @return true if this exception was considered by the sender as being
     * fatal to the annotations processing(i.e. it should stop).
     */
    public boolean isFatal(){
        return isFatal;
    }

    /**
     * Sets wether is exception is considered as fatal to the annotation
     * processing.
     * @param true if the annotation processing should stop
     */
     public void setFatal(boolean fatal){
         this.isFatal = fatal;
     }
}