/*
* ------------------------------------------------------------------------
*
* 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;
/**
* A helper class that deals with the different log levels and allows to easily write exception messages of
* KNIPExceptions/RuntimeExceptions to the logger.
*
*
* @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 LoggerHelper {
/**
* writes the message of the KNIPException to the specified logger.
*
* @param logger the logger that should output the message
* @param e the exception that should be displayed to the user
*/
public static void log(final NodeLogger logger, final KNIPException e) {
log(e.getMessage(), logger, e.getPreferredLoggerLevel());
}
/**
* writes the message of the KNIPRuntimeException to the specified logger.
*
* @param logger the logger that should output the message
* @param e the exception that should be displayed to the user
*/
public static void log(final NodeLogger logger, final KNIPRuntimeException e) {
log(e.getMessage(), logger, e.getPreferredLoggerLevel());
}
/**
* writes the message of the KNIPException to the specified logger.
*
* @param prefix additional prefix for the message of the exception. E.g. the row key.
* @param logger the logger that should output the message
* @param e the exception that should be displayed to the user
*/
public static void log(final String prefix, final NodeLogger logger, final KNIPException e) {
log(prefix + " : " + e.getMessage(), logger, e.getPreferredLoggerLevel());
}
/**
* writes the message (with the prefix) of the KNIPRuntimeException to the specified logger.
*
* @param prefix additional prefix for the message of the exception. E.g. the row key.
* @param logger the logger that should output the message
* @param e the exception that should be displayed to the user
*/
public static void log(final String prefix, final NodeLogger logger, final KNIPRuntimeException e) {
log(prefix + " : " + e.getMessage(), logger, e.getPreferredLoggerLevel());
}
/**
* writes the message (with the prefix and postfix) of the KNIPRuntimeException to the specified logger.
*
* @param prefix additional prefix for the message of the exception. E.g. the row key.
* @param postfix additional text that should appear after the message e.g. MissingCell has been insterted.
* @param logger the logger that should output the message
* @param e the exception that should be displayed to the user
*/
public static void log(final String prefix, final NodeLogger logger, final KNIPException e, final String postfix) {
log(prefix + " : " + e.getMessage() + " " + postfix, logger, e.getPreferredLoggerLevel());
}
/**
* writes the message (with the prefix and postfix) of the KNIPRuntimeException to the specified logger.
*
* @param prefix additional prefix for the message of the exception. E.g. the row key.
* @param postfix additional text that should appear after the message e.g. MissingCell has been insterted.
* @param logger the logger that should output the message
* @param e the exception that should be displayed to the user
*/
public static void log(final String prefix, final NodeLogger logger, final KNIPRuntimeException e,
final String postfix) {
log(prefix + " : " + e.getMessage() + " " + postfix, logger, e.getPreferredLoggerLevel());
}
/**
* writes the message to the logger using the suggested log level
*
* @param message a error message
* @param logger the logger that should output the message
* @param loggerLevel the suggested log level for the output
*/
public static void log(final String message, final NodeLogger logger, final NodeLogger.LEVEL loggerLevel) {
switch (loggerLevel) {
case DEBUG:
logger.debug(message);
break;
case INFO:
logger.info(message);
break;
case WARN:
logger.warn(message);
break;
case ERROR:
logger.error(message);
break;
case FATAL:
logger.fatal(message);
break;
case ALL:
// is this correct?
logger.debug(message);
logger.info(message);
logger.warn(message);
logger.error(message);
logger.fatal(message);
break;
default:
logger.warn(message);
}
}
private LoggerHelper() {
// static helper class
}
}