ExceptionPurger.java

/**
 * Copyright (C) 2015 Valkyrie RCP
 *
 * 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 org.valkyriercp.application.exceptionhandling;

/**
 * Purges a throwable, ussually by looking into it's chain.
 * Usefull for unwrapping WrapEverythingException etc.
 *
 * @see DefaultExceptionPurger
 */
public interface ExceptionPurger {

    /**
     * Purges the throwable to unwrap it to find the most suitable throwable to evaluate or handle.
     *
     * @param e the root exception or error
     * @return e or a chained Throwable which is part of e's chain
     */
    Throwable purge(Throwable e);

}