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.creadur.whisker.app.out;
20  
21  import java.io.BufferedWriter;
22  import java.io.File;
23  import java.io.IOException;
24  import java.io.Writer;
25  
26  import org.apache.commons.io.output.FileWriterWithEncoding;
27  import org.apache.creadur.whisker.app.Result;
28  import org.apache.creadur.whisker.app.ResultWriterFactory;
29  
30  /**
31   * Writes results as files within a directory.
32   */
33  public final class WriteResultsIntoDirectoryFactory
34                         implements ResultWriterFactory  {
35  
36      /** Output directory. */
37      private final File directory;
38      /** Output encoding. */
39      private final String encoding;
40  
41      /**
42       * Constructs a factory that write reports
43       * into the given directory with the given
44       * encoding.
45       * @param directory not null
46       * @param encoding not null
47       */
48      public WriteResultsIntoDirectoryFactory(
49              final File directory, final String encoding) {
50          super();
51          this.directory = directory;
52          this.encoding = encoding;
53      }
54  
55      /**
56       * Creates a suitable write for the given report.
57       * @param result not null
58       * @return not null
59       * @see ResultWriterFactory#writerFor(Result)
60       * @throws IOException when the report cannot be written
61       */
62      public Writer writerFor(final Result result)
63              throws IOException {
64          return new BufferedWriter(
65                  new FileWriterWithEncoding(
66                          result.within(directory), encoding));
67      }
68  }