org.apache.maven.building

Class FileSource

java.lang.Object

org.apache.maven.building.FileSource

All Implemented Interfaces:

Source

Direct Known Subclasses:

FileModelSource, FileSettingsSource

public class FileSource
extends java.lang.Object
implements Source

Wraps an ordinary File as a source.

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	file

Constructor Summary

Constructors

Constructor and Description
FileSource(java.io.File file) Creates a new source backed by the specified file.

Method Summary

Modifier and Type	Method and Description
java.io.File	getFile() Gets the file of this source.
java.io.InputStream	getInputStream() Gets a byte stream to the source contents.
java.lang.String	getLocation() Provides a user-friendly hint about the location of the source.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

file

private final java.io.File file

Constructor Detail

FileSource

public FileSource(java.io.File file)

Creates a new source backed by the specified file.

Parameters:

file - The file, must not be null.

Method Detail

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.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:

java.io.IOException

getLocation

public java.lang.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.

getFile

public java.io.File getFile()

Gets the file of this source.

Returns:

The underlying file, never null.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object