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.building;
20  
21  import java.io.File;
22  import java.io.FileInputStream;
23  import java.io.IOException;
24  import java.io.InputStream;
25  import java.util.Objects;
26  
27  /**
28   * Wraps an ordinary {@link File} as a source.
29   *
30   * @author Benjamin Bentmann
31   */
32  public class FileSource implements Source {
33      private final File file;
34  
35      /**
36       * Creates a new source backed by the specified file.
37       *
38       * @param file The file, must not be {@code null}.
39       */
40      public FileSource(File file) {
41          this.file = Objects.requireNonNull(file, "file cannot be null").getAbsoluteFile();
42      }
43  
44      @Override
45      public InputStream getInputStream() throws IOException {
46          return new FileInputStream(file);
47      }
48  
49      @Override
50      public String getLocation() {
51          return file.getPath();
52      }
53  
54      /**
55       * Gets the file of this source.
56       *
57       * @return The underlying file, never {@code null}.
58       */
59      public File getFile() {
60          return file;
61      }
62  
63      @Override
64      public String toString() {
65          return getLocation();
66      }
67  }