Class PomFileGenerator

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.core.AbstractGenerator

org.jdrupes.builder.mvnrepo.PomFileGenerator

All Implemented Interfaces:

Generator, ResourceProvider

public class PomFileGenerator
extends AbstractGenerator

A Generator (mainly) for POM files. In response to requests for PomFile it generates a maven Model with basic information. The group is set to the value of the property MvnProperties.GroupId if it is defined. The artifact id is set to the property MvnProperties.ArtifactId or the name of the project, if MvnProperties.ArtifactId is not defined. The version is set to the value of the property Project.Properties.Version.

This basic model is passed to adaptPom(Consumer) where it can be adapted. as the project requires. Finally, the model is written to the POM file.

In addition to the PomFile requests, this generator also handles requests for MvnRepoDependency. This reflects that a project that has a POM file is obviously intended to be released as a maven artifact. Other projects in a multi-project build will therefore eventually 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.

Fields inherited from class AbstractProvider

log

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 AbstractProvider.provide(ResourceRequest) after checking if the invocation is allowed.
PomFileGenerator	runtimeLibrary()	POMs do not contain any information whether the library is intended to be used at runtime or at compile time.

Methods inherited from class AbstractGenerator

cleanup, name, name, newResource, project, toString

Methods inherited from class AbstractProvider

provide

Methods inherited from class Object

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

Methods inherited from interface ResourceProvider

provide

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

runtimeLibrary

public PomFileGenerator runtimeLibrary()

POMs do not contain any information whether the library is intended to be used at runtime or at compile time. This information is only needed when this generator responds to requests for MvnRepoDependency.

Returns:

the pom file generator

doProvide

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

Description copied from class: AbstractProvider

Invoked by AbstractProvider.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