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