org.apache.mina.util.ExceptionMonitor Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.apache.mina.util;
/**
* Monitors uncaught exceptions. {@link #exceptionCaught(Throwable)} is
* invoked when there are any uncaught exceptions.
*
* You can monitor any uncaught exceptions by setting {@link ExceptionMonitor}
* by calling {@link #setInstance(ExceptionMonitor)}. The default
* monitor logs all caught exceptions in WARN level using
* SLF4J.
*
* @author Apache MINA Project
*
* @see DefaultExceptionMonitor
*/
public abstract class ExceptionMonitor {
private static ExceptionMonitor instance = new DefaultExceptionMonitor();
/**
* @return the current exception monitor.
*/
public static ExceptionMonitor getInstance() {
return instance;
}
/**
* Sets the uncaught exception monitor. If null is specified,
* the default monitor will be set.
*
* @param monitor A new instance of {@link DefaultExceptionMonitor} is set
* if null is specified.
*/
public static void setInstance(ExceptionMonitor monitor) {
if (monitor == null) {
instance = new DefaultExceptionMonitor();
} else {
instance = monitor;
}
}
/**
* Invoked when there are any uncaught exceptions.
*
* @param cause The caught exception
*/
public abstract void exceptionCaught(Throwable cause);
}