1 package org.apache.maven.surefire.api.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 * Minimum data requirement for report entry.
24 * <br>
25 * Additionally, we should distinguish between two events ({@link OutputReportEntry}, {@link TestOutputReportEntry}).
26 * The interface {@link TestReportListener} handles these two events via generics depending on the situation.
27 * <br>
28 * The first situation happens when provider's listeners handles the event {@link OutputReportEntry} from
29 * <i>System.out</i> and <i>System.err</i> via the {@link ConsoleOutputCapture}. The {@link ConsoleOutputCapture} does
30 * not have any notion about {@link RunMode} and <code>testRunId</code>, and therefore the only provider's listener
31 * would add {@link RunMode} and <code>testRunId</code> to a recreated entry which would be finally propagated to the
32 * <code>ForkingRunListener</code> and <code>TestSetRunListener</code>. The {@link RunMode} and <code>testRunId</code>
33 * are determined upon the events test-started, test-finished and Thread local.
34 * <br>
35 * The second situation happens when <code>ForkingRunListener</code> and <code>TestSetRunListener</code> handles
36 * {@link TestOutputReportEntry} which contains {@link RunMode} and <code>testRunId</code>.
37 */
38 public interface OutputReportEntry
39 {
40 String getLog();
41
42 boolean isStdOut();
43
44 boolean isNewLine();
45 }