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 public interface ReportEntry
23 {
24 /**
25 * The class name of the test
26 *
27 * @return A string with the class name
28 */
29 public String getSourceName();
30
31 /**
32 * The name of the test case
33 *
34 * @return A string describing the test case
35 */
36 public String getName();
37
38 /**
39 * The group/category of the testcase
40 *
41 * @return A string
42 */
43 public String getGroup();
44
45 /**
46 * The group/category of the testcase
47 *
48 * @return A string
49 */
50 public StackTraceWriter getStackTraceWriter();
51
52 /**
53 * Gets the runtime for the item. Optional parameter. If the value is not set, it will be determined within
54 * the reporting subsustem. Some providers like to calculate this value themselves, and it gets the
55 * most accurate value.
56 */
57 public Integer getElapsed();
58
59
60 /**
61 * A message relating to a non-successful termination.
62 * May be the "message" from an exception or the reason for a test being ignored
63 *
64 * @return A string that explains an anomaly
65 */
66 public String getMessage();
67
68 /**
69 * A name of the test case together with the group or category (if any exists).
70 *
71 * @return A string with the test case name and group/category, or just the name.
72 */
73 public String getNameWithGroup();
74 }