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