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