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 private final int hashCode;
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 this.file = Objects.requireNonNull(file, "file cannot be null").getAbsoluteFile();
44 this.hashCode = Objects.hash(file);
45 }
46
47 @Override
48 public InputStream getInputStream() throws IOException {
49 return new FileInputStream(file);
50 }
51
52 @Override
53 public String getLocation() {
54 return file.getPath();
55 }
56
57 /**
58 * Gets the file of this source.
59 *
60 * @return The underlying file, never {@code null}.
61 */
62 public File getFile() {
63 return file;
64 }
65
66 @Override
67 public String toString() {
68 return getLocation();
69 }
70
71 @Override
72 public int hashCode() {
73 return hashCode;
74 }
75
76 @Override
77 public boolean equals(Object obj) {
78 if (this == obj) {
79 return true;
80 }
81
82 if (obj == null) {
83 return false;
84 }
85
86 if (!FileSource.class.equals(obj.getClass())) {
87 return false;
88 }
89
90 FileSource other = (FileSource) obj;
91 return this.file.equals(other.file);
92 }
93 }