org.csstudio.diirt.util.core.preferences.ExceptionUtilities.java Source code

Introduction

Here is the source code for org.csstudio.diirt.util.core.preferences.ExceptionUtilities.java

Source

/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * Copyright (C) 2016 European Spallation Source ERIC.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.csstudio.diirt.util.core.preferences;

import java.io.IOException;
import java.util.List;

import org.apache.commons.lang3.exception.ExceptionUtils;

/**
 * Utility methods to handle exceptions.
 *
 * @author claudiorosati, European Spallation Source ERIC
 * @version 1.0.0 21 Dec 2016
 */
public class ExceptionUtilities {

    /**
     * Return a reduced version of the stack frame string, containing the given
     * {@code pattern} string.
     *
     * @param ex The exception.
     * @param pattern The string to be matched.
     * @return The reduced version of the stack frame string, containing the
     *         given {@code pattern} string, or the full stack trace if the
     *         {@code pattern} string is not found or {@code null}.
     *         {@code null} is returned if the given exception is {@code null}.
     */
    public static String reducedStackTrace(Throwable ex, String pattern) {

        if (ex == null) {
            return null;
        } else if (pattern == null) {
            pattern = "";
        }

        StringBuilder builder = new StringBuilder();
        String[] stackFrames = ExceptionUtils.getStackFrames(ex);

        builder.append(stackFrames[0]);

        boolean patternFound = false;

        for (int i = 1; i < stackFrames.length; i++) {

            String frame = stackFrames[i];

            builder.append("\n").append(frame);

            boolean found = frame.contains(pattern);

            if (!patternFound || found) {
                if (found) {
                    patternFound = true;
                }
            } else if (patternFound && !found && i < stackFrames.length - 1) {
                builder.append("\n\t...");
                break;
            }

        }

        builder.append('\n');

        return builder.toString();

    }

    private ExceptionUtilities() {
    }

    public static class CompoundIOException extends IOException {

        private static final long serialVersionUID = 728916648848944404L;

        private final List<Exception> causes;

        public CompoundIOException(String message, final List<Exception> causes) {

            super(message);

            this.causes = causes;

        }

        public List<Exception> getCauses() {
            return causes;
        }

    }

}