001// Licensed under the Apache License, Version 2.0 (the "License");
002// you may not use this file except in compliance with the License.
003// You may obtain a copy of the License at
004//
005//     http://www.apache.org/licenses/LICENSE-2.0
006//
007// Unless required by applicable law or agreed to in writing, software
008// distributed under the License is distributed on an "AS IS" BASIS,
009// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
010// See the License for the specific language governing permissions and
011// limitations under the License.
012
013package org.apache.tapestry5.services;
014
015import org.apache.tapestry5.ioc.services.ExceptionAnalysis;
016
017import java.io.PrintWriter;
018
019/**
020 * Used by the default {@link org.apache.tapestry5.services.ExceptionReporter} implementation to convert an exception into
021 * a stream of text that can be stored to a file. Other applications include sending the text via e-mail or other messaging
022 * service.
023 *
024 * @since 5.4
025 */
026public interface ExceptionReportWriter
027{
028    /**
029     * Analyzes the exception (using the {@link org.apache.tapestry5.ioc.services.ExceptionAnalyzer} service)
030     * and then writes the result to the writer.
031     * @param writer the PrintWriter to write to, not null
032     * @param exception the exception to look at, possibly null
033     */
034    void writeReport(PrintWriter writer, Throwable exception);
035
036    /**
037     * Writes the analyzed exception to the writer.
038     * @param writer the PrintWriter to write to, not null
039     * @param exception the exception to look at, possibly null
040     */
041    void writeReport(PrintWriter writer, ExceptionAnalysis exception);
042}