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