org.apache.maven.settings.building
Interface SettingsSource

All Known Implementing Classes:
FileSettingsSource, StringSettingsSource, UrlSettingsSource

public interface SettingsSource

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

Author:
Benjamin Bentmann

Method Summary
 InputStream getInputStream()
          Gets a byte stream to the settings contents.
 String getLocation()
          Provides a user-friendly hint about the location of the settings.
 

Method Detail

getInputStream

InputStream getInputStream()
                           throws IOException
Gets a byte stream to the settings contents. Closing the returned stream is the responsibility of the caller. Note that each invocation of this method returns a new/fresh stream which represents the entire contents.

Returns:
A byte stream to the settings contents, never null.
Throws:
IOException

getLocation

String getLocation()
Provides a user-friendly hint about the location of the settings. 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 settings, never null.


Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.