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