Class LibraryGenerator

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.core.AbstractGenerator

org.jdrupes.builder.java.JarGenerator

org.jdrupes.builder.java.LibraryGenerator

All Implemented Interfaces:

Generator, ResourceProvider, ResourceRetriever

Direct Known Subclasses:

UberJarGenerator

public class LibraryGenerator
extends JarGenerator
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 JarFile. This type of resource is also returned if a more general ResourceType such as ClasspathElement is requested.

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

Instead of explicitly adding resources, this generator also supports resource retrieval from added providers. The providers will be used to retrieve resources of type ClassTree and JavaResourceTree in addition to the explicitly added resources.

The standard pattern for creating a library is simply:

generator(LibraryGenerator::new).from(providers(Supply));

Field Summary

Fields inherited from class AbstractProvider

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	collectContents(Map<Path, Resources<IOResource>> contents)	Add the contents from the added streams as preliminary jar entries.
protected void	collectFromProviders(Map<Path, Resources<IOResource>> contents)	Collects the contents from the providers.
protected <T extends Resource> Stream<T>	doProvide(ResourceRequest<T> requested)	Invoked by AbstractProvider.provide(ResourceRequest) after checking if the invocation is allowed.
LibraryGenerator	from(Stream<ResourceProvider> providers)	Additionally uses the given providers for obtaining contents for the jar.
LibraryGenerator	from(ResourceProvider... providers)	Additionally uses the given providers for obtaining contents for the jar.
String	mainClass()	Returns the main class.
LibraryGenerator	mainClass(String mainClass)	Sets the main class.
protected StreamCollector<ResourceProvider>	providers()	return the cached providers.

Methods inherited from class JarGenerator

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

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

Constructor Details

LibraryGenerator

public LibraryGenerator(Project project)

Instantiates a new library generator.

Parameters:

project - the project

Method Details

mainClass

public String mainClass()

Returns the main class.

Returns:

the main class

mainClass

public LibraryGenerator mainClass(String mainClass)

Sets the main class.

Parameters:

mainClass - the new main class

Returns:

the jar generator for method chaining

from

public LibraryGenerator from(ResourceProvider... providers)

Additionally uses the given providers for obtaining contents for the jar.

Specified by:

from in interface ResourceRetriever

Parameters:

providers - the providers

Returns:

the jar generator

from

public LibraryGenerator from(Stream<ResourceProvider> providers)

Additionally uses the given providers for obtaining contents for the jar.

Specified by:

from in interface ResourceRetriever

Parameters:

providers - the providers

Returns:

the jar generator

providers

protected StreamCollector<ResourceProvider> providers()

return the cached providers.

Returns:

the cached stream

collectContents

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

Description copied from class: JarGenerator

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.collectEntries(...).

Overrides:

collectContents in class JarGenerator

Parameters:

contents - the preliminary contents

collectFromProviders

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

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

Parameters:

contents - the contents

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.

Overrides:

doProvide in class JarGenerator

Type Parameters:

T - the generic type

Parameters:

requested - the requested

Returns:

the stream