1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.surefire.api.report;
20
21 /**
22 * Ability to write a stack trace, filtered to omit locations inside Surefire and Maven.
23 *
24 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
25 */
26 public interface StackTraceWriter {
27 /**
28 * Write the throwable to a string, without trimming.
29 *
30 * @return the trace
31 */
32 String writeTraceToString();
33
34 /**
35 * Write the throwable to a string, trimming extra locations.
36 *
37 * @return the trace
38 */
39 String writeTrimmedTraceToString();
40
41 /**
42 * Get the "smart" trimmed (1-2 lines) stacktrace.
43 *
44 * @return the trace
45 */
46 String smartTrimmedStackTrace();
47
48 /**
49 * Retrieve the throwable for this writer.
50 *
51 * @return the throwable
52 */
53 SafeThrowable getThrowable();
54 }