View Javadoc
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.extensions;
20  
21  import java.io.File;
22  import java.io.PrintStream;
23  
24  import static org.apache.maven.surefire.shared.utils.StringUtils.isBlank;
25  
26  /**
27   * Extension for logger.
28   * The signature can be changed between major, minor versions or milestones.
29   *
30   * @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
31   * @since 3.0.0-M4
32   */
33  public abstract class ConsoleOutputReporter {
34      /**
35       * {@code false} by default
36       */
37      private boolean disable;
38  
39      /**
40       * The content is encoded <em>UTF-8</em> by default.
41       */
42      private String encoding;
43  
44      public abstract ConsoleOutputReportEventListener createListener(
45              File reportsDirectory, String reportNameSuffix, Integer forkNumber);
46  
47      public abstract ConsoleOutputReportEventListener createListener(PrintStream out, PrintStream err);
48  
49      public abstract Object clone(ClassLoader target);
50  
51      public boolean isDisable() {
52          return disable;
53      }
54  
55      public void setDisable(boolean disable) {
56          this.disable = disable;
57      }
58  
59      public String getEncoding() {
60          return isBlank(encoding) ? "UTF-8" : encoding;
61      }
62  
63      public void setEncoding(String encoding) {
64          this.encoding = encoding;
65      }
66  }