Package org.apache.maven.model.building

Class FileModelSource

java.lang.Object

org.apache.maven.building.FileSource

org.apache.maven.model.building.FileModelSource

All Implemented Interfaces:

Source, ModelSource, ModelSource2, ModelSource3

public class FileModelSource
extends FileSource
implements ModelSource3

Wraps an ordinary File as a model source.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
URI	getLocationURI()	Returns location of the POM, never null.
File	getPomFile()	Deprecated. instead use FileSource.getFile()
ModelSource3	getRelatedSource(ModelLocator locator, String relPath)	Returns model source identified by a path relative to this model source POM.
int	hashCode()

Methods inherited from class org.apache.maven.building.FileSource

getFile, getInputStream, getLocation, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.maven.model.building.ModelSource3

getRelatedSource

Methods inherited from interface org.apache.maven.building.Source

getInputStream, getLocation

Constructor Details

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 Details

getPomFile

@Deprecated
public File getPomFile()

Deprecated.

instead use FileSource.getFile()

Returns:

the file of this source

getRelatedSource

public ModelSource3 getRelatedSource(ModelLocator locator,
 String relPath)

Description copied from interface: ModelSource3

Returns model source identified by a path relative to this model source POM. Implementation MUST accept relPath parameter values that

• use either / or \ file path separator
• have .. parent directory references
• point either at file or directory

If the given path points at a directory, the provided ModelLocator will be used to find the POM file, else if no locator is provided, a file named 'pom.xml' needs to be used by the requested model source.

Specified by:

getRelatedSource in interface ModelSource3

Parameters:

locator - locator used to locate the pom file

relPath - 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

equals

public boolean equals(Object obj)

Overrides:

equals in class FileSource

hashCode

public int hashCode()

Overrides:

hashCode in class FileSource