Class PomFileGenerator

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.core.AbstractGenerator

org.jdrupes.builder.mvnrepo.PomFileGenerator

All Implemented Interfaces:

Generator, Renamable, ResourceProvider

public class PomFileGenerator
extends AbstractGenerator

A Generator (mainly) for POM files. In response to requests for PomFile this generator produces a Maven Model containing basic project information. The following properties are used:

• The groupId is set to the value of the property MvnProperties.GroupId if it is defined.

• The artifactId is set to the property MvnProperties.ArtifactId, or to the name of the project if MvnProperties.ArtifactId is not defined.

• The version is set to the value of the property Project.Properties.Version.

Dependencies in the model are evaluated by querying the project's providers.

Compile dependencies are evaluated as follows:

• Resources of type MvnRepoDependency are obtained from providers associated via Supply and Expose that are not projects. These resources are Maven repository dependencies declared by the project itself.

• Projects associated via Supply and Expose dependencies are then queried for resources of type MvnRepoDependency using their Supply dependencies. This yields the Maven repository coordinates of projects required for compilation.

Runtime dependencies are evaluated as follows:

• Resources of type MvnRepoDependency are obtained from providers associated via Reveal that are not projects. These resources represent Maven repository dependencies declared by the project itself.

• Projects associated via Reveal dependencies are then queried for resources of type MvnRepoDependency using their Supply dependencies. This yields the Maven repository coordinates of projects required at runtime.

The resulting model is passed to adaptPom(Consumer) for project specific customization before it is written to the POM file.

In addition to handling PomFile requests, this generator also responds to requests for MvnRepoDependencies. In this case, it returns Maven coordinates derived from the properties MvnProperties.GroupId, MvnProperties.ArtifactId and Project.Properties.Version (see above). This reflects the assumption that a project with a POM file is intended to be released as a Maven artifact. Other projects in a multi-project build will therefore ultimately depend on the Maven artifact to be released.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GENERATED_BY	The Constant GENERATED_BY.

Constructor Summary

Constructors

Constructor	Description
PomFileGenerator(Project project)	Instantiates a new library generator.

Method Summary

Modifier and Type	Method	Description
PomFileGenerator	adaptPom(Consumer<Model> adaptor)	Allow derived classes to post process the generated POM.
Path	destination()	Returns the destination directory.
PomFileGenerator	destination(Path destination)	Sets the destination directory.
PomFileGenerator	destination(Supplier<Path> destination)	Sets the destination directory.
protected <T extends Resource> Stream<T>	doProvide(ResourceRequest<T> requested)	Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.

Methods inherited from class AbstractGenerator

cleanup, name, newResource, project, toString

Methods inherited from class AbstractProvider

context, name, of, rename, vavrStream

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ResourceProvider

context, name, of, of, resources

Field Details

GENERATED_BY

public static final String GENERATED_BY

The Constant GENERATED_BY.

See Also:

• Constant Field Values

Constructor Details

PomFileGenerator

public PomFileGenerator(Project project)

Instantiates a new library generator.

Parameters:

project - the project

Method Details

destination

public Path destination()

Returns the destination directory. Defaults to sub directory publications/maven in the project's build directory (see Project.buildDirectory()).

Returns:

the destination

destination

public PomFileGenerator destination(Path destination)

Sets the destination directory. The Path is resolved against the project's build directory (see Project.buildDirectory()).

Parameters:

destination - the new destination

Returns:

the jar generator

destination

public PomFileGenerator destination(Supplier<Path> destination)

Sets the destination directory.

Parameters:

destination - the new destination

Returns:

the jar generator

doProvide

protected <T extends Resource> Stream<T> doProvide(ResourceRequest<T> requested)

Description copied from class: AbstractProvider

Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.

Specified by:

doProvide in class AbstractProvider

Type Parameters:

T - the generic type

Parameters:

requested - the requested

Returns:

the stream

adaptPom

public PomFileGenerator adaptPom(Consumer<Model> adaptor)

Allow derived classes to post process the generated POM.

Parameters:

adaptor - the adaptor

Returns:

the pom file generator