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