Package org.apache.maven.model.building

Class FileModelSource

  • All Implemented Interfaces:
    org.apache.maven.building.Source, ModelSource, ModelSource2
    public class FileModelSource
extends org.apache.maven.building.FileSource
implements ModelSource2
    Wraps an ordinary File as a model source.
    Author:
    Benjamin Bentmann

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.net.URI getLocationURI()
      Returns location of the POM, never null.
      java.io.File getPomFile()
      Deprecated.
      instead use FileSource.getFile()
      ModelSource2 getRelatedSource​(java.lang.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.building.Source

        getInputStream, getLocation

    • Constructor Detail

      • FileModelSource

        public FileModelSource​(java.io.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 java.io.File getPomFile()
        Deprecated.
        instead use FileSource.getFile()
        Returns:
        the file of this source

      • getRelatedSource

        public ModelSource2 getRelatedSource​(java.lang.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 java.net.URI getLocationURI()
        Description copied from interface: ModelSource2
        Returns location of the POM, never null.
        Specified by:
        getLocationURI in interface ModelSource2

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object