001/*
002 * Logback: the reliable, generic, fast and flexible logging framework.
003 * Copyright (C) 1999-2026, QOS.ch. All rights reserved.
004 *
005 * This program and the accompanying materials are dual-licensed under
006 * either the terms of the Eclipse Public License v2.0 as published by
007 * the Eclipse Foundation
008 *
009 *   or (per the licensee's choosing)
010 *
011 * under the terms of the GNU Lesser General Public License version 2.1
012 * as published by the Free Software Foundation.
013 */
014package ch.qos.logback.classic.spi;
015
016public interface IThrowableProxy {
017
018    /**
019     * Return the overriding message if any. This method returns null
020     * if there is no overriding message.
021     *
022     * <p>Overriding message exists only if the original throwable implementation overrides the toString() method.</p>
023     *
024     * @return the overriding message or null
025     * @since 1.5.22
026     */
027    default String getOverridingMessage() {
028        return null;
029    }
030
031    String getMessage();
032
033    String getClassName();
034
035    StackTraceElementProxy[] getStackTraceElementProxyArray();
036
037    int getCommonFrames();
038
039    IThrowableProxy getCause();
040
041    IThrowableProxy[] getSuppressed();
042
043    /**
044     * Is this instance the result of a cyclic exception?
045     *
046     * @return true if cyclic, false otherwise
047     * @since 1.3.0
048     */
049    boolean isCyclic();
050}