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