org.apache.maven.building

Interface Source

All Known Implementing Classes:

FileSource, StringSource, UrlSource

public interface Source

Provides access to the contents of a source independently of the backing store (e.g. file system, database, memory).

Author:

Benjamin Bentmann

Method Summary

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

Method Detail

getInputStream

InputStream getInputStream()
                    throws IOException

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

Returns:

A byte stream to the source contents, never null.

Throws:

IOException

getLocation

String getLocation()

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.

Returns:

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