Class LibraryBuilder

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.core.AbstractGenerator

org.jdrupes.builder.java.JarBuilder

org.jdrupes.builder.java.LibraryBuilder

All Implemented Interfaces:

Generator, Renamable, ResourceProvider, ResourceRetriever

Direct Known Subclasses:

UberJarBuilder

public class LibraryBuilder
extends JarBuilder
implements ResourceRetriever

A Generator for Java libraries packaged as jars. A library jar is expected to contain class files and supporting resources together with additional information in META-INF/.

The generator provides two types of resources.

1. A LibraryJarFile. This type of resource is also returned if a more general ResourceType such as CodeContribution is requested.

2. An AppJarFile. When requesting this special jar type, the generator checks if a main class is specified.

In addition to explicitly adding resources, this generator supports resource retrieval from added providers. The resources of type ClassTree and JavaResourceTree that the providers added with ResourceRetriever.addFrom(ResourceProvider...) supply are included in the library in addition to the explicitly added resources.

The enables the simple standard pattern for creating a library:

generator(LibraryBuilder::new).addFrom(this);

JPMS support

When the compiled classes contain a module-info.class, the JAR is a named module. If no module-info.class is present but moduleName is set (or auto-detected from the project name), an Automatic-Module-Name manifest attribute is added so the JAR is treated as an automatic module on the module-path.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
LibraryBuilder	addFrom(Stream<ResourceProvider> providers)	Adds the given providers as sources for resources.
LibraryBuilder	addFrom(ResourceProvider... providers)	Adds the given provider(s) as source for resources.
protected void	collectContents(Map<Path, Resources<InputResource>> contents)	Add the contents from the added streams as preliminary jar entries.
protected void	collectFromProviders(Map<Path, Resources<InputResource>> contents)	Collects the contents from the providers.
protected StreamCollector<ResourceProvider>	contentProviders()	return the cached providers.
protected <T extends Resource> Collection<T>	doProvide(ResourceRequest<T> request)	Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.
String	mainClass()	Returns the main class.
LibraryBuilder	mainClass(String mainClass)	Sets the main class.
String	moduleName()	Returns the module name for the Automatic-Module-Name manifest attribute.
LibraryBuilder	moduleName(String moduleName)	Sets the module name used for the Automatic-Module-Name manifest attribute.
LibraryBuilder	name(String name)	Set the new name.

Methods inherited from class JarBuilder

add, add, add, add, addAttributeValues, addEntries, addManifestAttributes, addTrees, attributes, buildJar, collect, destination, destination, destination, jarName, jarName, jarName, resolveDuplicates

Methods inherited from class AbstractGenerator

cleanup, 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, resources

Constructor Details

LibraryBuilder

public LibraryBuilder(Project project)

Instantiates a new library generator.

Parameters:

project - the project

Method Details

name

public LibraryBuilder name(String name)

Description copied from interface: Renamable

Set the new name.

Specified by:

name in interface Renamable

Overrides:

name in class JarBuilder

Parameters:

name - the name

Returns:

the renamable

mainClass

public String mainClass()

Returns the main class.

Returns:

the main class

mainClass

public LibraryBuilder mainClass(String mainClass)

Sets the main class.

Parameters:

mainClass - the new main class

Returns:

the library builder for method chaining

moduleName

public String moduleName()

Returns the module name for the Automatic-Module-Name manifest attribute. If not set, the project name is sanitized for JPMS requirements.

Returns:

the module name

moduleName

public LibraryBuilder moduleName(String moduleName)

Sets the module name used for the Automatic-Module-Name manifest attribute. This allows the JAR to be used as an automatic module on the module-path.

Parameters:

moduleName - the module name

Returns:

this builder

addFrom

public LibraryBuilder addFrom(ResourceProvider... providers)

Description copied from interface: ResourceRetriever

Adds the given provider(s) as source for resources.

Specified by:

addFrom in interface ResourceRetriever

Parameters:

providers - the provider to add

Returns:

the resource retriever

addFrom

public LibraryBuilder addFrom(Stream<ResourceProvider> providers)

Description copied from interface: ResourceRetriever

Adds the given providers as sources for resources. The stream must not be consumed before the generators' provide method is invoked.

Specified by:

addFrom in interface ResourceRetriever

Parameters:

providers - the providers to retrieve resources from

Returns:

the resource retriever

contentProviders

protected StreamCollector<ResourceProvider> contentProviders()

return the cached providers.

Returns:

the content providers

collectContents

protected void collectContents(Map<Path, Resources<InputResource>> contents)

Description copied from class: JarBuilder

Add the contents from the added streams as preliminary jar entries. Must be overridden by derived classes that define additional ways to provide contents. The overriding method must invoke super.collectContents(...).

Overrides:

collectContents in class JarBuilder

Parameters:

contents - the preliminary contents

collectFromProviders

protected void collectFromProviders(Map<Path, Resources<InputResource>> contents)

Collects the contents from the providers. This implementation requests ClassTrees and JavaResourceTrees.

Parameters:

contents - the contents

doProvide

protected <T extends Resource> Collection<T> doProvide(ResourceRequest<T> request)

Description copied from class: AbstractProvider

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

Overrides:

doProvide in class JarBuilder

Type Parameters:

T - the generic type

Parameters:

request - the request for resources

Returns:

the stream