FileModelSource (Apache Maven 3.6.0 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

All Implemented Interfaces:

Source, ModelSource, ModelSource2
```
public class FileModelSource
extends FileSource
implements ModelSource2
```
Wraps an ordinary File as a model source.

Author:

Benjamin Bentmann

Constructor Summary

Constructors
Constructor and Description

FileModelSource(File pomFile)
Creates a new model source backed by the specified file.

Method Summary

Methods
Modifier and Type	Method and Description
`URI`	`getLocationURI()` Returns location of the POM, never `null`.
`File`	`getPomFile()` Deprecated. instead use `FileSource.getFile()`
`ModelSource2`	`getRelatedSource(String relPath)` Returns model source identified by a path relative to this model source POM.

Methods inherited from class org.apache.maven.building.FileSource
getFile, getInputStream, getLocation, toString

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

Methods inherited from interface org.apache.maven.building.Source
getInputStream, getLocation

- Constructor Detail
  - FileModelSource
```
public FileModelSource(File pomFile)
```
    Creates a new model source backed by the specified file.
    
    Parameters:
    pomFile - The POM file, must not be null.
- Method Detail
  - getPomFile
```
@Deprecated
public File getPomFile()
```
    Deprecated. instead use FileSource.getFile()
    
    Returns:
    the file of this source
  - getRelatedSource
```
public ModelSource2 getRelatedSource(String relPath)
```
    Description copied from interface: ModelSource2
    Returns model source identified by a path relative to this model source POM. Implementation MUST be able to accept relPath parameter values that
    - use either / or \ file path separator
    - have .. parent directory references
    - point either at file or directory, in the latter case POM file name 'pom.xml' needs to be used by the requested model source.
    Specified by:
    
    getRelatedSource in interface ModelSource2
    
    Parameters:
    relPath - is the path of the requested model source relative to this model source POM.
    
    Returns:
    related model source or null if no such model source.
  - getLocationURI
```
public URI getLocationURI()
```
    Description copied from interface: ModelSource2
    
    Returns location of the POM, never null.
    
    Specified by:
    
    getLocationURI in interface ModelSource2

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2001–2018 The Apache Software Foundation. All rights reserved.