/*
 * Copyright (c) 2007 BUSINESS OBJECTS SOFTWARE LIMITED
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 * 
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 * 
 *     * Neither the name of Business Objects nor the names of its contributors
 *       may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


/*
 * GemCompilationException.java
 * Created: Aug 5, 2004
 * By: David Mosimann
 */
package org.openquark.cal.services;

import org.openquark.cal.compiler.CompilerMessageLogger;


/**
 * An exception used to indicate that a compilation error occurred when compiling the CAL code
 * resulting from a gem graph.
 */
public final class GemCompilationException extends Exception {
        
    private static final long serialVersionUID = 7760525430707338539L;
    
    /**
     * The logger containing the compilation errors.
     * May be null if the exception occurred before or above the compiler.
     */
    private final CompilerMessageLogger compilerMessageLogger;
    
    /**
     * Constructor for GemCompilationException
     * @param message
     */
    public GemCompilationException(String message) {
        this(message, null);
    }
    
    /**
     * Constructor for GemCompilationException
     * @param message
     */
    public GemCompilationException(String message, CompilerMessageLogger logger) {
        super(message);
        this.compilerMessageLogger = logger;
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    public String getMessage() {
        String result = super.getMessage();
        
        // If a logger is provided, append the first compilation error
        if (compilerMessageLogger != null) {
            result += compilerMessageLogger.getFirstError();
        }
        
        return result;
    }
}