/*
 * Copyright 2007 - 2018 ETH Zuerich, CISD and SIS.
 *
 * Licensed 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 ch.systemsx.cisd.base.exceptions;

/**
 * A strategy role for dealing with errors.
 * 
 * @author Bernd Rinn
 */
public interface IErrorStrategy
{
    /**
     * The default error strategy, just re-throws the exception.
     */
    public static final IErrorStrategy DEFAULT_ERROR_STRATEGY = new IErrorStrategy()
        {
            @Override
            public void dealWithError(Throwable th) throws RuntimeException, Error
            {
                throw CheckedExceptionTunnel.wrapIfNecessary(th);
            }

            @Override
            public void warning(String message)
            {
                System.err.println(message);
            }
        };

    /**
     * Called when an exception <var>ex</var> has occurred. Can, but doesn't have to, abort the
     * operation by re-throwing the exception.
     * 
     * @throws RuntimeException if the operation should be aborted.
     */
    public void dealWithError(final Throwable th) throws RuntimeException, Error;

    /**
     * Called to issue a warning message.
     */
    public void warning(String message);
}