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

Interface ModelResolver

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultModelResolver

public interface ModelResolver
extends Service

Resolves a POM from its coordinates.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ModelResolver.ModelResolverRequest
static final record	ModelResolver.ModelResolverResult

Method Summary

Modifier and Type	Method	Description
ModelResolver.ModelResolverResult	resolveModel(ModelResolver.ModelResolverRequest request)
ModelSource	resolveModel(Session session, List<RemoteRepository> repositories, Dependency dependency, AtomicReference<Dependency> modified)	Tries to resolve the POM for the specified dependency coordinates possibly updating dependency.
ModelSource	resolveModel(Session session, List<RemoteRepository> repositories, Parent parent, AtomicReference<Parent> modified)	Tries to resolve the POM for the specified parent coordinates possibly updating parent.

Method Details

resolveModel

@Nonnull
ModelSource resolveModel(@Nonnull
 Session session,
 @Nullable
 List<RemoteRepository> repositories,
 @Nonnull
 Parent parent,
 @Nonnull
 AtomicReference<Parent> modified)
                  throws ModelResolverException

Tries to resolve the POM for the specified parent coordinates possibly updating parent.

Parameters:

session - The session to use to resolve the model, must not be null.

repositories - The repositories to use to resolve the model, may be null in which case the Session repositories will be used.

parent - The parent coordinates to resolve, must not be null.

modified - a holder for the updated parent, must not be null.

Returns:

The source of the requested POM, never null.

Throws:

ModelResolverException - If the POM could not be resolved from any configured repository.

resolveModel

@Nonnull
ModelSource resolveModel(@Nonnull
 Session session,
 @Nullable
 List<RemoteRepository> repositories,
 @Nonnull
 Dependency dependency,
 @Nonnull
 AtomicReference<Dependency> modified)
                  throws ModelResolverException

Tries to resolve the POM for the specified dependency coordinates possibly updating dependency.

Parameters:

session - The session to use to resolve the model, must not be null.

repositories - The repositories to use to resolve the model, may be null in which case the Session repositories will be used.

dependency - The dependency coordinates to resolve, must not be null.

modified - a holder for the updated dependency, must not be null.

Returns:

The source of the requested POM, never null.

Throws:

ModelResolverException - If the POM could not be resolved from any configured repository.

resolveModel

@Nonnull
ModelResolver.ModelResolverResult resolveModel(@Nonnull
 ModelResolver.ModelResolverRequest request)
                                        throws ModelResolverException

Throws:

ModelResolverException