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