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.load;
20  
21  import java.io.BufferedInputStream;
22  import java.io.File;
23  import java.io.FileInputStream;
24  import java.io.IOException;
25  import java.io.InputStream;
26  
27  import org.apache.creadur.whisker.app.StreamableResource;
28  
29  
30  /**
31   * Streams the contents of a file.
32   */
33  public final class StreamableFileResource extends StreamableResource {
34      /** The file to be streamed. */
35      private final File file;
36  
37      /**
38       * Constructs an object that streams the file on demand.
39       * @param file not null
40       */
41      public StreamableFileResource(final File file) {
42          super();
43          this.file = file;
44      }
45  
46      /**
47       * Opens the file as an input stream.
48       * @return not null
49       * @see StreamableResource#open()
50       * @throws IOException when resource cannot be opened
51       */
52      @Override
53      public InputStream open() throws IOException {
54          return new BufferedInputStream(new FileInputStream(file));
55      }
56  
57  
58      /**
59       * A description suitable for diagnostics.
60       * @return something suitable for diagnostics, not null
61       */
62      @Override
63      public String toString() {
64          return "StreamableFileResource [file=" + file + "]";
65      }
66  }