/*
 * ------------------------------------------------------------------------
 *
 *  Copyright (C) 2003 - 2013
 *  University of Konstanz, Germany and
 *  KNIME GmbH, Konstanz, Germany
 *  Website: http://www.knime.org; Email: contact@knime.org
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME GMBH herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * --------------------------------------------------------------------- *
 *
 */
package org.knime.knip.base.exceptions;

import org.knime.core.node.NodeLogger;
import org.knime.core.node.NodeLogger.LEVEL;
import org.knime.knip.base.node.ValueToCellNodeModel;

/**
 * A KNIP runtime exception may be captured by classes of the KNIME Image Extension Plugin and be dealt of by issuing a
 * logger message and using an appropriate default behavior instead of throwing the exception. See e.g. the
 * {@link ValueToCellNodeModel} that inserts a missing cell if a compute operations fails (with a KNIP exception).
 * 
 * 
 * @author <a href="mailto:dietzc85@googlemail.com">Christian Dietz</a>
 * @author <a href="mailto:horn_martin@gmx.de">Martin Horn</a>
 * @author <a href="mailto:michael.zinsmaier@googlemail.com">Michael Zinsmaier</a>
 */
public class KNIPRuntimeException extends RuntimeException {

    /** a generated serial id. */
    private static final long serialVersionUID = 9185600871949248540L;

    /** the preferred logger level for the exception message. */
    private final LEVEL m_preferredLoggerLevel;

    /**
     * @param message the exception message (this message gets printed to the logger if the exception is captured)
     */
    public KNIPRuntimeException(final String message) {
        super(message);
        m_preferredLoggerLevel = NodeLogger.LEVEL.WARN;
    }

    /**
     * @param message the exception message (this message gets printed to the logger if the exception is captured)
     * @param preferredLevel preferred logger level for the exception message (if the exception is captured and handled)
     */
    public KNIPRuntimeException(final String message, final NodeLogger.LEVEL preferredLevel) {
        super(message);
        m_preferredLoggerLevel = preferredLevel;
    }

    /**
     * @param message the exception message (this message gets printed to the logger if the exception is captured)
     * @param cause underlying reason for the exception (e.g. other exception)
     */
    public KNIPRuntimeException(final String message, final Throwable cause) {
        super(message, cause);
        m_preferredLoggerLevel = NodeLogger.LEVEL.WARN;
    }

    /**
     * @param message the exception message (this message gets printed to the logger if the exception is captured)
     * @param preferredLevel preferred logger level for the exception message (if the exception is captured and handled)
     * @param cause underlying reason for the exception (e.g. other exception)
     */
    public KNIPRuntimeException(final String message, final Throwable cause, final NodeLogger.LEVEL preferredLevel) {
        super(message, cause);
        m_preferredLoggerLevel = preferredLevel;
    }

    /**
     * @return the suggested logger level for the exception message
     */
    public LEVEL getPreferredLoggerLevel() {
        return m_preferredLoggerLevel;
    }

}