Package org.apache.maven.model.locator

Interface ModelLocator

All Known Subinterfaces:
ModelProcessor
All Known Implementing Classes:
DefaultModelLocator, DefaultModelProcessor
public interface ModelLocator
Locates a POM file within a project base directory.

  • Method Details

    • locatePom

      @Deprecated File locatePom(File projectDirectory)
      Deprecated.
      Use locatePom(Path) instead.
      Locates the POM file within the specified project directory. In case the given project directory does not exist or does not contain a POM file, the return value indicates the expected path to the POM file. Subdirectories of the project directory will not be considered when locating the POM file. The return value will be an absolute path if the project directory is given as an absolute path.
      Parameters:
      projectDirectory - The (possibly non-existent) base directory to locate the POM file in, must not be null.
      Returns:
      The path to the (possibly non-existent) POM file, never null.

    • locatePom

      Path locatePom(Path projectDirectory)
      Locates the POM file within the specified project directory. In case the given project directory does not exist or does not contain a POM file, the return value indicates the expected path to the POM file. Subdirectories of the project directory will not be considered when locating the POM file. The return value will be an absolute path if the project directory is given as an absolute path.
      Parameters:
      projectDirectory - The (possibly non-existent) base directory to locate the POM file in, must not be null.
      Returns:
      The path to the (possibly non-existent) POM file, never null.
      Since:
      4.0.0

    • locateExistingPom

      @Deprecated default File locateExistingPom(File project)
      Deprecated.
      Use locateExistingPom(Path) instead.
      Returns the file containing the pom or null if a pom can not be found at the given file or in the given directory.

    • locateExistingPom

      Path locateExistingPom(Path project)
      Returns the file containing the pom or null if a pom can not be found at the given file or in the given directory.
      Since:
      4.0.0