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.api.report;
20  
21  import java.io.File;
22  
23  /**
24   * Bits and pieces of reporting configuration that seem to be necessary on the provider side.
25   * <br>
26   * Todo: Consider moving these fields elsewhere, this concept does not smell too good
27   *
28   * @author Kristian Rosenvold
29   */
30  public class ReporterConfiguration {
31      private final File reportsDirectory;
32      private final boolean trimStackTrace;
33  
34      public ReporterConfiguration(File reportsDirectory, boolean trimStackTrace) {
35          this.reportsDirectory = reportsDirectory;
36          this.trimStackTrace = trimStackTrace;
37      }
38  
39      /**
40       * The directory where reports will be created, normally ${project.build.directory}/surefire-reports
41       *
42       * @return A file pointing at the specified directory
43       */
44      public File getReportsDirectory() {
45          return reportsDirectory;
46      }
47  
48      /**
49       * Indicates if reporting should trim the stack traces.
50       *
51       * @return true if stacktraces should be trimmed in reporting
52       */
53      public boolean isTrimStackTrace() {
54          return trimStackTrace;
55      }
56  }