FileSource (Apache Maven 3.9.7-SNAPSHOT API)

java.lang.Object
- org.apache.maven.building.FileSource

All Implemented Interfaces:

Source

Direct Known Subclasses:

FileModelSource, FileSettingsSource
```
public class FileSource
extends Object
implements Source
```
Wraps an ordinary File as a source.

Author:

Benjamin Bentmann

Constructor Summary

Constructors
Constructor Description

FileSource(File file)
Creates a new source backed by the specified file.

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FileSource
```
public FileSource(File file)
```
    Creates a new source backed by the specified file.
    
    Parameters:
    
    file - The file, must not be null.
- Method Detail
  - 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.
  - getFile
```
public File getFile()
```
    Gets the file of this source.
    
    Returns:
    
    The underlying file, never null.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object