Package org.apache.maven.api.services.model

Interface RootLocator

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultRootLocator

public interface RootLocator
extends Service

Interface used to locate the root directory for a given project. The root locator is usually looked up from the DI container. One notable exception is the computation of the early session.rootDirectory property which happens very early. The implementation used in this case will be discovered using the JDK service mechanism. The default implementation will look for a .mvn child directory or a pom.xml containing the root="true" attribute.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	UNABLE_TO_FIND_ROOT_PROJECT_MESSAGE

Method Summary

Modifier and Type	Method	Description
Path	findMandatoryRoot(Path basedir)
Path	findRoot(Path basedir)
default String	getNoRootMessage()

Field Details

UNABLE_TO_FIND_ROOT_PROJECT_MESSAGE

static final String UNABLE_TO_FIND_ROOT_PROJECT_MESSAGE

See Also:

• Constant Field Values

Method Details

findRoot

@Nullable
Path findRoot(@Nonnull
 Path basedir)

findMandatoryRoot

@Nonnull
Path findMandatoryRoot(@Nonnull
 Path basedir)

getNoRootMessage

@Nonnull
default String getNoRootMessage()