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