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.IOException;
23 import java.io.InputStream;
24 import java.nio.file.Files;
25 import java.util.Objects;
26
27 /**
28 * Wraps an ordinary {@link File} as a source.
29 *
30 */
31 public class FileSource implements Source {
32 private final File file;
33
34 private final int hashCode;
35
36 /**
37 * Creates a new source backed by the specified file.
38 *
39 * @param file The file, must not be {@code null}.
40 */
41 public FileSource(File file) {
42 this.file = Objects.requireNonNull(file, "file cannot be null").getAbsoluteFile();
43 this.hashCode = Objects.hash(file);
44 }
45
46 @Override
47 public InputStream getInputStream() throws IOException {
48 return Files.newInputStream(file.toPath());
49 }
50
51 @Override
52 public String getLocation() {
53 return file.getPath();
54 }
55
56 /**
57 * Gets the file of this source.
58 *
59 * @return The underlying file, never {@code null}.
60 */
61 public File getFile() {
62 return file;
63 }
64
65 @Override
66 public String toString() {
67 return getLocation();
68 }
69
70 @Override
71 public int hashCode() {
72 return hashCode;
73 }
74
75 @Override
76 public boolean equals(Object obj) {
77 if (this == obj) {
78 return true;
79 }
80
81 if (obj == null) {
82 return false;
83 }
84
85 if (!FileSource.class.equals(obj.getClass())) {
86 return false;
87 }
88
89 FileSource other = (FileSource) obj;
90 return this.file.equals(other.file);
91 }
92 }