Package org.apache.maven.building
Class FileSource
java.lang.Object
org.apache.maven.building.FileSource
- All Implemented Interfaces:
Source
Wraps an ordinary
File
as a source.-
Constructor Summary
ConstructorDescriptionFileSource
(File file) Deprecated.FileSource
(Path path) Creates a new source backed by the specified file. -
Method Summary
-
Constructor Details
-
FileSource
Deprecated.UseFileSource(Path)
instead.Creates a new source backed by the specified file.- Parameters:
file
- The file, must not benull
.
-
FileSource
Creates a new source backed by the specified file.- Parameters:
path
- The file, must not benull
.- Since:
- 4.0.0
-
-
Method Details
-
getInputStream
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 interfaceSource
- Returns:
- A byte stream to the source contents, never
null
. - Throws:
IOException
- in case of IO issue
-
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 interfaceSource
- Returns:
- A user-friendly hint about the location of the source, never
null
.
-
getFile
Deprecated.UsegetPath()
instead.Gets the file of this source.- Returns:
- The underlying file, never
null
.
-
getPath
Gets the file of this source.- Returns:
- The underlying file, never
null
. - Since:
- 4.0.0
-
toString
-
hashCode
public int hashCode() -
equals
-
FileSource(Path)
instead.