org.apache.maven.api.services

Interface ProjectBuilder

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultProjectBuilder

@Experimental
public interface ProjectBuilder
extends Service

Since:

4.0

Method Summary

Modifier and Type	Method and Description
ProjectBuilderResult	build(ProjectBuilderRequest request) Creates a Project from a POM file.
default ProjectBuilderResult	build(Session session, Artifact artifact) Creates a Project from an artifact.
default ProjectBuilderResult	build(Session session, ArtifactCoordinate coordinate) Creates a Project from a coordinate.
default ProjectBuilderResult	build(Session session, Path path) Creates a Project from a POM file.
default ProjectBuilderResult	build(Session session, ProjectBuilderSource source) Creates a Project from a POM file.

Method Detail

build

@Nonnull
ProjectBuilderResult build(ProjectBuilderRequest request)

Creates a Project from a POM file.

Parameters:

request - ProjectBuilderRequest

Returns:

the ProjectBuilderResult containing the built project and possible errors

Throws:

ProjectBuilderException - if the project cannot be created

IllegalArgumentException - if an argument is null or invalid

build

@Nonnull
default ProjectBuilderResult build(@Nonnull
                                            Session session,
                                            @Nonnull
                                            ProjectBuilderSource source)

Creates a Project from a POM file.

Parameters:

session - The Session, must not be null.

source - The ProjectBuilderSource, must not be null.

Throws:

ProjectBuilderException - if the project cannot be created

IllegalArgumentException - if an argument is null or invalid

See Also:

build(ProjectBuilderRequest)

build

@Nonnull
default ProjectBuilderResult build(@Nonnull
                                            Session session,
                                            @Nonnull
                                            Path path)

Creates a Project from a POM file.

Parameters:

session - The Session, must not be null.

path - The Path, must not be null.

Throws:

ProjectBuilderException - if the project cannot be created

IllegalArgumentException - if an argument is null or invalid

See Also:

build(ProjectBuilderRequest)

build

@Nonnull
default ProjectBuilderResult build(@Nonnull
                                            Session session,
                                            @Nonnull
                                            Artifact artifact)

Creates a Project from an artifact.

Parameters:

session - The Session, must not be null.

artifact - The Artifact, must not be null.

Throws:

ProjectBuilderException - if the project cannot be created

IllegalArgumentException - if an argument is null or invalid

See Also:

build(ProjectBuilderRequest)

build

@Nonnull
default ProjectBuilderResult build(@Nonnull
                                            Session session,
                                            @Nonnull
                                            ArtifactCoordinate coordinate)

Creates a Project from a coordinate.

Parameters:

session - The Session, must not be null.

coordinate - The ArtifactCoordinate, must not be null.

Throws:

ProjectBuilderException - if the project cannot be created

IllegalArgumentException - if an argument is null or invalid

See Also:

build(ProjectBuilderRequest)