Package org.apache.maven.building

Class UrlSource

java.lang.Object

org.apache.maven.building.UrlSource

All Implemented Interfaces:

Source

Direct Known Subclasses:

UrlModelSource, UrlSettingsSource

public class UrlSource
extends Object
implements Source

Wraps an ordinary URL as a source.

Author:

Benjamin Bentmann

Constructor Summary

Constructors

Constructor	Description
UrlSource(URL url)	Creates a new source backed by the specified URL.

Method Summary

Modifier and Type	Method	Description
InputStream	getInputStream()	Gets a byte stream to the source contents.
String	getLocation()	Provides a user-friendly hint about the location of the source.
URL	getUrl()	Gets the URL of this source.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UrlSource

public UrlSource(URL url)

Creates a new source backed by the specified URL.

Parameters:

url - The file, must not be null.

Method Details

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: Source

Gets a byte stream to the source contents. Closing the returned stream is the responsibility of the caller.

Specified by:

getInputStream in interface Source

Returns:

A byte stream to the source contents, never null.

Throws:

IOException

getLocation

public String getLocation()

Description copied from interface: Source

Provides a user-friendly hint about the location of the source. This could be a local file path, a URI or just an empty string. The intention is to assist users during error reporting.

Specified by:

getLocation in interface Source

Returns:

A user-friendly hint about the location of the source, never null.

getUrl

public URL getUrl()

Gets the URL of this source.

Returns:

The underlying URL, never null.

toString

public String toString()

Overrides:

toString in class Object